Split up script user guide and fix pydantic io example #982
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:patch
elliotgunton
force-pushed
the
runner-refactor
branch
from
3c682b6
to
b0a913e
Compare
elliotgunton
force-pushed
the
runner-docs-update
branch
from
c719199
to
0a33689
Compare
4 tasks
elliotgunton
force-pushed
the
runner-refactor
branch
2 times, most recently
from
c7c610c
to
46e7098
Compare
* Script user guide was too long, split into main features. Fix internal links * Make pydantic io example into a runnable workflow - made it more obvious the scripts would need a custom image Signed-off-by: Elliot Gunton <egunton@bloomberg.net>
Signed-off-by: Elliot Gunton <egunton@bloomberg.net>
elliotgunton
force-pushed
the
runner-docs-update
branch
from
0a33689
to
be703b6
Compare
flaviuvadan
reviewed
Mar 4, 2024
| ```python | ||
| @script() | ||
| def echo_all( | ||
| an_int: Annotated[int, Parameter(description="an_int parameter", default=1, enum=[1, 2, 3])], |
There was a problem hiding this comment.
For future dev - would it be more Python to support setting the default field kwarg style?
Suggested change
| an_int: Annotated[int, Parameter(description="an_int parameter", default=1, enum=[1, 2, 3])], | |
| an_int: Annotated[int, Parameter(description="an_int parameter", enum=[1, 2, 3])] = 1, |
There was a problem hiding this comment.
Good point, will change here but we have #812 to remove the non-kwarg syntax
flaviuvadan
approved these changes
Mar 4, 2024
Signed-off-by: Elliot Gunton <egunton@bloomberg.net>
elliotgunton
added a commit
that referenced
this pull request
Mar 4, 2024
**Pull Request Checklist** - [x] Fixes #962 - [x] Tests added - [ ] Documentation/examples added - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Currently, defaults are required when using Parameters in the RunnerInput. This PR allows defaults to be omitted. ## Changes from #977 - [x] Fixes #962 - [x] Tests added - [ ] Documentation/examples added - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Primarily, this PR refactors the runner code. It also fixes the mapping and loading of kwargs to a RunnerInput object. Currently, the runner code is hard to follow. This PR refactors the functionality in the `runner.py` file into a `_runner` module with util submodules. The PR also makes the complex input mapping logic more testable. ## Changes from #982 * Script user guide was too long, split into main features. Fix internal links * Make pydantic io example into a runnable workflow - made it more obvious the scripts would need a custom image **Pull Request Checklist** - [x] Fixes #961 (fixes example) - [ ] Tests added - [x] Documentation/examples added - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Currently, the pydantic IO example does not work. Combined with fixes in PRs #974 and #977, this doc change shows how to use the Runner IO features. --------- Signed-off-by: Elliot Gunton <egunton@bloomberg.net>
elliotgunton
added a commit
that referenced
this pull request
Mar 4, 2024
Fix doc links broken in #982 Signed-off-by: Elliot Gunton <egunton@bloomberg.net>
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
Currently, the pydantic IO example does not work. Combined with fixes in PRs #974 and #977, this doc change shows how to use the Runner IO features.