omni-us / jsonargparse

Implement minimal boilerplate CLIs derived from type hints and parse from command line, config files and environment variables
https://jsonargparse.readthedocs.io
MIT License
302 stars 41 forks source link

Allow providing a function with return type a class in class_path #513

Closed mauvilsa closed 1 month ago

mauvilsa commented 1 month ago

What does this PR do?

Simplifies cases like https://github.com/Lightning-AI/pytorch-lightning/discussions/13613

Before submitting

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (4166d0a) to head (24e593c).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #513 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 21 21 Lines 6150 6172 +22 ========================================= + Hits 6150 6172 +22 ``` | [Flag](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | Coverage Δ | | |---|---|---| | [py3.10](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `87.32% <95.65%> (+0.02%)` | :arrow_up: | | [py3.10_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.63% <95.65%> (-0.02%)` | :arrow_down: | | [py3.10_pydantic1](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `49.22% <21.73%> (-0.12%)` | :arrow_down: | | [py3.10_pydantic2](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `48.99% <21.73%> (-0.12%)` | :arrow_down: | | [py3.10_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.65% <95.65%> (-0.02%)` | :arrow_down: | | [py3.11](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `87.30% <95.65%> (+0.02%)` | :arrow_up: | | [py3.11_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.63% <95.65%> (-0.02%)` | :arrow_down: | | [py3.11_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.65% <95.65%> (-0.02%)` | :arrow_down: | | [py3.12](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `87.45% <95.65%> (+0.02%)` | :arrow_up: | | [py3.12_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.63% <95.65%> (-0.02%)` | :arrow_down: | | [py3.12_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.65% <95.65%> (-0.02%)` | :arrow_down: | | [py3.7](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `87.83% <86.95%> (-0.01%)` | :arrow_down: | | [py3.7_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.21% <86.95%> (-0.05%)` | :arrow_down: | | [py3.7_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.24% <95.65%> (-0.02%)` | :arrow_down: | | [py3.8](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.02% <86.95%> (+0.01%)` | :arrow_up: | | [py3.8_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.38% <86.95%> (-0.04%)` | :arrow_down: | | [py3.8_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.40% <95.65%> (-0.02%)` | :arrow_down: | | [py3.9](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `87.87% <95.65%> (+0.02%)` | :arrow_up: | | [py3.9_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.27% <95.65%> (-0.02%)` | :arrow_down: | | [py3.9_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/513/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.28% <95.65%> (-0.02%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud