Skip to content

Typing improvements #114

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

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Typing improvements #114

merged 2 commits into from
Jan 15, 2025

Conversation

jlamypoirier
Copy link
Collaborator

✨ Description

  • Add tons of type hints, mostly on return values. Most methods not have fully explicit type hints.
  • Use more advanced typing methods when possible, including generics and typing.Self
  • Add the Configurable generic which helps objects associated with a config.

Worked on all modules except `data, which is being worked on in #104

🔍 Type of change

Select all that apply:

  • 🐛 Bug fix (non-breaking change that addresses a specific issue)
  • 🚀 New feature (non-breaking change that adds functionality)
  • ⚠️ Breaking change (a change that could affect existing functionality)
  • 📈 Performance improvement/optimization (improves speed, memory usage, or efficiency)
  • 🛠️ Code refactor (non-functional changes that improve code readability, structure, etc.)
  • 📦 Dependency bump (updates dependencies, including Dockerfile or package changes)
  • 📝 Documentation change (updates documentation, including new content or typo fixes)
  • 🔧 Infrastructure/Build change (affects build process, CI/CD, or dependencies)

Copy link
Collaborator

@tscholak tscholak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scanned through it, looks very good!
the new Generics syntax makes this finally easy on the eye.

@jlamypoirier jlamypoirier merged commit 4496a40 into main Jan 15, 2025
2 checks passed
@jlamypoirier jlamypoirier deleted the typing_improvements branch January 15, 2025 19:16
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.

2 participants