Add type annotation to effects API #509
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances type safety and API robustness in the effects module by adding comprehensive type annotations and default values to prevent None returns.
Key Changes
- Added type annotations throughout the effects API including return types for all properties and method parameters
- Replaced
Nonereturns with sensible default values (e.g.,0.0for numeric values,Falsefor booleans) - Renamed internal
valueattribute todescriptorfor clarity while maintaining backward compatibility
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
This commit addresses GitHub Copilot review comments by implementing proper handling of descriptor return values. The key issue was that descriptor.get() returns descriptor objects (like NumericElement) with a .value attribute when keys exist, not raw values. Changes: - Add _get_value() helper function to extract .value attribute from descriptor objects while supporting default values - Update all numeric properties to use _get_value() for proper type conversion - Fix enum properties (.blend_mode, .type, .glow_type, etc.) to safely handle missing keys with appropriate defaults - Add Enum import for using Enum.Normal as default blend mode - Fix trailing whitespace in deprecated value property docstring All 944 tests pass with 96% coverage on effects.py. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
Nonewhereever possible