feat: add type annotations to all public API#28
Open
algojogacor wants to merge 1 commit into
Open
Conversation
Add comprehensive type annotations to the observer pattern library: - ObserverFunction, ObserverBoundMethod, ObservableFunction - ObservableBoundMethod, ObservableMethodManager_PersistOnInstances - ObservableMethodManager_PersistOnDescriptor, ObservableUnboundMethod - CleanupHandler, observable_function, observable_method All 5 existing tests pass with annotations applied. Closes DanielSank#20
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Add comprehensive type annotations to all public API surfaces of the
observedlibrary. This improves IDE support, enables static type checking (mypy/pyright), and makes the codebase more maintainable.Changes
from typing import Any, Callable, Dict, Optional, Tuple, Unionimport__init__,__call__, and method signatures with proper typesobservable_function,get_observable_method,observable_methodClasses annotated:
ObserverFunction— function + weakref wrapperObserverBoundMethod— bound method + weakref wrapperObservableFunction— observed function with add/discard observerObservableBoundMethod— observed bound methodObservableMethodManager_PersistOnInstances/PersistOnDescriptor— descriptorsObservableUnboundMethod— unbound method wrapperCleanupHandler— weakref cleanup callbackTesting
pytest observed_test.py -v✅python3 -c "import observed"✅Closes #20