robotframework / robotframework/robotframework

public API to retrieve robot/rebot options (_cli_opts)

Open
#4,332 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
11.9k
Forks
2.6k
Avg merge
1d 18h
Merged PRs (30d)
10

Description

I have now come by at least two use cases for a client python application to know about valid robot/rebot options.

I can retrieve the options via an internal call like

from robot.conf import RobotSettings
robot_options = [v[0] for v in RobotSettings()._cli_opts.values()]

but I would rather like this to be a public API.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading robot/conf and the RobotSettings class, especially its _cli_opts values. Define a public way for client Python applications to retrieve valid robot/rebot options while preserving the requested option information. Done means callers no longer need the internal _cli_opts access path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.