Adding type information to functions, methods, and classes

[sudarsan2k5]

Hi,
My name is Sudarsan Mansingh, and I am a BTech student with strong Python skills and experience contributing to open source libraries such as PyMC, PyTensor, and Aesara Library. I am writing to express my strong interest in the project "Add type information to functions, methods, and classes in InVesalius."

I've done some preliminary research on this topic and am thrilled about the potential impact it could have on the InVesalius code base. By adding type information, we can improve the code's readability, maintainability, and reduce the likelihood of errors. Additionally, the Github-CI action for catching type errors using tools like Mypy would make it easier to catch issues early on, before they become more difficult to debug.

Here's my plan: First, I'll get to know the InVesalius code and the Python typing module. Then, I'll make a list of functions, methods, and classes that need type annotations and add them. Once that's done, I'll set up Github-CI to run Mypy and check for any type errors. I'll make sure we follow typing best practices, like using Union types when needed and avoiding "Any" types.

I'll keep in touch with the InVesalius community, ask for feedback, and work together on any challenges.

I think this project will be a great addition to InVesalius and I'm excited to work on it during GSOC 2024. If you have any suggestions or feedback on my plan, please let me know. Also, if there are any specific tools or resources I should focus on, I'd love to hear about them.

Thanks for your time, and I'm looking forward to your response!

[paulojamorim]

Hi @sudarsan2k5

Follow the instructions on this page: https://github.com/invesalius/gsoc/blob/main/gsoc_application.md

Please use this topic for any topic related to GSoC: #709

Good luck!