-
-
Notifications
You must be signed in to change notification settings - Fork 74
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
Annotate depends and accept_arguments decorators #962
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,46 @@ | ||
from __future__ import annotations | ||
|
||
import inspect | ||
|
||
from collections import defaultdict | ||
from functools import wraps | ||
from typing import TYPE_CHECKING, TypeVar, Callable, Protocol, TypedDict, overload | ||
|
||
from .parameterized import ( | ||
Parameter, Parameterized, ParameterizedMetaclass, transform_reference, | ||
) | ||
from ._utils import accept_arguments, iscoroutinefunction | ||
|
||
if TYPE_CHECKING: | ||
CallableT = TypeVar("CallableT", bound=Callable) | ||
Dependency = Parameter | str | ||
|
||
class DependencyInfo(TypedDict): | ||
dependencies: tuple[Dependency, ...] | ||
kw: dict[str, Dependency] | ||
watch: bool | ||
on_init: bool | ||
|
||
class DependsFunc(Protocol[CallableT]): | ||
_dinfo: DependencyInfo | ||
__call__: CallableT | ||
|
||
@overload | ||
def depends( | ||
*dependencies: str, watch: bool = ..., on_init: bool = ... | ||
) -> Callable[[CallableT], DependsFunc[CallableT]]: | ||
... | ||
|
||
@overload | ||
def depends( | ||
*dependencies: Parameter, watch: bool = ..., on_init: bool = ..., **kw: Parameter | ||
) -> Callable[[CallableT], DependsFunc[CallableT]]: | ||
... | ||
|
||
@accept_arguments | ||
def depends(func, *dependencies, watch=False, on_init=False, **kw): | ||
def depends( | ||
func: CallableT, /, *dependencies: Dependency, watch: bool = False, on_init: bool = False, **kw: Parameter | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Without the
This looks like a Mypy bug; variadic arguments via |
||
) -> Callable[[CallableT], DependsFunc[CallableT]]: | ||
"""Annotates a function or Parameterized method to express its dependencies. | ||
The specified dependencies can be either be Parameter instances or if a | ||
|
@@ -117,6 +147,6 @@ def cb(*events): | |
_dinfo.update({'dependencies': dependencies, | ||
'kw': kw, 'watch': watch, 'on_init': on_init}) | ||
|
||
_depends._dinfo = _dinfo | ||
_depends._dinfo = _dinfo # type: ignore[attr-defined] | ||
|
||
return _depends |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The intention with these overloads is to prevent usage that violates the validation that
depends
applies internally at runtime, for example, this fails:While this works: