| durin42 | |
| baymax |
| hg-reviewers |
zope.interface uses class magic to define interfaces. Mypy doesn't
like the methods without arguments and raises a warning for the
dozens of them in repository.py.
This commit adds type annotation comments to silence the error.
TBH I'm not sure if this is the best way to do this. But it does
get the job done. We may have to revisit once we add proper type
annotations to this file. For now, it makes mypy's output far
less verbose.
| Lint Skipped |
| Unit Tests Skipped |
There seems to have been no activities on this Diff for the past 3 Months.
By policy, we are automatically moving it out of the need-review state.
Please, move it back to need-review without hesitation if this diff should still be discussed.
:baymax:need-review-idle:
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/repository.py (138 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| c19c8f892a33 | 148b125a412d | Gregory Szorc | Aug 4 2019, 3:49 PM |
| This is the base interface for representing a connection to a repository. | This is the base interface for representing a connection to a repository. | ||||
| It holds basic properties and methods applicable to all peer types. | It holds basic properties and methods applicable to all peer types. | ||||
| This is not a complete interface definition and should not be used | This is not a complete interface definition and should not be used | ||||
| outside of this module. | outside of this module. | ||||
| """ | """ | ||||
| ui = interfaceutil.Attribute("""ui.ui instance""") | ui = interfaceutil.Attribute("""ui.ui instance""") | ||||
| def url(): | def url(): # type: ignore | ||||
| """Returns a URL string representing this peer. | """Returns a URL string representing this peer. | ||||
| Currently, implementations expose the raw URL used to construct the | Currently, implementations expose the raw URL used to construct the | ||||
| instance. It may contain credentials as part of the URL. The | instance. It may contain credentials as part of the URL. The | ||||
| expectations of the value aren't well-defined and this could lead to | expectations of the value aren't well-defined and this could lead to | ||||
| data leakage. | data leakage. | ||||
| TODO audit/clean consumers and more clearly define the contents of this | TODO audit/clean consumers and more clearly define the contents of this | ||||
| value. | value. | ||||
| """ | """ | ||||
| def local(): | def local(): # type: ignore | ||||
| """Returns a local repository instance. | """Returns a local repository instance. | ||||
| If the peer represents a local repository, returns an object that | If the peer represents a local repository, returns an object that | ||||
| can be used to interface with it. Otherwise returns ``None``. | can be used to interface with it. Otherwise returns ``None``. | ||||
| """ | """ | ||||
| def peer(): | def peer(): # type: ignore | ||||
| """Returns an object conforming to this interface. | """Returns an object conforming to this interface. | ||||
| Most implementations will ``return self``. | Most implementations will ``return self``. | ||||
| """ | """ | ||||
| def canpush(): | def canpush(): # type: ignore | ||||
| """Returns a boolean indicating if this peer can be pushed to.""" | """Returns a boolean indicating if this peer can be pushed to.""" | ||||
| def close(): | def close(): # type: ignore | ||||
| """Close the connection to this peer. | """Close the connection to this peer. | ||||
| This is called when the peer will no longer be used. Resources | This is called when the peer will no longer be used. Resources | ||||
| associated with the peer should be cleaned up. | associated with the peer should be cleaned up. | ||||
| """ | """ | ||||
| class ipeercapabilities(interfaceutil.Interface): | class ipeercapabilities(interfaceutil.Interface): | ||||
| """Peer sub-interface related to capabilities.""" | """Peer sub-interface related to capabilities.""" | ||||
| class ipeercommands(interfaceutil.Interface): | class ipeercommands(interfaceutil.Interface): | ||||
| """Client-side interface for communicating over the wire protocol. | """Client-side interface for communicating over the wire protocol. | ||||
| This interface is used as a gateway to the Mercurial wire protocol. | This interface is used as a gateway to the Mercurial wire protocol. | ||||
| methods commonly call wire protocol commands of the same name. | methods commonly call wire protocol commands of the same name. | ||||
| """ | """ | ||||
| def branchmap(): | def branchmap(): # type: ignore | ||||
| """Obtain heads in named branches. | """Obtain heads in named branches. | ||||
| Returns a dict mapping branch name to an iterable of nodes that are | Returns a dict mapping branch name to an iterable of nodes that are | ||||
| heads on that branch. | heads on that branch. | ||||
| """ | """ | ||||
| def capabilities(): | def capabilities(): # type: ignore | ||||
| """Obtain capabilities of the peer. | """Obtain capabilities of the peer. | ||||
| Returns a set of string capabilities. | Returns a set of string capabilities. | ||||
| """ | """ | ||||
| def clonebundles(): | def clonebundles(): # type: ignore | ||||
| """Obtains the clone bundles manifest for the repo. | """Obtains the clone bundles manifest for the repo. | ||||
| Returns the manifest as unparsed bytes. | Returns the manifest as unparsed bytes. | ||||
| """ | """ | ||||
| def debugwireargs(one, two, three=None, four=None, five=None): | def debugwireargs(one, two, three=None, four=None, five=None): | ||||
| """Used to facilitate debugging of arguments passed over the wire.""" | """Used to facilitate debugging of arguments passed over the wire.""" | ||||
| def getbundle(source, **kwargs): | def getbundle(source, **kwargs): | ||||
| """Obtain remote repository data as a bundle. | """Obtain remote repository data as a bundle. | ||||
| This command is how the bulk of repository data is transferred from | This command is how the bulk of repository data is transferred from | ||||
| the peer to the local repository | the peer to the local repository | ||||
| Returns a generator of bundle data. | Returns a generator of bundle data. | ||||
| """ | """ | ||||
| def heads(): | def heads(): # type: ignore | ||||
| """Determine all known head revisions in the peer. | """Determine all known head revisions in the peer. | ||||
| Returns an iterable of binary nodes. | Returns an iterable of binary nodes. | ||||
| """ | """ | ||||
| def known(nodes): | def known(nodes): | ||||
| """Determine whether multiple nodes are known. | """Determine whether multiple nodes are known. | ||||
| Arguments correspond to the pushkey namespace and key to operate on and | Arguments correspond to the pushkey namespace and key to operate on and | ||||
| the old and new values for that key. | the old and new values for that key. | ||||
| Returns a string with the peer result. The value inside varies by the | Returns a string with the peer result. The value inside varies by the | ||||
| namespace. | namespace. | ||||
| """ | """ | ||||
| def stream_out(): | def stream_out(): # type: ignore | ||||
| """Obtain streaming clone data. | """Obtain streaming clone data. | ||||
| Successful result should be a generator of data chunks. | Successful result should be a generator of data chunks. | ||||
| """ | """ | ||||
| def unbundle(bundle, heads, url): | def unbundle(bundle, heads, url): | ||||
| """Transfer repository data to the peer. | """Transfer repository data to the peer. | ||||
| requested command can not coexist with other commands in this executor. | requested command can not coexist with other commands in this executor. | ||||
| Implementations MAY call ``sendcommands()`` automatically when the | Implementations MAY call ``sendcommands()`` automatically when the | ||||
| future's ``result()`` is called. So, consumers using multiple | future's ``result()`` is called. So, consumers using multiple | ||||
| commands with an executor MUST ensure that ``result()`` is not called | commands with an executor MUST ensure that ``result()`` is not called | ||||
| until all command requests have been issued. | until all command requests have been issued. | ||||
| """ | """ | ||||
| def sendcommands(): | def sendcommands(): # type: ignore | ||||
| """Trigger submission of queued command requests. | """Trigger submission of queued command requests. | ||||
| Not all transports submit commands as soon as they are requested to | Not all transports submit commands as soon as they are requested to | ||||
| run. When called, this method forces queued command requests to be | run. When called, this method forces queued command requests to be | ||||
| issued. It will no-op if all commands have already been sent. | issued. It will no-op if all commands have already been sent. | ||||
| When called, no more new commands may be issued with this executor. | When called, no more new commands may be issued with this executor. | ||||
| """ | """ | ||||
| def close(): | def close(): # type: ignore | ||||
| """Signal that this command request is finished. | """Signal that this command request is finished. | ||||
| When called, no more new commands may be issued. All outstanding | When called, no more new commands may be issued. All outstanding | ||||
| commands that have previously been issued are waited on before | commands that have previously been issued are waited on before | ||||
| returning. This not only includes waiting for the futures to resolve, | returning. This not only includes waiting for the futures to resolve, | ||||
| but also waiting for all response data to arrive. In other words, | but also waiting for all response data to arrive. In other words, | ||||
| calling this waits for all on-wire state for issued command requests | calling this waits for all on-wire state for issued command requests | ||||
| to finish. | to finish. | ||||
| When used as a context manager, this method is called when exiting the | When used as a context manager, this method is called when exiting the | ||||
| context manager. | context manager. | ||||
| This method may call ``sendcommands()`` if there are buffered commands. | This method may call ``sendcommands()`` if there are buffered commands. | ||||
| """ | """ | ||||
| class ipeerrequests(interfaceutil.Interface): | class ipeerrequests(interfaceutil.Interface): | ||||
| """Interface for executing commands on a peer.""" | """Interface for executing commands on a peer.""" | ||||
| limitedarguments = interfaceutil.Attribute( | limitedarguments = interfaceutil.Attribute( | ||||
| """True if the peer cannot receive large argument value for commands.""" | """True if the peer cannot receive large argument value for commands.""" | ||||
| ) | ) | ||||
| def commandexecutor(): | def commandexecutor(): # type: ignore | ||||
| """A context manager that resolves to an ipeercommandexecutor. | """A context manager that resolves to an ipeercommandexecutor. | ||||
| The object this resolves to can be used to issue command requests | The object this resolves to can be used to issue command requests | ||||
| to the peer. | to the peer. | ||||
| Callers should call its ``callcommand`` method to issue command | Callers should call its ``callcommand`` method to issue command | ||||
| requests. | requests. | ||||
| Types implementing this behave like lists of tuples. The index | Types implementing this behave like lists of tuples. The index | ||||
| in the list corresponds to the revision number. The values contain | in the list corresponds to the revision number. The values contain | ||||
| index metadata. | index metadata. | ||||
| The *null* revision (revision number -1) is always the last item | The *null* revision (revision number -1) is always the last item | ||||
| in the index. | in the index. | ||||
| """ | """ | ||||
| def __len__(): | def __len__(): # type: ignore | ||||
| """The total number of revisions.""" | """The total number of revisions.""" | ||||
| def __getitem__(rev): | def __getitem__(rev): | ||||
| """Returns the object having a specific revision number. | """Returns the object having a specific revision number. | ||||
| Returns an 8-tuple with the following fields: | Returns an 8-tuple with the following fields: | ||||
| offset+flags | offset+flags | ||||
| This interface defines the index portion of the interface. | This interface defines the index portion of the interface. | ||||
| The index logically consists of: | The index logically consists of: | ||||
| * A mapping between revision numbers and nodes. | * A mapping between revision numbers and nodes. | ||||
| * DAG data (storing and querying the relationship between nodes). | * DAG data (storing and querying the relationship between nodes). | ||||
| * Metadata to facilitate storage. | * Metadata to facilitate storage. | ||||
| """ | """ | ||||
| def __len__(): | def __len__(): # type: ignore | ||||
| """Obtain the number of revisions stored for this file.""" | """Obtain the number of revisions stored for this file.""" | ||||
| def __iter__(): | def __iter__(): # type: ignore | ||||
| """Iterate over revision numbers for this file.""" | """Iterate over revision numbers for this file.""" | ||||
| def hasnode(node): | def hasnode(node): | ||||
| """Returns a bool indicating if a node is known to this store. | """Returns a bool indicating if a node is known to this store. | ||||
| Implementations must only return True for full, binary node values: | Implementations must only return True for full, binary node values: | ||||
| hex nodes, revision numbers, and partial node matches must be | hex nodes, revision numbers, and partial node matches must be | ||||
| rejected. | rejected. | ||||
| TODO this is highly revlog centric and should be abstracted into a | TODO this is highly revlog centric and should be abstracted into a | ||||
| higher-level deletion API. | higher-level deletion API. | ||||
| """ | """ | ||||
| class ifilestorage(ifileindex, ifiledata, ifilemutation): | class ifilestorage(ifileindex, ifiledata, ifilemutation): | ||||
| """Complete storage interface for a single tracked file.""" | """Complete storage interface for a single tracked file.""" | ||||
| def files(): | def files(): # type: ignore | ||||
| """Obtain paths that are backing storage for this file. | """Obtain paths that are backing storage for this file. | ||||
| TODO this is used heavily by verify code and there should probably | TODO this is used heavily by verify code and there should probably | ||||
| be a better API for that. | be a better API for that. | ||||
| """ | """ | ||||
| def storageinfo(exclusivefiles=False, sharedfiles=False, | def storageinfo(exclusivefiles=False, sharedfiles=False, | ||||
| revisionscount=False, trackedsize=False, | revisionscount=False, trackedsize=False, | ||||
| def delpath(path): | def delpath(path): | ||||
| """Remove a path from the collection. | """Remove a path from the collection. | ||||
| If the removal was the last path in a particular directory, the | If the removal was the last path in a particular directory, the | ||||
| directory is removed from the collection. | directory is removed from the collection. | ||||
| """ | """ | ||||
| def __iter__(): | def __iter__(): # type: ignore | ||||
| """Iterate over the directories in this collection of paths.""" | """Iterate over the directories in this collection of paths.""" | ||||
| def __contains__(path): | def __contains__(path): | ||||
| """Whether a specific directory is in this collection.""" | """Whether a specific directory is in this collection.""" | ||||
| class imanifestdict(interfaceutil.Interface): | class imanifestdict(interfaceutil.Interface): | ||||
| """Interface representing a manifest data structure. | """Interface representing a manifest data structure. | ||||
| def find(path): | def find(path): | ||||
| """Returns the entry for a path in the manifest. | """Returns the entry for a path in the manifest. | ||||
| Returns a 2-tuple of (node, flags). | Returns a 2-tuple of (node, flags). | ||||
| Raises ``KeyError`` if the path does not exist in the manifest. | Raises ``KeyError`` if the path does not exist in the manifest. | ||||
| """ | """ | ||||
| def __len__(): | def __len__(): # type: ignore | ||||
| """Return the number of entries in the manifest.""" | """Return the number of entries in the manifest.""" | ||||
| def __nonzero__(): | def __nonzero__(): # type: ignore | ||||
| """Returns True if the manifest has entries, False otherwise.""" | """Returns True if the manifest has entries, False otherwise.""" | ||||
| __bool__ = __nonzero__ | __bool__ = __nonzero__ | ||||
| def __setitem__(path, node): | def __setitem__(path, node): | ||||
| """Define the node value for a path in the manifest. | """Define the node value for a path in the manifest. | ||||
| If the path is already in the manifest, its flags will be copied to | If the path is already in the manifest, its flags will be copied to | ||||
| the new entry. | the new entry. | ||||
| """ | """ | ||||
| def __contains__(path): | def __contains__(path): | ||||
| """Whether a path exists in the manifest.""" | """Whether a path exists in the manifest.""" | ||||
| def __delitem__(path): | def __delitem__(path): | ||||
| """Remove a path from the manifest. | """Remove a path from the manifest. | ||||
| Raises ``KeyError`` if the path is not in the manifest. | Raises ``KeyError`` if the path is not in the manifest. | ||||
| """ | """ | ||||
| def __iter__(): | def __iter__(): # type: ignore | ||||
| """Iterate over paths in the manifest.""" | """Iterate over paths in the manifest.""" | ||||
| def iterkeys(): | def iterkeys(): # type: ignore | ||||
| """Iterate over paths in the manifest.""" | """Iterate over paths in the manifest.""" | ||||
| def keys(): | def keys(): # type: ignore | ||||
| """Obtain a list of paths in the manifest.""" | """Obtain a list of paths in the manifest.""" | ||||
| def filesnotin(other, match=None): | def filesnotin(other, match=None): | ||||
| """Obtain the set of paths in this manifest but not in another. | """Obtain the set of paths in this manifest but not in another. | ||||
| ``match`` is an optional matcher function to be applied to both | ``match`` is an optional matcher function to be applied to both | ||||
| manifests. | manifests. | ||||
| Returns a set of paths. | Returns a set of paths. | ||||
| """ | """ | ||||
| def dirs(): | def dirs(): # type: ignore | ||||
| """Returns an object implementing the ``idirs`` interface.""" | """Returns an object implementing the ``idirs`` interface.""" | ||||
| def hasdir(dir): | def hasdir(dir): | ||||
| """Returns a bool indicating if a directory is in this manifest.""" | """Returns a bool indicating if a directory is in this manifest.""" | ||||
| def matches(match): | def matches(match): | ||||
| """Generate a new manifest filtered through a matcher. | """Generate a new manifest filtered through a matcher. | ||||
| """ | """ | ||||
| def get(path, default=None): | def get(path, default=None): | ||||
| """Obtain the node value for a path or a default value if missing.""" | """Obtain the node value for a path or a default value if missing.""" | ||||
| def flags(path, default=''): | def flags(path, default=''): | ||||
| """Return the flags value for a path or a default value if missing.""" | """Return the flags value for a path or a default value if missing.""" | ||||
| def copy(): | def copy(): # type: ignore | ||||
| """Return a copy of this manifest.""" | """Return a copy of this manifest.""" | ||||
| def items(): | def items(): # type: ignore | ||||
| """Returns an iterable of (path, node) for items in this manifest.""" | """Returns an iterable of (path, node) for items in this manifest.""" | ||||
| def iteritems(): | def iteritems(): # type: ignore | ||||
| """Identical to items().""" | """Identical to items().""" | ||||
| def iterentries(): | def iterentries(): # type: ignore | ||||
| """Returns an iterable of (path, node, flags) for this manifest. | """Returns an iterable of (path, node, flags) for this manifest. | ||||
| Similar to ``iteritems()`` except items are a 3-tuple and include | Similar to ``iteritems()`` except items are a 3-tuple and include | ||||
| flags. | flags. | ||||
| """ | """ | ||||
| def text(): | def text(): # type: ignore | ||||
| """Obtain the raw data representation for this manifest. | """Obtain the raw data representation for this manifest. | ||||
| Result is used to create a manifest revision. | Result is used to create a manifest revision. | ||||
| """ | """ | ||||
| def fastdelta(base, changes): | def fastdelta(base, changes): | ||||
| """Obtain a delta between this manifest and another given changes. | """Obtain a delta between this manifest and another given changes. | ||||
| ``base`` in the raw data representation for another manifest. | ``base`` in the raw data representation for another manifest. | ||||
| ``changes`` is an iterable of ``(path, to_delete)``. | ``changes`` is an iterable of ``(path, to_delete)``. | ||||
| Returns a 2-tuple containing ``bytearray(self.text())`` and the | Returns a 2-tuple containing ``bytearray(self.text())`` and the | ||||
| delta between ``base`` and this manifest. | delta between ``base`` and this manifest. | ||||
| """ | """ | ||||
| class imanifestrevisionbase(interfaceutil.Interface): | class imanifestrevisionbase(interfaceutil.Interface): | ||||
| """Base interface representing a single revision of a manifest. | """Base interface representing a single revision of a manifest. | ||||
| Should not be used as a primary interface: should always be inherited | Should not be used as a primary interface: should always be inherited | ||||
| as part of a larger interface. | as part of a larger interface. | ||||
| """ | """ | ||||
| def new(): | def new(): # type: ignore | ||||
| """Obtain a new manifest instance. | """Obtain a new manifest instance. | ||||
| Returns an object conforming to the ``imanifestrevisionwritable`` | Returns an object conforming to the ``imanifestrevisionwritable`` | ||||
| interface. The instance will be associated with the same | interface. The instance will be associated with the same | ||||
| ``imanifestlog`` collection as this instance. | ``imanifestlog`` collection as this instance. | ||||
| """ | """ | ||||
| def copy(): | def copy(): # type: ignore | ||||
| """Obtain a copy of this manifest instance. | """Obtain a copy of this manifest instance. | ||||
| Returns an object conforming to the ``imanifestrevisionwritable`` | Returns an object conforming to the ``imanifestrevisionwritable`` | ||||
| interface. The instance will be associated with the same | interface. The instance will be associated with the same | ||||
| ``imanifestlog`` collection as this instance. | ``imanifestlog`` collection as this instance. | ||||
| """ | """ | ||||
| def read(): | def read(): # type: ignore | ||||
| """Obtain the parsed manifest data structure. | """Obtain the parsed manifest data structure. | ||||
| The returned object conforms to the ``imanifestdict`` interface. | The returned object conforms to the ``imanifestdict`` interface. | ||||
| """ | """ | ||||
| class imanifestrevisionstored(imanifestrevisionbase): | class imanifestrevisionstored(imanifestrevisionbase): | ||||
| """Interface representing a manifest revision committed to storage.""" | """Interface representing a manifest revision committed to storage.""" | ||||
| def node(): | def node(): # type: ignore | ||||
| """The binary node for this manifest.""" | """The binary node for this manifest.""" | ||||
| parents = interfaceutil.Attribute( | parents = interfaceutil.Attribute( | ||||
| """List of binary nodes that are parents for this manifest revision.""" | """List of binary nodes that are parents for this manifest revision.""" | ||||
| ) | ) | ||||
| def readdelta(shallow=False): | def readdelta(shallow=False): | ||||
| """Obtain the manifest data structure representing changes from parent. | """Obtain the manifest data structure representing changes from parent. | ||||
| """) | """) | ||||
| fulltextcache = interfaceutil.Attribute( | fulltextcache = interfaceutil.Attribute( | ||||
| """Dict with cache of fulltexts. | """Dict with cache of fulltexts. | ||||
| TODO this doesn't feel appropriate for the storage interface. | TODO this doesn't feel appropriate for the storage interface. | ||||
| """) | """) | ||||
| def __len__(): | def __len__(): # type: ignore | ||||
| """Obtain the number of revisions stored for this manifest.""" | """Obtain the number of revisions stored for this manifest.""" | ||||
| def __iter__(): | def __iter__(): # type: ignore | ||||
| """Iterate over revision numbers for this manifest.""" | """Iterate over revision numbers for this manifest.""" | ||||
| def rev(node): | def rev(node): | ||||
| """Obtain the revision number given a binary node. | """Obtain the revision number given a binary node. | ||||
| Raises ``error.LookupError`` if the node is not known. | Raises ``error.LookupError`` if the node is not known. | ||||
| """ | """ | ||||
| """ | """ | ||||
| def strip(minlink, transaction): | def strip(minlink, transaction): | ||||
| """Remove storage of items starting at a linkrev. | """Remove storage of items starting at a linkrev. | ||||
| See the documentation in ``ifilemutation`` for more. | See the documentation in ``ifilemutation`` for more. | ||||
| """ | """ | ||||
| def checksize(): | def checksize(): # type: ignore | ||||
| """Obtain the expected sizes of backing files. | """Obtain the expected sizes of backing files. | ||||
| TODO this is used by verify and it should not be part of the interface. | TODO this is used by verify and it should not be part of the interface. | ||||
| """ | """ | ||||
| def files(): | def files(): # type: ignore | ||||
| """Obtain paths that are backing storage for this manifest. | """Obtain paths that are backing storage for this manifest. | ||||
| TODO this is used by verify and there should probably be a better API | TODO this is used by verify and there should probably be a better API | ||||
| for this functionality. | for this functionality. | ||||
| """ | """ | ||||
| def deltaparent(rev): | def deltaparent(rev): | ||||
| """Obtain the revision that a revision is delta'd against. | """Obtain the revision that a revision is delta'd against. | ||||
| """Retrieve an interface to storage for a particular tree. | """Retrieve an interface to storage for a particular tree. | ||||
| If ``tree`` is the empty bytestring, storage for the root manifest will | If ``tree`` is the empty bytestring, storage for the root manifest will | ||||
| be returned. Otherwise storage for a tree manifest is returned. | be returned. Otherwise storage for a tree manifest is returned. | ||||
| TODO formalize interface for returned object. | TODO formalize interface for returned object. | ||||
| """ | """ | ||||
| def clearcaches(): | def clearcaches(): # type: ignore | ||||
| """Clear caches associated with this collection.""" | """Clear caches associated with this collection.""" | ||||
| def rev(node): | def rev(node): | ||||
| """Obtain the revision number for a binary node. | """Obtain the revision number for a binary node. | ||||
| Raises ``error.LookupError`` if the node is not known. | Raises ``error.LookupError`` if the node is not known. | ||||
| """ | """ | ||||
| """) | """) | ||||
| filteredrevcache = interfaceutil.Attribute( | filteredrevcache = interfaceutil.Attribute( | ||||
| """Holds sets of revisions to be filtered.""") | """Holds sets of revisions to be filtered.""") | ||||
| names = interfaceutil.Attribute( | names = interfaceutil.Attribute( | ||||
| """A ``namespaces`` instance.""") | """A ``namespaces`` instance.""") | ||||
| def close(): | def close(): # type: ignore | ||||
| """Close the handle on this repository.""" | """Close the handle on this repository.""" | ||||
| def peer(): | def peer(): # type: ignore | ||||
| """Obtain an object conforming to the ``peer`` interface.""" | """Obtain an object conforming to the ``peer`` interface.""" | ||||
| def unfiltered(): | def unfiltered(): # type: ignore | ||||
| """Obtain an unfiltered/raw view of this repo.""" | """Obtain an unfiltered/raw view of this repo.""" | ||||
| def filtered(name, visibilityexceptions=None): | def filtered(name, visibilityexceptions=None): | ||||
| """Obtain a named view of this repository.""" | """Obtain a named view of this repository.""" | ||||
| obsstore = interfaceutil.Attribute( | obsstore = interfaceutil.Attribute( | ||||
| """A store of obsolescence data.""") | """A store of obsolescence data.""") | ||||
| """Define the narrowspec for this repository.""" | """Define the narrowspec for this repository.""" | ||||
| def __getitem__(changeid): | def __getitem__(changeid): | ||||
| """Try to resolve a changectx.""" | """Try to resolve a changectx.""" | ||||
| def __contains__(changeid): | def __contains__(changeid): | ||||
| """Whether a changeset exists.""" | """Whether a changeset exists.""" | ||||
| def __nonzero__(): | def __nonzero__(): # type: ignore | ||||
| """Always returns True.""" | """Always returns True.""" | ||||
| return True | return True | ||||
| __bool__ = __nonzero__ | __bool__ = __nonzero__ | ||||
| def __len__(): | def __len__(): # type: ignore | ||||
| """Returns the number of changesets in the repo.""" | """Returns the number of changesets in the repo.""" | ||||
| def __iter__(): | def __iter__(): # type: ignore | ||||
| """Iterate over revisions in the changelog.""" | """Iterate over revisions in the changelog.""" | ||||
| def revs(expr, *args): | def revs(expr, *args): | ||||
| """Evaluate a revset. | """Evaluate a revset. | ||||
| Emits revisions. | Emits revisions. | ||||
| """ | """ | ||||
| def set(expr, *args): | def set(expr, *args): | ||||
| """Evaluate a revset. | """Evaluate a revset. | ||||
| Emits changectx instances. | Emits changectx instances. | ||||
| """ | """ | ||||
| def anyrevs(specs, user=False, localalias=None): | def anyrevs(specs, user=False, localalias=None): | ||||
| """Find revisions matching one of the given revsets.""" | """Find revisions matching one of the given revsets.""" | ||||
| def url(): | def url(): # type: ignore | ||||
| """Returns a string representing the location of this repo.""" | """Returns a string representing the location of this repo.""" | ||||
| def hook(name, throw=False, **args): | def hook(name, throw=False, **args): | ||||
| """Call a hook.""" | """Call a hook.""" | ||||
| def tags(): | def tags(): # type: ignore | ||||
| """Return a mapping of tag to node.""" | """Return a mapping of tag to node.""" | ||||
| def tagtype(tagname): | def tagtype(tagname): | ||||
| """Return the type of a given tag.""" | """Return the type of a given tag.""" | ||||
| def tagslist(): | def tagslist(): # type: ignore | ||||
| """Return a list of tags ordered by revision.""" | """Return a list of tags ordered by revision.""" | ||||
| def nodetags(node): | def nodetags(node): | ||||
| """Return the tags associated with a node.""" | """Return the tags associated with a node.""" | ||||
| def nodebookmarks(node): | def nodebookmarks(node): | ||||
| """Return the list of bookmarks pointing to the specified node.""" | """Return the list of bookmarks pointing to the specified node.""" | ||||
| def branchmap(): | def branchmap(): # type: ignore | ||||
| """Return a mapping of branch to heads in that branch.""" | """Return a mapping of branch to heads in that branch.""" | ||||
| def revbranchcache(): | def revbranchcache(): # type: ignore | ||||
| pass | pass | ||||
| def branchtip(branchtip, ignoremissing=False): | def branchtip(branchtip, ignoremissing=False): | ||||
| """Return the tip node for a given branch.""" | """Return the tip node for a given branch.""" | ||||
| def lookup(key): | def lookup(key): | ||||
| """Resolve the node for a revision.""" | """Resolve the node for a revision.""" | ||||
| def lookupbranch(key): | def lookupbranch(key): | ||||
| """Look up the branch name of the given revision or branch name.""" | """Look up the branch name of the given revision or branch name.""" | ||||
| def known(nodes): | def known(nodes): | ||||
| """Determine whether a series of nodes is known. | """Determine whether a series of nodes is known. | ||||
| Returns a list of bools. | Returns a list of bools. | ||||
| """ | """ | ||||
| def local(): | def local(): # type: ignore | ||||
| """Whether the repository is local.""" | """Whether the repository is local.""" | ||||
| return True | return True | ||||
| def publishing(): | def publishing(): # type: ignore | ||||
| """Whether the repository is a publishing repository.""" | """Whether the repository is a publishing repository.""" | ||||
| def cancopy(): | def cancopy(): # type: ignore | ||||
| pass | pass | ||||
| def shared(): | def shared(): # type: ignore | ||||
| """The type of shared repository or None.""" | """The type of shared repository or None.""" | ||||
| def wjoin(f, *insidef): | def wjoin(f, *insidef): | ||||
| """Calls self.vfs.reljoin(self.root, f, *insidef)""" | """Calls self.vfs.reljoin(self.root, f, *insidef)""" | ||||
| def setparents(p1, p2): | def setparents(p1, p2): | ||||
| """Set the parent nodes of the working directory.""" | """Set the parent nodes of the working directory.""" | ||||
| def filectx(path, changeid=None, fileid=None): | def filectx(path, changeid=None, fileid=None): | ||||
| """Obtain a filectx for the given file revision.""" | """Obtain a filectx for the given file revision.""" | ||||
| def getcwd(): | def getcwd(): # type: ignore | ||||
| """Obtain the current working directory from the dirstate.""" | """Obtain the current working directory from the dirstate.""" | ||||
| def pathto(f, cwd=None): | def pathto(f, cwd=None): | ||||
| """Obtain the relative path to a file.""" | """Obtain the relative path to a file.""" | ||||
| def adddatafilter(name, fltr): | def adddatafilter(name, fltr): | ||||
| pass | pass | ||||
| def wread(filename): | def wread(filename): | ||||
| """Read a file from wvfs, using data filters.""" | """Read a file from wvfs, using data filters.""" | ||||
| def wwrite(filename, data, flags, backgroundclose=False, **kwargs): | def wwrite(filename, data, flags, backgroundclose=False, **kwargs): | ||||
| """Write data to a file in the wvfs, using data filters.""" | """Write data to a file in the wvfs, using data filters.""" | ||||
| def wwritedata(filename, data): | def wwritedata(filename, data): | ||||
| """Resolve data for writing to the wvfs, using data filters.""" | """Resolve data for writing to the wvfs, using data filters.""" | ||||
| def currenttransaction(): | def currenttransaction(): # type: ignore | ||||
| """Obtain the current transaction instance or None.""" | """Obtain the current transaction instance or None.""" | ||||
| def transaction(desc, report=None): | def transaction(desc, report=None): | ||||
| """Open a new transaction to write to the repository.""" | """Open a new transaction to write to the repository.""" | ||||
| def undofiles(): | def undofiles(): # type: ignore | ||||
| """Returns a list of (vfs, path) for files to undo transactions.""" | """Returns a list of (vfs, path) for files to undo transactions.""" | ||||
| def recover(): | def recover(): # type: ignore | ||||
| """Roll back an interrupted transaction.""" | """Roll back an interrupted transaction.""" | ||||
| def rollback(dryrun=False, force=False): | def rollback(dryrun=False, force=False): | ||||
| """Undo the last transaction. | """Undo the last transaction. | ||||
| DANGEROUS. | DANGEROUS. | ||||
| """ | """ | ||||
| def updatecaches(tr=None, full=False): | def updatecaches(tr=None, full=False): | ||||
| """Warm repo caches.""" | """Warm repo caches.""" | ||||
| def invalidatecaches(): | def invalidatecaches(): # type: ignore | ||||
| """Invalidate cached data due to the repository mutating.""" | """Invalidate cached data due to the repository mutating.""" | ||||
| def invalidatevolatilesets(): | def invalidatevolatilesets(): # type: ignore | ||||
| pass | pass | ||||
| def invalidatedirstate(): | def invalidatedirstate(): # type: ignore | ||||
| """Invalidate the dirstate.""" | """Invalidate the dirstate.""" | ||||
| def invalidate(clearfilecache=False): | def invalidate(clearfilecache=False): | ||||
| pass | pass | ||||
| def invalidateall(): | def invalidateall(): # type: ignore | ||||
| pass | pass | ||||
| def lock(wait=True): | def lock(wait=True): | ||||
| """Lock the repository store and return a lock instance.""" | """Lock the repository store and return a lock instance.""" | ||||
| def wlock(wait=True): | def wlock(wait=True): | ||||
| """Lock the non-store parts of the repository.""" | """Lock the non-store parts of the repository.""" | ||||
| def currentwlock(): | def currentwlock(): # type: ignore | ||||
| """Return the wlock if it's held or None.""" | """Return the wlock if it's held or None.""" | ||||
| def checkcommitpatterns(wctx, vdirs, match, status, fail): | def checkcommitpatterns(wctx, vdirs, match, status, fail): | ||||
| pass | pass | ||||
| def commit(text='', user=None, date=None, match=None, force=False, | def commit(text='', user=None, date=None, match=None, force=False, | ||||
| editor=False, extra=None): | editor=False, extra=None): | ||||
| """Add a new revision to the repository.""" | """Add a new revision to the repository.""" | ||||
| def commitctx(ctx, error=False, origctx=None): | def commitctx(ctx, error=False, origctx=None): | ||||
| """Commit a commitctx instance to the repository.""" | """Commit a commitctx instance to the repository.""" | ||||
| def destroying(): | def destroying(): # type: ignore | ||||
| """Inform the repository that nodes are about to be destroyed.""" | """Inform the repository that nodes are about to be destroyed.""" | ||||
| def destroyed(): | def destroyed(): # type: ignore | ||||
| """Inform the repository that nodes have been destroyed.""" | """Inform the repository that nodes have been destroyed.""" | ||||
| def status(node1='.', node2=None, match=None, ignored=False, | def status(node1='.', node2=None, match=None, ignored=False, | ||||
| clean=False, unknown=False, listsubrepos=False): | clean=False, unknown=False, listsubrepos=False): | ||||
| """Convenience method to call repo[x].status().""" | """Convenience method to call repo[x].status().""" | ||||
| def addpostdsstatus(ps): | def addpostdsstatus(ps): | ||||
| pass | pass | ||||
| def postdsstatus(): | def postdsstatus(): # type: ignore | ||||
| pass | pass | ||||
| def clearpostdsstatus(): | def clearpostdsstatus(): # type: ignore | ||||
| pass | pass | ||||
| def heads(start=None): | def heads(start=None): | ||||
| """Obtain list of nodes that are DAG heads.""" | """Obtain list of nodes that are DAG heads.""" | ||||
| def branchheads(branch=None, start=None, closed=False): | def branchheads(branch=None, start=None, closed=False): | ||||
| pass | pass | ||||
| When caching objects, typically the encoded form of the object will | When caching objects, typically the encoded form of the object will | ||||
| be stored. Keep in mind that if the original object is forwarded to | be stored. Keep in mind that if the original object is forwarded to | ||||
| the output layer, it will need to be encoded there as well. For large | the output layer, it will need to be encoded there as well. For large | ||||
| output, this redundant encoding could add overhead. Implementations | output, this redundant encoding could add overhead. Implementations | ||||
| could wrap the encoded object data in ``wireprototypes.encodedresponse`` | could wrap the encoded object data in ``wireprototypes.encodedresponse`` | ||||
| instances to avoid this overhead. | instances to avoid this overhead. | ||||
| """ | """ | ||||
| def __enter__(): | def __enter__(): # type: ignore | ||||
| """Marks the instance as active. | """Marks the instance as active. | ||||
| Should return self. | Should return self. | ||||
| """ | """ | ||||
| def __exit__(exctype, excvalue, exctb): | def __exit__(exctype, excvalue, exctb): | ||||
| """Called when cacher is no longer used. | """Called when cacher is no longer used. | ||||
| instances may wish to prepend the repo name, introduce path | instances may wish to prepend the repo name, introduce path | ||||
| components for filesystem or URL addressing, etc. Behavior is up to | components for filesystem or URL addressing, etc. Behavior is up to | ||||
| the cache. | the cache. | ||||
| Returns a bool indicating if the request is cacheable by this | Returns a bool indicating if the request is cacheable by this | ||||
| instance. | instance. | ||||
| """ | """ | ||||
| def lookup(): | def lookup(): # type: ignore | ||||
| """Attempt to resolve an entry in the cache. | """Attempt to resolve an entry in the cache. | ||||
| The instance is instructed to look for the cache key that it was | The instance is instructed to look for the cache key that it was | ||||
| informed about via the call to ``setcachekey()``. | informed about via the call to ``setcachekey()``. | ||||
| If there's no cache hit or the cacher doesn't wish to use the cached | If there's no cache hit or the cacher doesn't wish to use the cached | ||||
| entry, ``None`` should be returned. | entry, ``None`` should be returned. | ||||
| Receives as its argument the object that was emitted from the | Receives as its argument the object that was emitted from the | ||||
| command function. | command function. | ||||
| This method returns an iterator of objects to forward to the output | This method returns an iterator of objects to forward to the output | ||||
| layer. The easiest implementation is a generator that just | layer. The easiest implementation is a generator that just | ||||
| ``yield obj``. | ``yield obj``. | ||||
| """ | """ | ||||
| def onfinished(): | def onfinished(): # type: ignore | ||||
| """Called after all objects have been emitted from the command function. | """Called after all objects have been emitted from the command function. | ||||
| Implementations should return an iterator of objects to forward to | Implementations should return an iterator of objects to forward to | ||||
| the output layer. | the output layer. | ||||
| This method can be a generator. | This method can be a generator. | ||||
| """ | """ | ||||