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

Fix handling of script arguments in tracer #15518

Merged
merged 2 commits into from
Nov 4, 2022
Merged

Fix handling of script arguments in tracer #15518

merged 2 commits into from
Nov 4, 2022

Conversation

lantiga
Copy link
Collaborator

@lantiga lantiga commented Nov 3, 2022

What does this PR do?

TracerPythonScript assumes that additional params start with --

For instance, passing params={"a": 1} is turned into script_args == "--a=1". This breaks when this assumption is not true, for instance when parsing arguments using hydra.cc

This PR removes this assumption. The (unavoidable) downside is a params argument needs to be provided as {"--a": 1} if it is meant to be turned into --a=1, otherwise it is converted to a=1.

Note that this is needed for Lightning-Universe/Training-Studio_app#216 to work

Fixes #<issue_number>

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

cc @Borda @justusschock

@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Nov 3, 2022
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

It is probably best if we make self.script_args and params both lists in the future. It seems unintuitive to be passing two different data types. The user would do the conversion outside in reverse to what we do internally.

@mergify mergify bot added the ready PRs ready to be merged label Nov 4, 2022
@awaelchli
Copy link
Contributor

This looks like undocumented behavior and we can probably change it, but it may break some apps.

@awaelchli awaelchli added the breaking change Includes a breaking change label Nov 4, 2022
@lantiga lantiga added this to the v1.8.x milestone Nov 4, 2022
@lantiga lantiga merged commit 5cf5036 into master Nov 4, 2022
@lantiga lantiga deleted the tracer_fix branch November 4, 2022 15:03
Borda pushed a commit that referenced this pull request Nov 5, 2022
* Don't assume script args start with double dash

* add changelog

Co-authored-by: Luca Antiga <[email protected]>
Co-authored-by: awaelchli <[email protected]>
(cherry picked from commit 5cf5036)
lexierule pushed a commit that referenced this pull request Nov 10, 2022
* Don't assume script args start with double dash

* add changelog

Co-authored-by: Luca Antiga <[email protected]>
Co-authored-by: awaelchli <[email protected]>
(cherry picked from commit 5cf5036)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app (removed) Generic label for Lightning App package breaking change Includes a breaking change ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants