Skip to content

converted full library to new arg doc format. #5266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Snooz82 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

converted full library to new arg doc format. #5266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e727cf3
converted full library to new arg doc format.
Snooz82 Sep 22, 2026
c6b3529
done reviewing
Snooz82 Sep 23, 2026
032c16d
fixed test
Snooz82 Sep 23, 2026
1e6c8af
fixed linting issues
Snooz82 Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 84 additions & 21 deletions Browser/browser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,27 +466,90 @@ def __init__( # noqa: PLR0915
timeout: timedelta = timedelta(seconds=10),
tracing_group_mode: TracingGroupMode = TracingGroupMode.Full,
):
"""Browser library can be taken into use with optional arguments:

| =Argument= | =Description= |
| ``auto_closing_level`` | Configure context and page automatic closing. Default is ``TEST``, for more details, see `AutoClosingLevel` |
| ``auto_delete_passed_tracing`` | If ``auto_closing_level`` is set to ``SUITE`` or ``TEST`` and ``tracing`` of `New Context` active, traces of passed tests or suites, depending on the context scope, not be saved. Also temp files will all be deleted after the whole execution ends. |
| ``enable_playwright_debug`` | Enable low level debug information from the playwright to playwright-log.txt file. For more details, see `PlaywrightLogTypes`. |
| ``enable_presenter_mode`` | Automatic highlights the interacted components, slowMo and a small pause at the end. Can be enabled by giving True or can be customized by giving a dictionary: `{"duration": "2 seconds", "width": "2px", "style": "dotted", "color": "blue"}` Where `duration` is time format in Robot Framework format, defaults to 2 seconds. `width` is width of the marker in pixels, defaults the `2px`. `style` is the style of border, defaults to `dotted`. `color` is the color of the marker, defaults to `blue`. By default, the call banner keyword is also enabled unless explicitly disabled. |
| ``external_browser_executable`` | Dict mapping name of browser to path of executable of a browser. Will make opening new browsers of the given type use the set executablePath. Currently only configuring of `chromium` to a separate executable (chrome, chromium and Edge executables all work with recent versions) works. |
| ``highlight_on_failure`` | If set to ``True``, will highlight the element in the screenshot when a keyword fails, by highlighting the selector used in the failed keyword. If set to ``False``, will not highlight the element. |
| ``jsextension`` | Path to JavaScript modules exposed as extra keywords. The modules must be in CommonJS format; exported functions become keywords and an ``fn.rfdoc`` string becomes a keyword's documentation. The argument names ``page``, ``context``, ``browser``, ``logger`` and ``playwright`` are filled in by the library rather than taken from the keyword call. Can be a single path, a comma-separated list of paths or a real list of strings. See https://robotframework-browser.org/docs/extending/javascript-extensions |
| ``language`` | Defines language which is used to translate keyword names and documentation. |
| ``playwright_process_host`` | Hostname / Host address which should be used when spawning the Playwright process. Defaults to 127.0.0.1. |
| ``playwright_process_port`` | Experimental reusing of playwright process. ``playwright_process_port`` is preferred over environment variable ``ROBOT_FRAMEWORK_BROWSER_NODE_PORT``. See `Experimental: Re-using same node process` for more details. |
| ``plugins`` | Allows extending the Browser library with external Python classes, which can add keywords and modify some internal behaviour without forking the library. Can be a single class/module, a comma-separated list or a real list of strings. See https://robotframework-browser.org/docs/extending/python-plugins |
| ``retry_assertions_for`` | Timeout for retrying assertions on keywords before failing the keywords. This timeout starts counting from the first failure. Global ``timeout`` will still be in effect. This allows stopping execution faster to assertion failure when element is found fast. |
| ``run_on_failure`` | Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword. If the keyword has arguments those must be separated with two spaces for example ``My keyword \\ arg1 \\ arg2``. If no extra action should be done after a failure, set it to ``None`` or any other robot falsy value. Run on failure is not applied when library methods are executed directly from Python. |
| ``selector_prefix`` | Prefix for all selectors. This is useful when you need to use add an iframe selector before each selector. |
| ``show_keyword_call_banner`` | If set to ``True``, will show a banner with the keyword name and arguments before the keyword is executed at the bottom of the page. If set to ``False``, will not show the banner. If set to None, which is the default, will show the banner only if the presenter mode is enabled. `Get Page Source` and `Take Screenshot` will not show the banner, because that could negatively affect your test cases/tasks. This feature may be super helpful when you are debugging your tests and using tracing from `New Context` or `Video recording` features. |
| ``strict`` | If keyword selector points multiple elements and keywords should interact with one element, keyword will fail if ``strict`` mode is true. Strict mode can be changed individually in keywords or by ``Set Strict Mode`` keyword. |
| ``timeout`` | Timeout for keywords that operate on elements. The keywords will wait for this time for the element to appear into the page. Defaults to "10s" => 10 seconds. |
| ``tracing_group_mode`` | Defines how Robot Framework keyword calls are logged in Playwright trace log. Default is `Full`. For more details, see `TracingGroupMode`. |
"""Browser library can be taken into use with optional arguments.

*Arguments:*
- ``_``: Positional arguments are ignored. All arguments must be passed as named arguments.
- ``auto_closing_level``: Configure context and page automatic closing.
Default is ``TEST``, for more details, see `AutoClosingLevel`
- ``auto_delete_passed_tracing``: If ``auto_closing_level`` is set to
``SUITE`` or ``TEST`` and ``tracing`` of `New Context` active, traces of
passed tests or suites, depending on the context scope, not be saved.
Also temp files will all be deleted after the whole execution ends.
- ``enable_playwright_debug``: Enable low level debug information from the
playwright to playwright-log.txt file. For more details, see
`PlaywrightLogTypes`.
- ``enable_presenter_mode``: Automatic highlights the interacted components,
slowMo and a small pause at the end. Can be enabled by giving True or
can be customized by giving a dictionary: ``{"duration": "2 seconds",
"width": "2px", "style": "dotted", "color": "blue"}`` Where `duration` is
time format in Robot Framework format, defaults to 2 seconds. `width` is
width of the marker in pixels, defaults the ``2px``. ``style`` is the style
of border, defaults to ``dotted``. ``color`` is the color of the marker,
defaults to ``blue``. By default, the call banner keyword is also enabled
unless explicitly disabled.
- ``external_browser_executable``: Dict mapping name of browser to path of
executable of a browser. Will make opening new browsers of the given
type use the set executablePath. Currently only configuring of
``chromium`` to a separate executable (chrome, chromium and Edge
executables all work with recent versions) works.
- ``highlight_on_failure``: If set to ``True``, will highlight the element in
the screenshot when a keyword fails, by highlighting the selector used
in the failed keyword. If set to ``False``, will not highlight the
element.
- ``jsextension``: Path to JavaScript modules exposed as extra keywords. The
modules must be in CommonJS format; exported functions become keywords
and an ``fn.rfdoc`` string becomes a keyword's documentation. The
argument names ``page``, ``context``, ``browser``, ``logger`` and
``playwright`` are filled in by the library rather than taken from the
keyword call. Can be a single path, a comma-separated list of paths or a
real list of strings. See
https://robotframework-browser.org/docs/extending/javascript-extensions
- ``language``: Defines language which is used to translate keyword names and
documentation.
- ``playwright_process_host``: Hostname / Host address which should be used
when spawning the Playwright process. Defaults to 127.0.0.1.
- ``playwright_process_port``: Experimental reusing of playwright process.
``playwright_process_port`` is preferred over environment variable
``ROBOT_FRAMEWORK_BROWSER_NODE_PORT``. See `Experimental: Re-using same
node process` for more details.
- ``plugins``: Allows extending the Browser library with external Python
classes, which can add keywords and modify some internal behaviour
without forking the library. Can be a single class/module, a
comma-separated list or a real list of strings. See
https://robotframework-browser.org/docs/extending/python-plugins
- ``retry_assertions_for``: Timeout for retrying assertions on keywords before
failing the keywords. This timeout starts counting from the first
failure. Global ``timeout`` will still be in effect. This allows
stopping execution faster to assertion failure when element is found
fast.
- ``run_on_failure``: Sets the keyword to execute in case of a failing Browser
keyword. It can be the name of any keyword. If the keyword has arguments
those must be separated with two spaces for example ``My keyword \\ arg1
\\ arg2``. If no extra action should be done after a failure, set it to
``None`` or any other robot falsy value. Run on failure is not applied
when library methods are executed directly from Python.
- ``selector_prefix``: Prefix for all selectors. This is useful when you need
to use add an iframe selector before each selector.
- ``show_keyword_call_banner``: If set to ``True``, will show a banner with
the keyword name and arguments before the keyword is executed at the
bottom of the page. If set to ``False``, will not show the banner. If
set to None, which is the default, will show the banner only if the
presenter mode is enabled. `Get Page Source` and `Take Screenshot` will
not show the banner, because that could negatively affect your test
cases/tasks. This feature may be super helpful when you are debugging
your tests and using tracing from `New Context` or `Video recording`
features.
- ``strict``: If keyword selector points multiple elements and keywords should
interact with one element, keyword will fail if ``strict`` mode is true.
Strict mode can be changed individually in keywords or by ``Set Strict
Mode`` keyword.
- ``timeout``: Timeout for keywords that operate on elements. The keywords
will wait for this time for the element to appear into the page.
Defaults to "10s" => 10 seconds.
- ``tracing_group_mode``: Defines how Robot Framework keyword calls are logged
in Playwright trace log. Default is ``Full``.
Comment thread
Snooz82 marked this conversation as resolved.

"""
if _:
raise ValueError("Browser library does not accept positional arguments.")
Expand Down
13 changes: 10 additions & 3 deletions Browser/keywords/assertion_formatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,16 @@ def set_assertion_formatters(
) -> dict[str, list[str]]:
"""Set keywords formatters for assertions.

| =Arguments= | =Description= |
| ``formatters`` | Dictionary of keywords and formatters, where the key is the name of the keyword where the formatters are applied. The dictionary value is a list of formatters which are applied. Formatters for a defined keyword are always overwritten. An empty list will clear all formatters for the keyword. If ``formatters`` is an empty dictionary, then all formatters are cleared from all keywords, in the Global scope, regardless of the ``scope`` argument. |
| ``scope`` | Defines the lifetime of the formatter, possible values are Global, Suite and Test. |
*Arguments:*
- ``formatters``: Dictionary of keywords and formatters, where the key is the
name of the keyword where the formatters are applied. The dictionary
value is a list of formatters which are applied. Formatters for a
defined keyword are always overwritten. An empty list will clear all
formatters for the keyword. If ``formatters`` is an empty dictionary,
then all formatters are cleared from all keywords, in the Global scope,
regardless of the ``scope`` argument.
- ``scope``: Defines the lifetime of the formatter, possible values are
Global, Suite and Test.

Returns the formatters which were in use before this keyword was called.
Formatters defined as lambda functions are not included in the returned value.
Expand Down
Loading
Loading