Add warning for removal of default in annotated Parameter args #1102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elliotgunton
added
semver:minor
elliotgunton
force-pushed
the
812-annotated-defaults
branch
from
03ff013 to
b57d32a
Compare
sambhav
added a commit
that referenced
this pull request
Jun 17, 2024
The `type:informational` label is not one of the set of "minimal required labels", resulting in failing CI in #1102 Signed-off-by: Elliot Gunton <elliotgunton@gmail.com> Co-authored-by: Sambhav Kothari <skothari44@bloomberg.net>
elliotgunton
force-pushed
the
812-annotated-defaults
branch
from
b57d32a to
1543036
Compare
|
@samj1912 / @flaviuvadan any preference on this change having a notice or just make the change directly? It's an experimental feature after all 👀 |
|
I would prefer to give a bit more notice. Let's also provide a couple of minor versions of bandwidth. The way I would prefer to go about removing things is as follows -
|
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
We will follow a slower deprecation process to give more room to migrate: * Deprecation message (likely in 5.16) * Raise error unless override flag turned on (likely in 5.17) * Raise error, remove ability to set Parameter's default, users must use Python (likely in 5.18) Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
elliotgunton
force-pushed
the
812-annotated-defaults
branch
from
5e4bb68 to
5908486
Compare
elliotgunton
commented
Jun 18, 2024
| if new_object.default is not None: | ||
| raise ValueError( | ||
| "default cannot be set via both the function parameter default and the Parameter's default" | ||
| ) | ||
| new_object.default = str(func_param.default) | ||
| new_object.default = serialize(func_param.default) |
There was a problem hiding this comment.
This change is technically a bug fix
sambhav
approved these changes
Jun 18, 2024
4 tasks
elliotgunton
added a commit
that referenced
this pull request
Sep 18, 2024
**Pull Request Checklist** - [x] Fixes #812 - [x] Tests added - [x] Documentation/examples added - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Currently, using the `default` kwarg for a `Parameter` in an input Annotation or Hera's Pydantic `Input` class logs a warning message, added in #1102. This PR makes the code path raise an error, which can be supressed using the `suppress_parameter_default_error` experimental feature flag for 1 minor version until it is removed. --------- Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
Description of PR
To complete #812 it would be preferable to give a version's warning of the backwards incompatible change, although I'm happy to make the change in one go.
This PR also fixes a serialization problem when setting the default via a Python function arg.