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

Typing improvements #444

Merged
merged 18 commits into from
Feb 2, 2025
Merged

Conversation

jhamon
Copy link
Collaborator

@jhamon jhamon commented Feb 2, 2025

Problem

The more type hints we have in our package, the better people will be able to understand how to use it.

Solution

Much of the untyped code in the package is derived from old generated code that we have extracted. So there's a fair amount of refactoring in this difif to try to break out some smaller classes and functions with seams that you can start to analyze and type; when everything is just big mutable state blobs it is quite hard to reason about.

Along the way I uncovered that bulk import features were in a broken state because some of those operation ids was modified since the last release and these functions are not well-covered with automated tests. This sort of thing really highlights why we need better type coverage in the package.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • None of the above: Refactoring to improve type safety

@jhamon jhamon marked this pull request as ready for review February 2, 2025 19:33
@jhamon jhamon merged commit c95c4b0 into release-candidate/2025-01 Feb 2, 2025
75 checks passed
@jhamon jhamon deleted the jhamon/typing-improvements branch February 2, 2025 19:33
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.

1 participant