Feat/watchpoints #13248
Feat/watchpoints #13248
Conversation
This comment has been minimized.
This comment has been minimized.
|
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
| _Identifier: TypeAlias = str | ||
|
|
||
| class Watch: | ||
| custom_printer: Callable[[Any], None] | None |
There was a problem hiding this comment.
Several callback types this package have Any as argument type(s), which are assigned with user-defined callbacks. I avoided using object here to be compatible with user-defined callbacks, which may annotate the parameters with more precise types.
- Printer callbacks: accepts any object and writes to a stream
- Compare (
cmp) callbacks: Accepts any 2 objects and compare their equality copy: Makes a copy of any objectwhencallbacks: Inspect/trace/watch an objectwhena condition is fulfilled; takes any object and outputs abool.
There was a problem hiding this comment.
That makes sense, but please add a comment to the code explaining this.
|
|
||
| __version__: Final[LiteralString] | ||
|
|
||
| all: Final[list[Literal["watch", "unwatch"]]] |
There was a problem hiding this comment.
I guess this is a typo for __all__, worth reporting as a bug to the runtime package.
| from types import FrameType | ||
|
|
||
| def getline(frame: FrameType) -> str: ... | ||
| def getargnodes(frame: FrameType) -> zip[tuple[ast.expr, str]]: ... |
There was a problem hiding this comment.
| def getargnodes(frame: FrameType) -> zip[tuple[ast.expr, str]]: ... | |
| def getargnodes(frame: FrameType) -> Iterable[tuple[ast.expr, str]]: ... |
It does return a zip object at runtime, but that's a bit too much of an implementation detail for my taste.
| def __init__(self) -> None: ... | ||
| def __call__( | ||
| self, | ||
| *args: object, |
There was a problem hiding this comment.
Seems like these are unused, consider using _typeshed.Unused.
| _Identifier: TypeAlias = str | ||
|
|
||
| class Watch: | ||
| custom_printer: Callable[[Any], None] | None |
There was a problem hiding this comment.
That makes sense, but please add a comment to the code explaining this.
| def __call__( | ||
| self, | ||
| *args: object, | ||
| alias: str = ..., |
There was a problem hiding this comment.
This one and most of the others support None, since the runtime does kwargs.get("alias", None). Add None to the allowed type of these parameters.
| deepcopy: bool = False, | ||
| file: str | SupportsWrite[str] = ..., | ||
| stack_limit: int | None = 5, | ||
| track: Literal["object", "variable"] = ..., |
There was a problem hiding this comment.
| track: Literal["object", "variable"] = ..., | |
| track: list[Literal["object", "variable"]] = ..., |
Or does it also support other kinds of Sequences?
| def unwatch(self, *args: object) -> None: ... | ||
|
|
||
| class _TraceFunc(Protocol): | ||
| def __call__(self, frame: FrameType, event: str, arg: object) -> _TraceFunc: ... |
There was a problem hiding this comment.
Should these parameters be positional-only?
This is a complete set of stubs for the watchpoints package (GitHub: https://github.com/gaogaotiantian/watchpoints).
Even though it seems like activity is low, it still gets ~800 downloads a week, and its lowish numbers are due to it being a debugging tool rather than a dependency library.
Its stated Python support ranges (3.6-3.10) are modest - I've run the tests locally on Python 3.13-dev and they pass without any modifications.
The intended API and types were inferred through the implementation and the README.