This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9281

cext: add .pyi files for C extensions
ClosedPublic

Authored by indygreg on Nov 7 2020, 8:23 PM.

Details

Reviewers
Alphare
pulkit
Group Reviewers
hg-reviewers
Commits
rHG8dca9051a859: cext: add .pyi files for C extensions
Summary

I'm unsure if all the annotations are completely accurate. But having
these helps type checkers reason about our C extensions.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.Nov 7 2020, 8:23 PM
Alphare requested changes to this revision.Nov 13 2020, 4:59 AM
Alphare added a subscriber: Alphare.

Thanks for this.

One minor mistake I could find. If it's fixed, I implicitly accept the revision.

mercurial/cext/osutil.pyi
18

st is bool, not stat

This revision now requires changes to proceed.Nov 13 2020, 4:59 AM
pulkit accepted this revision.Dec 4 2020, 1:56 PM
pulkit added a subscriber: pulkit.
pulkit added inline comments.
mercurial/cext/osutil.pyi
18

Agreed, will fix this in flight.

indygreg added a commit: rHG8dca9051a859: cext: add .pyi files for C extensions.Dec 4 2020, 2:52 PM
This revision was not accepted when it landed; it landed in state Needs Revision.
Closed by commit rHG8dca9051a859: cext: add .pyi files for C extensions (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 23431

mercurial/cext/base85.pyi

  • This file was added.
from typing import Optional
version: int
def b85encode(text: bytes, pad: Optional[int]) -> bytes: ...
def b85decode(text: bytes) -> bytes: ...

mercurial/cext/bdiff.pyi

  • This file was added.
from typing import (
List,
Tuple,
)
version: int
def bdiff(a: bytes, b: bytes): bytes
def blocks(a: bytes, b: bytes) -> List[Tuple[int, int, int, int]]: ...
def fixws(s: bytes, allws: bool) -> bytes: ...
def splitnewlines(text: bytes) -> List[bytes]: ...
def xdiffblocks(a: bytes, b: bytes) -> List[Tuple[int, int, int, int]]: ...

mercurial/cext/mpatch.pyi

  • This file was added.
from typing import (
List,
)
version: int
class mpatchError(Exception): ...
def patches(text: bytes, bins: List[bytes]) -> bytes: ...
def patchedsize(orig: int, data: bytes) -> int: ...

mercurial/cext/osutil.pyi

  • This file was added.
from typing import (
AnyStr,
IO,
List,
Sequence,
)
version: int
class stat:
st_dev: int
st_mode: int
st_nlink: int
st_size: int
st_mtime: int
st_ctime: int
def listdir(path: bytes, st: stat, skip: bool) -> List[stat]: ...
AlphareUnsubmitted
Not Done

st is bool, not stat

Alphare: `st` is `bool`, not `stat`
pulkitUnsubmitted
Not Done

Agreed, will fix this in flight.

pulkit: Agreed, will fix this in flight.
def posixfile(name: AnyStr, mode: bytes, buffering: int) -> IO: ...
def statfiles(names: Sequence[bytes]) -> List[stat]: ...
def recvfds(sockfd: int) -> List[int]: ...
def setprocname(name: bytes) -> None: ...
def getfstype(path: bytes) -> bytes: ...
def getfsmountpoint(path: bytes) -> bytes: ...
def unblocksignal(sig: int) -> None: ...
def isgui() -> bool: ...

mercurial/cext/parsers.pyi

  • This file was added.
from typing import (
Callable,
Dict,
Iterator,
List,
Optional,
Set,
Tuple,
Union,
)
version: int
versionerrortext: str
class dirstatetuple:
__doc__: str
def __len__(self) -> int: ...
def __getitem__(self, key: int) -> Union[bytes, int]: ...
# From dirs.c
class dirs:
__doc__: str
def __init__(self, source, skipchar: bytes): ...
def __iter__(self) -> Iterator[bytes]: ...
def addpath(self, path: bytes) -> None: ...
def delpath(self, path: bytes) -> None: ...
# From manifest.c
class lazymanifest:
def __init__(self, data: bytes): ...
def __iter__(self) -> Iterator[bytes]: ...
def __len__(self) -> int: ...
def __getitem__(self, item: bytes) -> Optional[Tuple[bytes, bytes]]: ...
def __setitem__(self, key: bytes, value: Tuple[bytes, bytes]) -> None: ...
def __delitem__(self, key: bytes) -> None: ...
def iterkeys(self) -> Iterator[bytes]: ...
def iterentries(self) -> Iterator[Tuple[bytes, bytes, bytes]]: ...
def copy(self) -> lazymanifest: ...
def filtercopy(self, matchfn: Callable[[bytes], bool]) -> lazymanifest: ...
def diff(self, other: lazymanifest, clean: Optional[bool]) -> Dict[bytes, Tuple[bytes, Tuple]]: ...
def text(self) -> bytes: ...
# From revlog.c
class index:
__doc__: str
nodemap: Dict[bytes, int]
def ancestors(self, *args: int) -> Iterator[int]: ...
def commonancestorsheads(self, *args: int) -> List[int]: ...
def clearcaches(self) -> None: ...
def get(self, value: bytes) -> Optional[int]: ...
def get_rev(self, value: bytes) -> Optional[int]: ...
def has_node(self, value: Union[int, bytes]) -> bool: ...
def rev(self, node: bytes) -> int: ...
def computephasesmapsets(self, root: Dict[int, Set[bytes]]) -> Tuple[int, Dict[int, Set[bytes]]]: ...
def reachableroots2(self, minroot: int, heads: List[int], roots: List[int], includepath: bool) -> List[int]: ...
def headrevs(self, filteredrevs: Optional[List[int]]) -> List[int]: ...
def headrevsfiltered(self, filteredrevs: Optional[List[int]]) -> List[int]: ...
def issnapshot(self, value: int) -> bool: ...
def findsnapshots(self, cache: Dict[int, List[int]], start_rev: int) -> None: ...
def deltachain(self, rev: int, stop: int, generaldelta: bool) -> Tuple[List[int], bool]: ...
def slicechunktodensity(self, revs: List[int], targetdensity: float, mingapsize: int) -> List[List[int]]: ...
def append(self, value: Tuple[int, int, int, int, int, int, int, bytes]) -> None: ...
def partialmatch(self, node: bytes) -> bytes: ...
def shortest(self, value: bytes) -> int: ...
def stats(self) -> Dict[bytes, int]: ...
class nodetree:
__doc__: str
def insert(self, rev: int) -> None: ...
def shortest(self, node: bytes) -> int: ...