Mercurial > public > mercurial-scm > hg
diff mercurial/interfaces/dirstate.py @ 52508:2ac368d0a5b6
interfaces: make `dirstate` Protocol class methods abstract
Now all known Protocol methods that should be implemented by the subclass are
abstract. See cdd4bc69bfc1 for details.
Note that this will break the `git` extension more, because there are a bunch of
methods that aren't implemented that should be, in favor of some very old
methods that won't be called (like `add()` and `drop()`). It's already broken,
so I'm not taking the time to figure out how to modernize it right now. It's
not detected by pytype because the only instantiation of `gitdirstate` is in
`git/__init__.py`, which was already excluded from pytype checking for some
other reason. AT least with this, it 1) doesn't get forgotten about, and 2)
will require changing the interface if/when the core dirstate class evolves.
| author | Matt Harbison <matt_harbison@yahoo.com> |
|---|---|
| date | Wed, 11 Dec 2024 21:09:15 -0500 |
| parents | 8820c991aee4 |
| children | 5c48fd4c0e68 |
line wrap: on
line diff
--- a/mercurial/interfaces/dirstate.py Wed Dec 11 21:11:19 2024 -0500 +++ b/mercurial/interfaces/dirstate.py Wed Dec 11 21:09:15 2024 -0500 @@ -99,29 +99,35 @@ """Matcher for ignored files.""" @property + @abc.abstractmethod def is_changing_any(self) -> bool: """True if any changes in progress.""" @property + @abc.abstractmethod def is_changing_parents(self) -> bool: """True if parents changes in progress.""" @property + @abc.abstractmethod def is_changing_files(self) -> bool: """True if file tracking changes in progress.""" + @abc.abstractmethod def _ignorefileandline(self, f: bytes) -> IgnoreFileAndLineT: """Given a file `f`, return the ignore file and line that ignores it.""" # TODO: decorate with `@util.propertycache` like dirstate class? # (can't because circular import) @property + @abc.abstractmethod def _checklink(self) -> bool: """Callable for checking symlinks.""" # TODO: this comment looks stale # TODO: decorate with `@util.propertycache` like dirstate class? # (can't because circular import) @property + @abc.abstractmethod def _checkexec(self) -> bool: """Callable for checking exec bits.""" # TODO: this comment looks stale @@ -145,9 +151,11 @@ released. """ + @abc.abstractmethod def hasdir(self, d: bytes) -> bool: pass + @abc.abstractmethod def flagfunc(self, buildfallback: FlagFuncFallbackT) -> FlagFuncReturnT: """build a callable that returns flags associated with a filename @@ -157,6 +165,7 @@ 3. a more expensive mechanism inferring the flags from the parents. """ + @abc.abstractmethod def getcwd(self) -> bytes: """Return the path from which a canonical path is calculated. @@ -165,18 +174,23 @@ used to get real file paths. Use vfs functions instead. """ + @abc.abstractmethod def pathto(self, f: bytes, cwd: Optional[bytes] = None) -> bytes: pass + @abc.abstractmethod def get_entry(self, path: bytes) -> DirstateItemT: """return a DirstateItem for the associated path""" + @abc.abstractmethod def __contains__(self, key: Any) -> bool: """Check if bytestring `key` is known to the dirstate.""" + @abc.abstractmethod def __iter__(self) -> Iterator[bytes]: """Iterate the dirstate's contained filenames as bytestrings.""" + @abc.abstractmethod def items(self) -> Iterator[Tuple[bytes, DirstateItemT]]: """Iterate the dirstate's entries as (filename, DirstateItem. @@ -185,19 +199,24 @@ iteritems = items + @abc.abstractmethod def parents(self) -> List[bytes]: pass + @abc.abstractmethod def p1(self) -> bytes: pass + @abc.abstractmethod def p2(self) -> bytes: pass + @abc.abstractmethod def branch(self) -> bytes: pass # TODO: typehint the return. It's a copies Map of some sort. + @abc.abstractmethod def setparents(self, p1: bytes, p2: Optional[bytes] = None): """Set dirstate parents to p1 and p2. @@ -208,11 +227,13 @@ See localrepo.setparents() """ + @abc.abstractmethod def setbranch( self, branch: bytes, transaction: Optional[TransactionT] ) -> None: pass + @abc.abstractmethod def invalidate(self) -> None: """Causes the next access to reread the dirstate. @@ -220,15 +241,19 @@ rereads the dirstate. Use localrepo.invalidatedirstate() if you want to check whether the dirstate has changed before rereading it.""" + @abc.abstractmethod def copy(self, source: Optional[bytes], dest: bytes) -> None: """Mark dest as a copy of source. Unmark dest if source is None.""" + @abc.abstractmethod def copied(self, file: bytes) -> Optional[bytes]: pass + @abc.abstractmethod def copies(self) -> Dict[bytes, bytes]: pass + @abc.abstractmethod def normalize( self, path: bytes, isknown: bool = False, ignoremissing: bool = False ) -> bytes: @@ -249,9 +274,11 @@ - version provided via command arguments """ + @abc.abstractmethod def clear(self) -> None: pass + @abc.abstractmethod def rebuild( self, parent: bytes, @@ -260,9 +287,11 @@ ) -> None: pass + @abc.abstractmethod def write(self, tr: Optional[TransactionT]) -> None: pass + @abc.abstractmethod def addparentchangecallback( self, category: bytes, callback: AddParentChangeCallbackT ) -> None: @@ -275,6 +304,7 @@ with a newer callback. """ + @abc.abstractmethod def walk( self, match: matchmod.basematcher, @@ -294,6 +324,7 @@ """ + @abc.abstractmethod def status( self, match: matchmod.basematcher, @@ -320,6 +351,7 @@ # TODO: could return a list, except git.dirstate is a generator + @abc.abstractmethod def matches(self, match: matchmod.basematcher) -> Iterable[bytes]: """ return files in the dirstate (in whatever state) filtered by match @@ -327,6 +359,7 @@ # TODO: finish adding typehints here, and to subclasses + @abc.abstractmethod def verify( self, m1, m2, p1: bytes, narrow_matcher: Optional[Any] = None ) -> Iterator[bytes]: