mercurial-scm/hg: mercurial/interfaces/matcher.py annotate

annotate mercurial/interfaces/matcher.py @ 52749:aa948d9e3fee

interfaces: add a class level doc comment to the `IMatcher` class This is trivial and can probably be expanded, but I wanted *something* to show how PyCharm propagates the documentation in its tooltips.

author	Matt Harbison <matt_harbison@yahoo.com>
date	Thu, 06 Feb 2025 15:17:37 -0500
parents	5c48fd4c0e68
children

rev	line source
52741 5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	1 # mercurial/interfaces/matcher - typing protocol for Matcher objects
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	2 #
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	3 # This software may be used and distributed according to the terms of the
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	4 # GNU General Public License version 2 or any later version.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	5
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	6 from __future__ import annotations
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	7
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	8 import abc
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	9
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	10 from typing import (
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	11 Callable,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	12 List,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	13 Optional,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	14 Protocol,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	15 Set,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	16 Union,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	17 )
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	18
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	19 from ._basetypes import (
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	20 HgPathT,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	21 UserMsgT,
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	22 )
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	23
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	24
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	25 class IMatcher(Protocol):
52749 aa948d9e3fee interfaces: add a class level doc comment to the `IMatcher` class Matt Harbison <matt_harbison@yahoo.com> parents: 52741 diff changeset	26 """A protocol class that defines the common interface for all file matching
aa948d9e3fee interfaces: add a class level doc comment to the `IMatcher` class Matt Harbison <matt_harbison@yahoo.com> parents: 52741 diff changeset	27 classes."""
aa948d9e3fee interfaces: add a class level doc comment to the `IMatcher` class Matt Harbison <matt_harbison@yahoo.com> parents: 52741 diff changeset	28
52741 5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	29 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	30 def was_tampered_with_nonrec(self) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	31 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	32
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	33 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	34 def was_tampered_with(self) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	35 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	36
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	37 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	38 def __call__(self, fn: HgPathT) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	39 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	40
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	41 # Callbacks related to how the matcher is used by dirstate.walk.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	42 # Subscribers to these events must monkeypatch the matcher object.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	43 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	44 def bad(self, f: HgPathT, msg: Optional[UserMsgT]) -> None:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	45 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	46
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	47 # If traversedir is set, it will be called when a directory discovered
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	48 # by recursive traversal is visited.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	49 traversedir: Optional[Callable[[HgPathT], None]] = None
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	50
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	51 @property
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	52 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	53 def _files(self) -> List[HgPathT]:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	54 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	55
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	56 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	57 def files(self) -> List[HgPathT]:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	58 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	59
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	60 @property
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	61 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	62 def _fileset(self) -> Set[HgPathT]:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	63 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	64
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	65 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	66 def exact(self, f: HgPathT) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	67 """Returns True if f is in .files()."""
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	68
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	69 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	70 def matchfn(self, f: HgPathT) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	71 ...
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	72
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	73 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	74 def visitdir(self, dir: HgPathT) -> Union[bool, bytes]:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	75 """Decides whether a directory should be visited based on whether it
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	76 has potential matches in it or one of its subdirectories. This is
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	77 based on the match's primary, included, and excluded patterns.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	78
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	79 Returns the string 'all' if the given directory and all subdirectories
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	80 should be visited. Otherwise returns True or False indicating whether
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	81 the given directory should be visited.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	82 """
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	83
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	84 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	85 def visitchildrenset(self, dir: HgPathT) -> Union[Set[HgPathT], bytes]:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	86 """Decides whether a directory should be visited based on whether it
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	87 has potential matches in it or one of its subdirectories, and
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	88 potentially lists which subdirectories of that directory should be
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	89 visited. This is based on the match's primary, included, and excluded
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	90 patterns.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	91
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	92 This function is very similar to 'visitdir', and the following mapping
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	93 can be applied:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	94
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	95 visitdir \| visitchildrenlist
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	96 ----------+-------------------
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	97 False \| set()
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	98 'all' \| 'all'
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	99 True \| 'this' OR non-empty set of subdirs -or files- to visit
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	100
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	101 Example:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	102 Assume matchers ['path:foo/bar', 'rootfilesin:qux'], we would return
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	103 the following values (assuming the implementation of visitchildrenset
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	104 is capable of recognizing this; some implementations are not).
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	105
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	106 '' -> {'foo', 'qux'}
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	107 'baz' -> set()
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	108 'foo' -> {'bar'}
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	109 # Ideally this would be 'all', but since the prefix nature of matchers
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	110 # is applied to the entire matcher, we have to downgrade this to
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	111 # 'this' due to the non-prefix 'rootfilesin'-kind matcher being mixed
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	112 # in.
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	113 'foo/bar' -> 'this'
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	114 'qux' -> 'this'
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	115
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	116 Important:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	117 Most matchers do not know if they're representing files or
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	118 directories. They see ['path:dir/f'] and don't know whether 'f' is a
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	119 file or a directory, so visitchildrenset('dir') for most matchers will
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	120 return {'f'}, but if the matcher knows it's a file (like exactmatcher
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	121 does), it may return 'this'. Do not rely on the return being a set
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	122 indicating that there are no files in this dir to investigate (or
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	123 equivalently that if there are files to investigate in 'dir' that it
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	124 will always return 'this').
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	125 """
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	126
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	127 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	128 def always(self) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	129 """Matcher will match everything and .files() will be empty --
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	130 optimization might be possible."""
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	131
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	132 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	133 def isexact(self) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	134 """Matcher will match exactly the list of files in .files() --
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	135 optimization might be possible."""
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	136
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	137 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	138 def prefix(self) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	139 """Matcher will match the paths in .files() recursively --
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	140 optimization might be possible."""
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	141
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	142 @abc.abstractmethod
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	143 def anypats(self) -> bool:
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	144 """None of .always(), .isexact(), and .prefix() is true --
5c48fd4c0e68 typing: introduce a `types` module and a MatcherT alias Pierre-Yves David <pierre-yves.david@octobus.net> parents: diff changeset	145 optimizations will be difficult."""

Mercurial > public > mercurial-scm > hg

annotate mercurial/interfaces/matcher.py @ 52749:aa948d9e3fee