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

Proposal: Add typing #434

Open
soulee-dev opened this issue Aug 23, 2023 · 1 comment
Open

Proposal: Add typing #434

soulee-dev opened this issue Aug 23, 2023 · 1 comment

Comments

@soulee-dev
Copy link
Contributor

Description

Adding typing support to the python-mysql-replication library could significantly improve code quality and maintainability. Type annotations help developers understand code more quickly, prevent certain errors, and allow modern IDEs to provide better tooling and auto-completion.

Scope

I am suggesting to add typing gradually throughout the codebase, starting with the core modules and gradually extending to other areas. This approach will allow us to ensure that the changes are solid and working as expected.

Proposal

Here's a rough outline of the proposed changes:

  1. Add type hints to core classes and functions in the project.
  2. Utilize mypy or other static type checking tools to enforce type consistency.
  3. Gradually apply typing to other parts of the codebase.
  4. Update documentation to reflect the newly added types.

And if you agree with this proposal, I'll write a PR quickly to start implementing the changes. Your support and collaboration in this enhancement would be greatly appreciated.

@julien-duponchelle
Copy link
Owner

Good idea !

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