pmorissette / ffn

ffn - a financial function library for Python
pmorissette.github.io/ffn
MIT License
1.87k stars 282 forks source link

Add typing for the `utils` file #227

Closed GuyPago closed 2 months ago

GuyPago commented 2 months ago

I personally use type checking with python with the help of type hinting for autocompletions. It is very common for high used modules to integrate type hinting for good integration and workflow with other modules and files.

Its absence is fairly noticeable by me. Example from my code is shown below. Assuming that the utils.get method returns a dataframe rather than an unknown object, might greatly increase the user's experience via autocompletion. image

codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 57.39%. Comparing base (3ef2b1b) to head (6cf0452). Report is 4 commits behind head on master.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #227 +/- ## ========================================== + Coverage 57.32% 57.39% +0.07% ========================================== Files 4 4 Lines 1174 1176 +2 Branches 254 254 ========================================== + Hits 673 675 +2 Misses 435 435 Partials 66 66 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.