✨ Support json and bytes parameter types

[mhkarimi1383]

Hi

Some times there is a need to have results as bytes (that is builtin supported by click.STRING)
and also there is a need of decoding entire value as an json object (useful when some params are too dynamic or getting that option in a prompt). I wanted to also add pydantic support (for both single option as json and all of the options in a single model) there and also use orjson (by checking if that's installed as an optional dependency), If that's Ok.

[mhkarimi1383]

@svlandeg it's ok to ignore coverage on newly created class?

[svlandeg]

No, in general we really need all the code in the main modules to be fully tested 🙏

[mhkarimi1383]

@svlandeg

I have added tests for newly created class

coverage is 100% again :)

[mhkarimi1383]

If changes are Ok so far I can work on Pydantic support, Or move Pydantic support in another PR?

@svlandeg

[svlandeg]

HI @mhkarimi1383!

We haven't yet been able to review this PR in detail. When we do, we'll update here. No need to ping individual maintainers in the meantime 😉

In terms of adding more functionality, it's always best to open separate PRs for distinct functionality. It makes the review process much easier if one PR deals with one "atomic" change.

Do have a look at existing PRs - if I recall correctly there's already a few PRs open with proposals for Pydantic support.

[svlandeg]

Thanks again for this PR @mhkarimi1383! I'm going to start reviewing it in detail and will push some changes directly to your branch as I'm working on this. I'll put this PR in draft while I do so.

[svlandeg]

Related issue: #130

[svlandeg]

I think the status of this PR should now be good enough for me to pass it onwards to Tiangolo for further review 🙏

[mhkarimi1383]

We are calling it dict, but cli arg should be provided as JSON since we are using json to parse input

[svlandeg]

We are calling it dict, but cli arg should be provided as JSON since we are using json to parse input

Yea, I'm a little on the fence as to what to call it best. In the tutorial it's about parameter types and there it is typed as a dict though... Will let Sebastián weigh in on this one.

[mhkarimi1383]

Yeah, but I think in the repr we can call it JSON, So CLi users that they want to use our application should know that the input has to be JSON

[mrfroggg]

8 months after, would be nice to have this merged and released! I would use it!

[github-actions]

📝 Docs preview for commit 55f3024 at: https://411d9558.typertiangolo.pages.dev

Modified Pages

• https://411d9558.typertiangolo.pages.dev/tutorial/parameter-types/dict/ - (before)