Skip to content
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.

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

Document run_args limitation on Python Modules #5340

Merged
merged 1 commit into from
Oct 23, 2023

Conversation

josegomezr
Copy link
Contributor

Arguments sent from Perl to Python can't be used (due to blessed references not properly translated to Python into usable objects).

A note of caution is added to warn against using any argument in the run function and updated examples.

@github-actions
Copy link

Great PR! Please pay attention to the following items before merging:

Files matching docs/*.asciidoc:

  • Consider generating documentation locally to verify it is rendered correctly using tools/generate-htmldoc

This is an automatically generated QA checklist based on modified files.

Copy link
Contributor

@Martchus Martchus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also remove the . at the end of the commit message.

docs/WritingTests.asciidoc Outdated Show resolved Hide resolved
docs/WritingTests.asciidoc Outdated Show resolved Hide resolved
docs/WritingTests.asciidoc Outdated Show resolved Hide resolved
@josegomezr josegomezr force-pushed the docs_add_ctx_on_py_run_args branch 2 times, most recently from c5de908 to efb121b Compare October 23, 2023 09:02
Copy link
Member

@okurz okurz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks fine. Please observe the comment from Martchus about the git commit message subject line

@josegomezr josegomezr changed the title Document run_args limitation on Python Modules. Document run_args limitation on Python Modules Oct 23, 2023
Arguments sent from Perl to Python can't be used (due to blessed
references not properly translated to Python into usable objects)

Python test modules do not support any other argument but `self`.
A note of caution is added to warn against using any argument in
the `run` function and updated examples

This limitation is enforced now in os-autoinst and now documented
in the docs

Co-authored-by: Martchus <[email protected]>
@mergify mergify bot merged commit d08787a into os-autoinst:master Oct 23, 2023
36 checks passed
os-autoinst-bot pushed a commit to os-autoinst-bot/openQA that referenced this pull request Oct 24, 2023
commit d08787a
Merge: 83ab402 3512c2c
Author:     mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
AuthorDate: Mon Oct 23 19:31:03 2023 +0000
Commit:     GitHub <[email protected]>
CommitDate: Mon Oct 23 19:31:03 2023 +0000

    Merge pull request os-autoinst#5340 from josegomezr/docs_add_ctx_on_py_run_args

    Document `run_args` limitation on Python Modules
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants