Enhance nativescript.py type hint

[daehan-koreapool]

Goal

• Enhance nativescript module type hint to improve code predictability and maintainability

poetry run flake8 pycardano
poetry run mypy --install-types --non-interactive pycardano
pycardano/nativescript.py:38: error: Value of type "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]]" is not indexable  [index]
pycardano/nativescript.py:47: error: "type" has no attribute "_TYPE"  [attr-defined]
pycardano/nativescript.py:48: error: Argument 2 for "super" not an instance of argument 1  [misc]
pycardano/nativescript.py:48: error: Value of type "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]]" is not indexable  [index]
pycardano/nativescript.py:55: error: Unsupported operand types for + ("bytes" and "str")  [operator]
pycardano/nativescript.py:55: note: Right operand is of type "Union[str, bytes]"
pycardano/nativescript.py:68: error: "type" has no attribute "json_tag"  [attr-defined]
pycardano/nativescript.py:81: error: Argument 2 for "super" not an instance of argument 1  [misc]
pycardano/nativescript.py:90: error: "type" has no attribute "json_tag"  [attr-defined]
pycardano/nativescript.py:102: error: "type" has no attribute "_TYPE"  [attr-defined]
pycardano/nativescript.py:130: error: Incompatible types in assignment (expression has type "List[Any]", target has type "str")  [assignment]
pycardano/nativescript.py:134: error: Incompatible types in assignment (expression has type "int", target has type "str")  [assignment]
pycardano/nativescript.py:212: error: Incompatible types in assignment (expression has type "None", variable has type "int")  [assignment]
pycardano/nativescript.py:221: error: Incompatible types in assignment (expression has type "None", variable has type "int")  [assignment]
Found 13 errors in 1 file (checked 12 source files)
make: *** [Makefile:65: qa] Error 1

[codecov-commenter]

Codecov Report

Merging #129 (7faa94b) into main (c5ef3bc) will increase coverage by 0.04%.
The diff coverage is 96.29%.

@@            Coverage Diff             @@
##             main     #129      +/-   ##
==========================================
+ Coverage   85.95%   85.99%   +0.04%     
==========================================
  Files          25       25              
  Lines        2698     2707       +9     
  Branches      519      522       +3     
==========================================
+ Hits         2319     2328       +9     
  Misses        285      285              
  Partials       94       94              

Impacted Files	Coverage Δ
pycardano/nativescript.py	98.03% <96.29%> (+0.18%)	⬆️

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

[daehan-koreapool]

Due to the dynamic nature of NativeScript class which refers to parent from_primitive() method and locking the return type as its subclass, mypy seems to have trouble inferring variable types.

Updates

• Ensure only list/tuples are accepted for from_primitive()
• Type ignore statements mypy is having trouble with
• Ensure mypy understands to_cbor("bytes") returns a bytes value
• Improve to_dict() return type declaration
• before and after dataclass attributes is now required fields

[daehan-koreapool]

I was able to avoid all the # type: ignore by breaking up a for-loop with individual super calls depending on the type.

Also, identified that from_dict() can be simplified further reducing code complexity significantly.