Skip to content

airbyte-ci: enable mypy checks on the project #33719

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

Closed
alafanechere opened this issue Dec 21, 2023 · 0 comments
Closed

airbyte-ci: enable mypy checks on the project #33719

alafanechere opened this issue Dec 21, 2023 · 0 comments
Assignees

Comments

@alafanechere
Copy link
Contributor

Objective:

Propose the integration of MyPy for type checking in the Airbyte-CI Python CLI project to improve code quality.

Reasons for adding MyPy:

  • Early Bug Detection: MyPy catches potential type-related errors during development, preventing issues at runtime. We've suffered from multiple regression in the past for this kind of error.

  • Code Readability: Type hints from MyPy serve as documentation, making the codebase more understandable for collaborators.

  • Improved Development Experience: MyPy enhances the development experience with better IDE support and more accurate autocompletion.

  • Maintainability: As the project grows, MyPy enforces a consistent and clear code structure, enhancing maintainability.

Benefits:

  • Enhanced Code Quality: MyPy enforces type correctness, contributing to a more robust and reliable codebase.

  • Reduced Bugs: Early detection of potential bugs through static type checking leads to a more stable application.

  • Improved Collaboration: Clear type hints make the codebase more understandable, facilitating collaboration.

  • Better Maintenance: MyPy aids in maintaining a well-structured codebase, making it easier for developers to work on and extend the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant