##// END OF EJS Templates
typing: add type annotations to the dirstate classes...
typing: add type annotations to the dirstate classes The basic procedure here was to use `merge-pyi` to merge the `git/dirstate.pyi` file in (after renaming the interface class to match), cleaning up the import statement mess, and then repeating the procedure for `mercurial/dirstate.pyi`. Surprisingly, git's dirstate had more hints inferred in its *.pyi file. After that, it was a manual examination of each method in the interface, and how they were implemented in the core and git classes to verify what was inferred by pytype, and fill in the missing gaps. Since this involved jumping around between three different files, I applied the same type info to all three at the same time. Complex types I rolled up into type aliases in the interface module, and used that as needed. That way if it changes, there's one place to edit. There are some hints still missing, and some documentation that doesn't match the signatures. They should all be marked with TODOs. There are also a bunch of methods on the core class that aren't on the Protocol class that seem like maybe they should be (like `set_tracked()`). There are even more methods missing from the git class. But that's a project for another time.

File last commit:

r52757:1c5810ce default
r52822:93d872a0 default
Show More
typelib.py
50 lines | 1.3 KiB | text/x-python | PythonLexer
Matt Harbison
pytype: stop excluding mercurial/ui.py...
r50688 # typelib.py - type hint aliases and support
#
# Copyright 2022 Matt Harbison <matt_harbison@yahoo.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
Matt Harbison
typing: add `from __future__ import annotations` to remaining source files...
r52757 from __future__ import annotations
Matt Harbison
pytype: stop excluding mercurial/ui.py...
r50688 import typing
Matt Harbison
typing: add trivial type hints to `mercurial.scmutil`...
r52625 from typing import (
Callable,
)
Matt Harbison
pytype: stop excluding mercurial/ui.py...
r50688 # Note: this is slightly different from pycompat.TYPE_CHECKING, as using
# pycompat causes the BinaryIO_Proxy type to be resolved to ``object`` when
# used as the base class during a pytype run.
TYPE_CHECKING = typing.TYPE_CHECKING
# The BinaryIO class provides empty methods, which at runtime means that
# ``__getattr__`` on the proxy classes won't get called for the methods that
# should delegate to the internal object. So to avoid runtime changes because
# of the required typing inheritance, just use BinaryIO when typechecking, and
# ``object`` otherwise.
if TYPE_CHECKING:
from typing import (
BinaryIO,
Matt Harbison
typing: add type hints to `mercurial.dirstatemap`...
r52609 Union,
)
from . import (
node,
posix,
windows,
Matt Harbison
pytype: stop excluding mercurial/ui.py...
r50688 )
BinaryIO_Proxy = BinaryIO
Matt Harbison
typing: add type hints to `mercurial.dirstatemap`...
r52609 CacheStat = Union[posix.cachestat, windows.cachestat]
NodeConstants = node.sha1nodeconstants
Matt Harbison
pytype: stop excluding mercurial/ui.py...
r50688 else:
Matt Harbison
typing: add type hints to `mercurial.dirstatemap`...
r52609 from typing import Any
Matt Harbison
pytype: stop excluding mercurial/ui.py...
r50688 BinaryIO_Proxy = object
Matt Harbison
typing: add type hints to `mercurial.dirstatemap`...
r52609 CacheStat = Any
NodeConstants = Any
Matt Harbison
typing: add trivial type hints to `mercurial.scmutil`...
r52625
# scmutil.getuipathfn() related callback.
UiPathFn = Callable[[bytes], bytes]