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

[Housekeeping] Explicitly typing all files! #303

Open
akmazian opened this issue Feb 19, 2024 · 2 comments
Open

[Housekeeping] Explicitly typing all files! #303

akmazian opened this issue Feb 19, 2024 · 2 comments

Comments

@akmazian
Copy link

I am currently working on explicitly typing all the files and here are my rationales:

  • as an end-user, it is sometimes frustrating when I don't know what's type that my functions are gonna return
  • as a developer, it makes modifying existing functions and adding new functions much smoother, which can be beneficial in the long run

challenges & solutions / workaround

  • backward compatibility: adding types will break the program for end-users using python<3.5. This can be fixed by distributing a separate pyensembl version for python>=3.5. Tools for automatic transpilation of type hints can be utilized in this process

Since it is my first time contributing to a biology-related python package, I am not 100% familiar what the conventions are for such modifications so any feedback would be appreciated!

@iskandr
Copy link
Contributor

iskandr commented Feb 28, 2024

I would be happy to take PRs which gradually add types to one (or a small number of related) modules at a time

@akmazian
Copy link
Author

akmazian commented Jun 4, 2024

I ended up going for a less radical approach lol :) Feel free to provide feedback or change anything!

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

No branches or pull requests

2 participants