fix: Fix type checking

[mschoenlaub]

Signed-off-by: Manuel Schönlaub [email protected]

This PR

This PR fixes typing errors in the client code:

1. The Liskov Substitution Principle should also apply to providers. This relates to the signature of the methods to retrieve flags.

2. Incorrect usage of type instead of flagType. Most probably a typo.

3. Ensure that the callables in create_provider_evaluation are annotated in a mypy-friendly way.

4. Fix type annotations for FlagEvaluationDetails

5. Fix type annotations around optional parameters all over the place

Related Issues

Fixes #17

[tcarrio]

Solid improvements to the typing and good catch on the type vs flag_type reference 👌

[codecov-commenter]

Codecov Report

Merging #25 (7102813) into main (04a4323) will increase coverage by 0.08%.
The diff coverage is 78.26%.

@@            Coverage Diff             @@
##             main      #25      +/-   ##
==========================================
+ Coverage   92.83%   92.92%   +0.08%     
==========================================
  Files          18       18              
  Lines         321      325       +4     
==========================================
+ Hits          298      302       +4     
  Misses         23       23              

Flag	Coverage Δ
unittests	92.92% <78.26%> (+0.08%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
open_feature/hooks/hook_support.py	95.00% <ø> (ø)
open_feature/provider/no_op_provider.py	100.00% <ø> (ø)
open_feature/exception/exceptions.py	79.16% <37.50%> (ø)
...n_feature/evaluation_context/evaluation_context.py	90.90% <100.00%> (+0.90%)	⬆️
...feature/flag_evaluation/flag_evaluation_details.py	100.00% <100.00%> (ø)
open_feature/hooks/hook_context.py	100.00% <100.00%> (ø)
open_feature/open_feature_api.py	100.00% <100.00%> (ø)
open_feature/open_feature_client.py	96.29% <100.00%> (+0.04%)	⬆️
open_feature/provider/provider.py	75.00% <100.00%> (+0.92%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[mschoenlaub]

I reworked the whole thing as plenty of conflicts had come up in the meantime.
I also extended the scope of the PR in an effort to avoid revisiting the annotation topic again.

In particular I unified now that name and version for a client are optional (the get_client hat a different opinion of that than the actual client class), made sure there was something in place to avoid arbitrary functions to be added to a mapping from FlagType to the respective callables and made it possible that error message is now optional, but error code is not. That required changing the order of arguments there though.

[toddbaert]

I don't have much Python experience, but all the type hints here look correct to me. Thanks a lot for this contribution. Much appreciated.

[toddbaert]

@mschoenlaub I've invited you to the python maintainers group. Feel free to accept or not. Soon we will be formalizing the responsibility of that role (you can leave it anytime you want, of course) but it will allow you to merge for now if you'd like.

[tcarrio]

Same request as @toddbaert, in regards to making the provider required and defaulting to a no-op provider initially.

[tcarrio]

We could also instead just merge this as typing enhancements and resolve the optional provider issue separately. In the name of progress 🚀