name: Pull request
about: Submit a pull request for this project
assignees: fabiocaccamo

Describe your changes
Add type hints.

Notes:

• Improvements can certainly come after 3.13 is the oldest version of Python supported. For now a lot of things have to return Any.
• The _KPT type used in __init__.py is less than ideal but it covers all bases of what is possible to use for a key, but there are still some functions that extend from Keyattr and those must take _K which defaults to str.
• typing.cast() is used instead of type assertions to avoid the error from Codacy (which has the Bandit rule about assertions). Overhead is likely minimal vs assert calls but the nice thing is they do get removed in optimised mode, so the overhead can be zero in that case. I see no real issue with assertions so if you want to use those instead of cast() I can revise this. I think making a Bandit config file can quiet Codacy about the issue.

I have tried this with my youtube-unofficial project and it works as expected.

The best way to use this is with typing is to add the type on assignment:

bd = benedict({'a': {'b': 1, 'c': 2}})
b: int = bd['a.b]
c: int = bd[('a', 'c')]

In the future the way to solve this is to have a TypeBenedict to specify a schema, and then have a Mypy plugin that would resolve the actual type. This is similar to what the Mypy Django plugin does with database models.

Related issue
Issue #157

Checklist before requesting a review

• I have performed a self-review of my code.
• I have added tests for the proposed changes.
• I have run the tests and there are not errors.