Skip to content

Remove use of jsonargparse internals #12918

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

Merged
merged 3 commits into from
Apr 29, 2022
Merged

Remove use of jsonargparse internals #12918

merged 3 commits into from
Apr 29, 2022

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Apr 28, 2022

What does this PR do?

The import_docstring_parse function is not part of the jsonargparse public API, see https://jsonargparse.readthedocs.io/en/stable/#api-reference. This pull request removes its use to avoid possible failures due to changes in jsonargparse internals. An example of this happening can be seen in #12884 (comment).

I think this change should be included in 1.6.X. Even though import_docstring_parse is internal, I will change it again to be backward compatible so that released versions of LightningCLI do not fail due to this, see jsonargparse/commit/6dc8539.

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

None

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?
  • [n/a] Did you make sure to update the documentation with your changes? (if necessary)
  • [n/a] 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?
  • [n/a] 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 🙃

@carmocca carmocca added this to the 1.6.x milestone Apr 28, 2022
@carmocca carmocca added bug Something isn't working lightningcli pl.cli.LightningCLI labels Apr 28, 2022
@mergify mergify bot added the ready PRs ready to be merged label Apr 28, 2022
@mergify mergify bot requested a review from a team April 28, 2022 13:12
@mergify mergify bot requested a review from a team April 28, 2022 13:22
@otaj otaj enabled auto-merge (squash) April 28, 2022 13:56
@otaj otaj merged commit 00a3321 into Lightning-AI:master Apr 29, 2022
@mauvilsa mauvilsa deleted the cli-remove-import_docstring_parse branch April 29, 2022 12:15
carmocca pushed a commit that referenced this pull request May 2, 2022
carmocca pushed a commit that referenced this pull request May 3, 2022
lexierule pushed a commit that referenced this pull request May 3, 2022
@rohitgr7 rohitgr7 mentioned this pull request Jul 1, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working lightningcli pl.cli.LightningCLI ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants