Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore/consistent type hints #122

Merged
merged 148 commits into from
Aug 15, 2023
Merged

Conversation

fmilthaler
Copy link
Owner

@fmilthaler fmilthaler commented Jul 31, 2023

Using type hints throughout FinQuant and introducing type checks in functions/methods that raise appropriate error messages if an argument is of an unexpected type.
This commit also introduces custom data types, e.g. FLOAT as Union[np.floating, float] and more to simplify type hints. Moreover, type validation is now done with a new module/function type_validation that also simplifies type validations.
Finally, the documentation for all modules in finquant has been updated.
This closes #94 and also closes #118.

…accept series and dfs as input, always returns a series though!

Change needed for Asset
@fmilthaler fmilthaler force-pushed the chore/consistent-type-hints branch 2 times, most recently from 3f20d69 to 968afc2 Compare August 15, 2023 11:01
@fmilthaler fmilthaler marked this pull request as ready for review August 15, 2023 11:21
@fmilthaler
Copy link
Owner Author

fmilthaler commented Aug 15, 2023

@PietropaoloFrisoni This is finally ready to be merged.

Important Note

Please, do not review this thoroughly. I only assigned this PR to you, so that you can have a quick look at some of the changes I point out to you. Please ignore everything else, it is just too much to review. :)

I also left you a message on slack.

@PietropaoloFrisoni
Copy link
Collaborator

Congrats man! This is quite a careful and thorough work. it certainly brings FinQuant to the next level : )

@PietropaoloFrisoni PietropaoloFrisoni merged commit 2ca498c into master Aug 15, 2023
3 checks passed
@PietropaoloFrisoni PietropaoloFrisoni deleted the chore/consistent-type-hints branch August 15, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation Use type hints consistently
2 participants