Improve address type hint

[daehan-koreapool]

Goal:

• Improve address.py module's type hint related code quality

$ make qa
poetry run flake8 pycardano
poetry run mypy --install-types --non-interactive pycardano
pycardano/address.py:154: error: On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior  [str-bytes-safe]
pycardano/address.py:163: error: Argument 1 of "from_primitive" is incompatible with supertype "CBORSerializable"; supertype defines the argument type as "Union[bytes, bytearray, str, int, float, Decimal, bool, None, Tuple[Any, ...], List[Any], IndefiniteList, Dict[Any, Any], defaultdict[Any, Any], OrderedDict[Any, Any], Any, datetime, Pattern[Any], Any, Any, Set[Any], FrozenSet[Any]]"  [override]
pycardano/address.py:163: note: This violates the Liskov substitution principle
pycardano/address.py:163: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides
pycardano/address.py:342: error: Argument 1 of "from_primitive" is incompatible with supertype "CBORSerializable"; supertype defines the argument type as "Union[bytes, bytearray, str, int, float, Decimal, bool, None, Tuple[Any, ...], List[Any], IndefiniteList, Dict[Any, Any], defaultdict[Any, Any], OrderedDict[Any, Any], Any, datetime, Pattern[Any], Any, Any, Set[Any], FrozenSet[Any]]"  [override]
pycardano/address.py:342: note: This violates the Liskov substitution principle
pycardano/address.py:342: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides
pycardano/address.py:393: error: On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior  [str-bytes-safe]
Found 4 errors in 1 file (checked 13 source files)

[daehan-koreapool]

Updates

• disabling str-bytes-safe mypy check since this only affects exception messages formatting bytes value in f-string in pycardano
• from_primitive() now takes a generalized Primitive value and narrows down valid types within the function scope

[codecov-commenter]

Codecov Report

Merging #130 (f936287) into main (5340be1) will decrease coverage by 0.01%.
The diff coverage is 87.50%.

@@            Coverage Diff             @@
##             main     #130      +/-   ##
==========================================
- Coverage   85.99%   85.98%   -0.02%     
==========================================
  Files          25       25              
  Lines        2707     2711       +4     
  Branches      522      524       +2     
==========================================
+ Hits         2328     2331       +3     
  Misses        285      285              
- Partials       94       95       +1     

Impacted Files	Coverage Δ
pycardano/nativescript.py	98.03% <ø> (ø)
pycardano/network.py	100.00% <ø> (ø)
pycardano/address.py	77.60% <85.71%> (-0.06%)	⬇️
pycardano/serialization.py	86.89% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[daehan-koreapool]

I tried introducing limit_primitive_type() decorator class and removed all if not isinstance(value, type) repeated codes.
However, mypy wasn't smart enough to infer Primitive value type has been narrowed down and started raising bunch of Liskov errors again.

I think the cleanest solution is to declare from_primitive() base method to accept Any types of primitive values and just explicitly state allowed value types in overriding methods.
By doing so, both users and mypy understands what the expected input type is more clearly.

Also, I am keeping limit_primitive_type() decorator as internal only and not included in __all__ for now.

[cffls]

limit_primitive_type looks very neat. Thanks for the change!