mercurial-scm/hg-stable: mercurial/interfaces/repository.py annotate

annotate mercurial/interfaces/repository.py @ 52739:0f2268783c11

clone: explicitly steal lock instead of assigning previous lock The issue with reusing the lock from another repository is that various internal state are no longer correct, the main example of that is the dirstate, captured in the wlock to make sure it is written (when needed) on lock release. So instead, we create a proper lock from the repository, but "stealing" the on-disk lock from the previous object. This is a bit weird, but less than the previous situation.

author	Pierre-Yves David <pierre-yves.david@octobus.net>
date	Thu, 30 Jan 2025 09:23:16 +0100
parents	f19a3f1437f3
children	5c48fd4c0e68

rev	line source
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1 # repository.py - Interfaces and base classes for repositories and peers.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	2 #
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3 # Copyright 2017 Gregory Szorc <gregory.szorc@gmail.com>
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	4 #
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	5 # This software may be used and distributed according to the terms of the
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 # GNU General Public License version 2 or any later version.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	7
51901 f4733654f144 typing: add `from __future__ import annotations` to most files Matt Harbison <matt_harbison@yahoo.com> parents: 51837 diff changeset	8 from __future__ import annotations
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	9
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	10 import abc
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	11 import typing
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	12
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	13 from typing import (
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	14 Any,
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	15 Callable,
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	16 Collection,
52516 3daaa5195a30 typing: align the signatures of `repository.ifilestorage` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52515 diff changeset	17 Iterable,
3daaa5195a30 typing: align the signatures of `repository.ifilestorage` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52515 diff changeset	18 Iterator,
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	19 Mapping,
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	20 Protocol,
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	21 Set,
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	22 )
26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	23
42823 268662aac075 interfaces: create a new folder for interfaces and move repository.py in it Pulkit Goyal <pulkit@yandex-team.ru> parents: 42795 diff changeset	24 from ..i18n import _
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	25 from .. import error
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	26
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	27 if typing.TYPE_CHECKING:
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	28 from typing import (
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	29 ByteString, # TODO: change to Buffer for 3.14
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	30 )
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	31
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	32 # Almost all mercurial modules are only imported in the type checking phase
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	33 # to avoid circular imports
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	34 from .. import (
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	35 match as matchmod,
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	36 pathutil,
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	37 util,
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	38 )
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	39 from ..utils import (
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	40 urlutil,
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	41 )
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	42
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	43 from . import dirstate as intdirstate
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	44
52507 d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	45 # TODO: make a protocol class for this
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	46 NodeConstants = Any
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	47
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	48 # TODO: create a Protocol class, since importing uimod here causes a cycle
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	49 # that confuses pytype.
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	50 Ui = Any
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	51
52507 d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	52 # TODO: make a protocol class for this
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	53 Vfs = Any
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	54
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	55 # Local repository feature string.
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	56
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	57 # Revlogs are being used for file storage.
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	58 REPO_FEATURE_REVLOG_FILE_STORAGE = b'revlogfilestorage'
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	59 # The storage part of the repository is shared from an external source.
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	60 REPO_FEATURE_SHARED_STORAGE = b'sharedstore'
39856 1f7b3b980af8 lfs: add repository feature denoting the use of LFS Gregory Szorc <gregory.szorc@gmail.com> parents: 39855 diff changeset	61 # LFS supported for backing file storage.
1f7b3b980af8 lfs: add repository feature denoting the use of LFS Gregory Szorc <gregory.szorc@gmail.com> parents: 39855 diff changeset	62 REPO_FEATURE_LFS = b'lfs'
40028 83146d176c03 localrepo: add repository feature when repo can be stream cloned Gregory Szorc <gregory.szorc@gmail.com> parents: 40022 diff changeset	63 # Repository supports being stream cloned.
83146d176c03 localrepo: add repository feature when repo can be stream cloned Gregory Szorc <gregory.szorc@gmail.com> parents: 40022 diff changeset	64 REPO_FEATURE_STREAM_CLONE = b'streamclone'
47237 19d4802cb304 sidedata: add a 'side-data' repository feature and use it Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47160 diff changeset	65 # Repository supports (at least) some sidedata to be stored
19d4802cb304 sidedata: add a 'side-data' repository feature and use it Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47160 diff changeset	66 REPO_FEATURE_SIDE_DATA = b'side-data'
40390 7e3b6c4f01a2 localrepo: support marking repos as having shallow file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 40389 diff changeset	67 # Files storage may lack data for all ancestors.
7e3b6c4f01a2 localrepo: support marking repos as having shallow file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 40389 diff changeset	68 REPO_FEATURE_SHALLOW_FILE_STORAGE = b'shallowfilestorage'
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	69
40048 8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	70 REVISION_FLAG_CENSORED = 1 << 15
8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	71 REVISION_FLAG_ELLIPSIS = 1 << 14
8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	72 REVISION_FLAG_EXTSTORED = 1 << 13
47094 119790e1c67c cg4: introduce protocol flag to signify the presence of sidedata Rapha?l Gom?s <rgomes@octobus.net> parents: 46793 diff changeset	73 REVISION_FLAG_HASCOPIESINFO = 1 << 12
40048 8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	74
8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	75 REVISION_FLAGS_KNOWN = (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	76 REVISION_FLAG_CENSORED
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	77 \| REVISION_FLAG_ELLIPSIS
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	78 \| REVISION_FLAG_EXTSTORED
45671 2d6aea053153 copies: add a HASCOPIESINFO flag to highlight rev with useful data Pierre-Yves David <pierre-yves.david@octobus.net> parents: 45392 diff changeset	79 \| REVISION_FLAG_HASCOPIESINFO
43032 a12a9af7536c sidedata: add a new revision flag constant for side data Pierre-Yves David <pierre-yves.david@octobus.net> parents: 42824 diff changeset	80 )
40048 8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	81
40495 59a870a4ad6e changegroup: refactor emitrevision to use a `deltamode` argument Boris Feld <boris.feld@octobus.net> parents: 40390 diff changeset	82 CG_DELTAMODE_STD = b'default'
59a870a4ad6e changegroup: refactor emitrevision to use a `deltamode` argument Boris Feld <boris.feld@octobus.net> parents: 40390 diff changeset	83 CG_DELTAMODE_PREV = b'previous'
59a870a4ad6e changegroup: refactor emitrevision to use a `deltamode` argument Boris Feld <boris.feld@octobus.net> parents: 40390 diff changeset	84 CG_DELTAMODE_FULL = b'fulltext'
40497 968dd7e02ac5 changegroup: allow to force delta to be against p1 Boris Feld <boris.feld@octobus.net> parents: 40496 diff changeset	85 CG_DELTAMODE_P1 = b'p1'
40495 59a870a4ad6e changegroup: refactor emitrevision to use a `deltamode` argument Boris Feld <boris.feld@octobus.net> parents: 40390 diff changeset	86
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	87
47307 d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	88 ## Cache related constants:
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	89 #
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	90 # Used to control which cache should be warmed in a repo.updatecaches(…) call.
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	91
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	92 # Warm branchmaps of all known repoview's filter-level
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	93 CACHE_BRANCHMAP_ALL = b"branchmap-all"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	94 # Warm branchmaps of repoview's filter-level used by server
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	95 CACHE_BRANCHMAP_SERVED = b"branchmap-served"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	96 # Warm internal changelog cache (eg: persistent nodemap)
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	97 CACHE_CHANGELOG_CACHE = b"changelog-cache"
51579 4a8bb136ee77 branchcache: allow to detect "pure topological case" for branchmap Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51052 diff changeset	98 # check of a branchmap can use the "pure topo" mode
4a8bb136ee77 branchcache: allow to detect "pure topological case" for branchmap Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51052 diff changeset	99 CACHE_BRANCHMAP_DETECT_PURE_TOPO = b"branchmap-detect-pure-topo"
47307 d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	100 # Warm full manifest cache
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	101 CACHE_FULL_MANIFEST = b"full-manifest"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	102 # Warm file-node-tags cache
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	103 CACHE_FILE_NODE_TAGS = b"file-node-tags"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	104 # Warm internal manifestlog cache (eg: persistent nodemap)
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	105 CACHE_MANIFESTLOG_CACHE = b"manifestlog-cache"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	106 # Warn rev branch cache
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	107 CACHE_REV_BRANCH = b"rev-branch-cache"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	108 # Warm tags' cache for default repoview'
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	109 CACHE_TAGS_DEFAULT = b"tags-default"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	110 # Warm tags' cache for repoview's filter-level used by server
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	111 CACHE_TAGS_SERVED = b"tags-served"
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	112
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	113 # the cache to warm by default after a simple transaction
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	114 # (this is a mutable set to let extension update it)
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	115 CACHES_DEFAULT = {
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	116 CACHE_BRANCHMAP_SERVED,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	117 }
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	118
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	119 # the caches to warm when warming all of them
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	120 # (this is a mutable set to let extension update it)
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	121 CACHES_ALL = {
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	122 CACHE_BRANCHMAP_SERVED,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	123 CACHE_BRANCHMAP_ALL,
51579 4a8bb136ee77 branchcache: allow to detect "pure topological case" for branchmap Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51052 diff changeset	124 CACHE_BRANCHMAP_DETECT_PURE_TOPO,
51946 e51161b12c7e rev-branch-cache: have debugupdatecache warm rbc too Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51909 diff changeset	125 CACHE_REV_BRANCH,
47307 d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	126 CACHE_CHANGELOG_CACHE,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	127 CACHE_FILE_NODE_TAGS,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	128 CACHE_FULL_MANIFEST,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	129 CACHE_MANIFESTLOG_CACHE,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	130 CACHE_TAGS_DEFAULT,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	131 CACHE_TAGS_SERVED,
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	132 }
d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	133
47310 7edaf91c7886 updatecaches: use the `caches` argument instead of a special `full` value Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47307 diff changeset	134 # the cache to warm by default on simple call
7edaf91c7886 updatecaches: use the `caches` argument instead of a special `full` value Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47307 diff changeset	135 # (this is a mutable set to let extension update it)
7edaf91c7886 updatecaches: use the `caches` argument instead of a special `full` value Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47307 diff changeset	136 CACHES_POST_CLONE = CACHES_ALL.copy()
7edaf91c7886 updatecaches: use the `caches` argument instead of a special `full` value Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47307 diff changeset	137 CACHES_POST_CLONE.discard(CACHE_FILE_NODE_TAGS)
52211 d57d1606049c clone: properly exclude rev-branch-cache from post clone cache warming Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51946 diff changeset	138 CACHES_POST_CLONE.discard(CACHE_REV_BRANCH)
47310 7edaf91c7886 updatecaches: use the `caches` argument instead of a special `full` value Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47307 diff changeset	139
47307 d1589957fdcb updatecaches: introduce a set of constants to control which are updated Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47237 diff changeset	140
52493 73a46cef57c9 interfaces: rename `repository.ipeerconnection` to reflect it being private Matt Harbison <matt_harbison@yahoo.com> parents: 52492 diff changeset	141 class _ipeerconnection(Protocol):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	142 """Represents a "connection" to a repository.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	143
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	144 This is the base interface for representing a connection to a repository.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	145 It holds basic properties and methods applicable to all peer types.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	146
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	147 This is not a complete interface definition and should not be used
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	148 outside of this module.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	149 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	150
52492 0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	151 ui: Ui
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	152 """ui.ui instance"""
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	153
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	154 path: urlutil.path \| None
0cfcc276b796 interfaces: convert `repository.ipeerconnection` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52491 diff changeset	155 """a urlutil.path instance or None"""
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	156
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	157 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	158 def url(self):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	159 """Returns a URL string representing this peer.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	160
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	161 Currently, implementations expose the raw URL used to construct the
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	162 instance. It may contain credentials as part of the URL. The
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	163 expectations of the value aren't well-defined and this could lead to
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	164 data leakage.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	165
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	166 TODO audit/clean consumers and more clearly define the contents of this
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	167 value.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	168 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	169
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	170 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	171 def local(self):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	172 """Returns a local repository instance.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	173
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	174 If the peer represents a local repository, returns an object that
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	175 can be used to interface with it. Otherwise returns ``None``.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	176 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	177
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	178 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	179 def canpush(self):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	180 """Returns a boolean indicating if this peer can be pushed to."""
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	181
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	182 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	183 def close(self):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	184 """Close the connection to this peer.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	185
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	186 This is called when the peer will no longer be used. Resources
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	187 associated with the peer should be cleaned up.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	188 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	189
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	190
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	191 class ipeercapabilities(Protocol):
37610 98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	192 """Peer sub-interface related to capabilities."""
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	193
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	194 @abc.abstractmethod
52545 5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	195 def capable(self, name: bytes) -> bool \| bytes:
37610 98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	196 """Determine support for a named capability.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	197
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	198 Returns ``False`` if capability not supported.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	199
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	200 Returns ``True`` if boolean capability is supported. Returns a string
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	201 if capability support is non-boolean.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	202
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	203 Capability strings may or may not map to wire protocol capabilities.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	204 """
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	205
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	206 @abc.abstractmethod
52548 b52f2b365eff typing: add type hints to `ipeercapabilities.capabilities()` Matt Harbison <matt_harbison@yahoo.com> parents: 52547 diff changeset	207 def capabilities(self) -> Set[bytes]:
52547 1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	208 """Obtain capabilities of the peer.
1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	209
1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	210 Returns a set of string capabilities.
1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	211 """
1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	212
1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	213 @abc.abstractmethod
52545 5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	214 def requirecap(self, name: bytes, purpose: bytes) -> None:
37610 98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	215 """Require a capability to be present.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	216
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	217 Raises a ``CapabilityError`` if the capability isn't present.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	218 """
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	219
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	220
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	221 class ipeercommands(Protocol):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	222 """Client-side interface for communicating over the wire protocol.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	223
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	224 This interface is used as a gateway to the Mercurial wire protocol.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	225 methods commonly call wire protocol commands of the same name.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	226 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	227
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	228 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	229 def branchmap(self):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	230 """Obtain heads in named branches.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	231
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	232 Returns a dict mapping branch name to an iterable of nodes that are
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	233 heads on that branch.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	234 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	235
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	236 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	237 def get_cached_bundle_inline(self, path):
50699 2aaabd8f4471 clone-bundle: rename the methods and wireprotole command Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50675 diff changeset	238 """Retrieve a clonebundle across the wire.
50675 60f9602b413e clonebundles: add support for inline (streaming) clonebundles Mathias De Mare <mathias.de_mare@nokia.com> parents: 50667 diff changeset	239
60f9602b413e clonebundles: add support for inline (streaming) clonebundles Mathias De Mare <mathias.de_mare@nokia.com> parents: 50667 diff changeset	240 Returns a chunkbuffer
60f9602b413e clonebundles: add support for inline (streaming) clonebundles Mathias De Mare <mathias.de_mare@nokia.com> parents: 50667 diff changeset	241 """
60f9602b413e clonebundles: add support for inline (streaming) clonebundles Mathias De Mare <mathias.de_mare@nokia.com> parents: 50667 diff changeset	242
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	243 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	244 def clonebundles(self):
37649 a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	245 """Obtains the clone bundles manifest for the repo.
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	246
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	247 Returns the manifest as unparsed bytes.
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	248 """
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	249
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	250 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	251 def debugwireargs(self, one, two, three=None, four=None, five=None):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	252 """Used to facilitate debugging of arguments passed over the wire."""
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	253
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	254 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	255 def getbundle(self, source, **kwargs):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	256 """Obtain remote repository data as a bundle.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	257
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	258 This command is how the bulk of repository data is transferred from
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	259 the peer to the local repository
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	260
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	261 Returns a generator of bundle data.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	262 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	263
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	264 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	265 def heads(self):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	266 """Determine all known head revisions in the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	267
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	268 Returns an iterable of binary nodes.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	269 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	270
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	271 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	272 def known(self, nodes):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	273 """Determine whether multiple nodes are known.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	274
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	275 Accepts an iterable of nodes whose presence to check for.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	276
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	277 Returns an iterable of booleans indicating of the corresponding node
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	278 at that index is known to the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	279 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	280
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	281 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	282 def listkeys(self, namespace):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	283 """Obtain all keys in a pushkey namespace.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	284
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	285 Returns an iterable of key names.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	286 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	287
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	288 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	289 def lookup(self, key):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	290 """Resolve a value to a known revision.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	291
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	292 Returns a binary node of the resolved revision on success.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	293 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	294
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	295 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	296 def pushkey(self, namespace, key, old, new):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	297 """Set a value using the ``pushkey`` protocol.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	298
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	299 Arguments correspond to the pushkey namespace and key to operate on and
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	300 the old and new values for that key.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	301
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	302 Returns a string with the peer result. The value inside varies by the
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	303 namespace.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	304 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	305
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	306 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	307 def stream_out(self):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	308 """Obtain streaming clone data.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	309
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	310 Successful result should be a generator of data chunks.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	311 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	312
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	313 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	314 def unbundle(self, bundle, heads, url):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	315 """Transfer repository data to the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	316
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	317 This is how the bulk of data during a push is transferred.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	318
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	319 Returns the integer number of heads added to the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	320 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	321
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	322
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	323 class ipeerlegacycommands(Protocol):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	324 """Interface for implementing support for legacy wire protocol commands.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	325
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	326 Wire protocol commands transition to legacy status when they are no longer
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	327 used by modern clients. To facilitate identifying which commands are
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	328 legacy, the interfaces are split.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	329 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	330
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	331 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	332 def between(self, pairs):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	333 """Obtain nodes between pairs of nodes.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	334
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	335 ``pairs`` is an iterable of node pairs.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	336
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	337 Returns an iterable of iterables of nodes corresponding to each
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	338 requested pair.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	339 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	340
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	341 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	342 def branches(self, nodes):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	343 """Obtain ancestor changesets of specific nodes back to a branch point.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	344
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	345 For each requested node, the peer finds the first ancestor node that is
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	346 a DAG root or is a merge.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	347
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	348 Returns an iterable of iterables with the resolved values for each node.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	349 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	350
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	351 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	352 def changegroup(self, nodes, source):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	353 """Obtain a changegroup with data for descendants of specified nodes."""
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	354
52526 61f70a6ab645 wirepeer: subclass new `repository.ipeer{,legacy}commands` Proctocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52525 diff changeset	355 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	356 def changegroupsubset(self, bases, heads, source):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	357 pass
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	358
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	359
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	360 class ipeercommandexecutor(Protocol):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	361 """Represents a mechanism to execute remote commands.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	362
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	363 This is the primary interface for requesting that wire protocol commands
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	364 be executed. Instances of this interface are active in a context manager
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	365 and have a well-defined lifetime. When the context manager exits, all
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	366 outstanding requests are waited on.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	367 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	368
52525 e123c8a26a70 localrepo: subclass the new `repository.ipeercommandexecutor` Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52522 diff changeset	369 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	370 def callcommand(self, name, args):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	371 """Request that a named command be executed.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	372
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	373 Receives the command name and a dictionary of command arguments.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	374
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	375 Returns a ``concurrent.futures.Future`` that will resolve to the
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	376 result of that command request. That exact value is left up to
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	377 the implementation and possibly varies by command.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	378
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	379 Not all commands can coexist with other commands in an executor
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	380 instance: it depends on the underlying wire protocol transport being
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	381 used and the command itself.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	382
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	383 Implementations MAY call ``sendcommands()`` automatically if the
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	384 requested command can not coexist with other commands in this executor.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	385
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	386 Implementations MAY call ``sendcommands()`` automatically when the
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	387 future's ``result()`` is called. So, consumers using multiple
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	388 commands with an executor MUST ensure that ``result()`` is not called
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	389 until all command requests have been issued.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	390 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	391
52525 e123c8a26a70 localrepo: subclass the new `repository.ipeercommandexecutor` Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52522 diff changeset	392 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	393 def sendcommands(self):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	394 """Trigger submission of queued command requests.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	395
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	396 Not all transports submit commands as soon as they are requested to
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	397 run. When called, this method forces queued command requests to be
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	398 issued. It will no-op if all commands have already been sent.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	399
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	400 When called, no more new commands may be issued with this executor.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	401 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	402
52525 e123c8a26a70 localrepo: subclass the new `repository.ipeercommandexecutor` Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52522 diff changeset	403 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	404 def close(self):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	405 """Signal that this command request is finished.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	406
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	407 When called, no more new commands may be issued. All outstanding
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	408 commands that have previously been issued are waited on before
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	409 returning. This not only includes waiting for the futures to resolve,
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	410 but also waiting for all response data to arrive. In other words,
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	411 calling this waits for all on-wire state for issued command requests
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	412 to finish.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	413
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	414 When used as a context manager, this method is called when exiting the
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	415 context manager.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	416
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	417 This method may call ``sendcommands()`` if there are buffered commands.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	418 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	419
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	420
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	421 class ipeerrequests(Protocol):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	422 """Interface for executing commands on a peer."""
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	423
52494 4cc186255672 interfaces: convert `repository.ipeerrequests` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52493 diff changeset	424 limitedarguments: bool
4cc186255672 interfaces: convert `repository.ipeerrequests` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52493 diff changeset	425 """True if the peer cannot receive large argument value for commands."""
42200 69921d02daaf peer: introduce a limitedarguments attributes Pierre-Yves David <pierre-yves.david@octobus.net> parents: 41340 diff changeset	426
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	427 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	428 def commandexecutor(self):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	429 """A context manager that resolves to an ipeercommandexecutor.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	430
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	431 The object this resolves to can be used to issue command requests
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	432 to the peer.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	433
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	434 Callers should call its ``callcommand`` method to issue command
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	435 requests.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	436
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	437 A new executor should be obtained for each distinct set of commands
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	438 (possibly just a single command) that the consumer wants to execute
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	439 as part of a single operation or round trip. This is because some
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	440 peers are half-duplex and/or don't support persistent connections.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	441 e.g. in the case of HTTP peers, commands sent to an executor represent
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	442 a single HTTP request. While some peers may support multiple command
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	443 sends over the wire per executor, consumers need to code to the least
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	444 capable peer. So it should be assumed that command executors buffer
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	445 called commands until they are told to send them and that each
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	446 command executor could result in a new connection or wire-level request
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	447 being issued.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	448 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	449
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	450
52533 199b0e62b403 interfaces: make the `peer` mixin not a Protocol to fix Python 3.10 failures Matt Harbison <matt_harbison@yahoo.com> parents: 52529 diff changeset	451 # TODO: make this a Protocol class when 3.11 is the minimum supported version?
199b0e62b403 interfaces: make the `peer` mixin not a Protocol to fix Python 3.10 failures Matt Harbison <matt_harbison@yahoo.com> parents: 52529 diff changeset	452 class peer(_ipeerconnection, ipeercapabilities, ipeerrequests):
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	453 """Unified interface for peer repositories.
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	454
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	455 All peer instances must conform to this interface.
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	456 """
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	457
52495 1df97507c6b8 interfaces: convert `repository.peer` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52494 diff changeset	458 limitedarguments: bool = False
52545 5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	459 path: urlutil.path \| None
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	460 ui: Ui
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	461
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	462 def __init__(
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	463 self,
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	464 ui: Ui,
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	465 path: urlutil.path \| None = None,
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	466 remotehidden: bool = False,
5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	467 ) -> None:
49863 a6e2a668c746 peer: have a common constructor and use it Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49860 diff changeset	468 self.ui = ui
49864 611ccb631cbc peer: add a `path` attribute to peer Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49863 diff changeset	469 self.path = path
49863 a6e2a668c746 peer: have a common constructor and use it Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49860 diff changeset	470
52545 5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	471 def capable(self, name: bytes) -> bool \| bytes:
52547 1554bd50a1af interfaces: move peer `capabilities()` to the `ipeercapabilities` interface Matt Harbison <matt_harbison@yahoo.com> parents: 52545 diff changeset	472 caps = self.capabilities()
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	473 if name in caps:
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	474 return True
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	475
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	476 name = b'%s=' % name
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	477 for cap in caps:
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	478 if cap.startswith(name):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	479 return cap[len(name) :]
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	480
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	481 return False
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	482
52545 5a924cb07768 typing: add annotations to the `repository.peer` mixin class Matt Harbison <matt_harbison@yahoo.com> parents: 52533 diff changeset	483 def requirecap(self, name: bytes, purpose: bytes) -> None:
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	484 if self.capable(name):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	485 return
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	486
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	487 raise error.CapabilityError(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	488 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	489 b'cannot %s; remote repository does not support the '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	490 b'\'%s\' capability'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	491 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	492 % (purpose, name)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	493 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	494
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	495
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	496 class iverifyproblem(Protocol):
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	497 """Represents a problem with the integrity of the repository.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	498
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	499 Instances of this interface are emitted to describe an integrity issue
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	500 with a repository (e.g. corrupt storage, missing data, etc).
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	501
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	502 Instances are essentially messages associated with severity.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	503 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	504
52496 f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	505 warning: bytes \| None
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	506 """Message indicating a non-fatal problem."""
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	507
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	508 error: bytes \| None
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	509 """Message indicating a fatal problem."""
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	510
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	511 node: bytes \| None
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	512 """Revision encountering the problem.
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	513
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	514 ``None`` means the problem doesn't apply to a single revision.
f968926a4207 interfaces: convert `repository.iverifyproblem` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52495 diff changeset	515 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	516
39877 733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	517
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	518 class irevisiondelta(Protocol):
39258 b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	519 """Represents a delta between one revision and another.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	520
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	521 Instances convey enough information to allow a revision to be exchanged
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	522 with another repository.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	523
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	524 Instances represent the fulltext revision data or a delta against
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	525 another revision. Therefore the ``revision`` and ``delta`` attributes
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	526 are mutually exclusive.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	527
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	528 Typically used for changegroup generation.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	529 """
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	530
52498 2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	531 node: bytes
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	532 """20 byte node of this revision."""
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	533
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	534 p1node: bytes
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	535 """20 byte node of 1st parent of this revision."""
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	536
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	537 p2node: bytes
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	538 """20 byte node of 2nd parent of this revision."""
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	539
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	540 # TODO: is this really optional? revlog.revlogrevisiondelta defaults to None
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	541 linknode: bytes \| None
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	542 """20 byte node of the changelog revision this node is linked to."""
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	543
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	544 flags: int
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	545 """2 bytes of integer flags that apply to this revision.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	546
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	547 This is a bitwise composition of the ``REVISION_FLAG_*`` constants.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	548 """
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	549
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	550 basenode: bytes
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	551 """20 byte node of the revision this data is a delta against.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	552
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	553 ``nullid`` indicates that the revision is a full revision and not
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	554 a delta.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	555 """
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	556
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	557 baserevisionsize: int \| None
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	558 """Size of base revision this delta is against.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	559
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	560 May be ``None`` if ``basenode`` is ``nullid``.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	561 """
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	562
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	563 # TODO: is this really optional? (Seems possible in
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	564 # storageutil.emitrevisions()).
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	565 revision: bytes \| None
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	566 """Raw fulltext of revision data for this node."""
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	567
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	568 delta: bytes \| None
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	569 """Delta between ``basenode`` and ``node``.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	570
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	571 Stored in the bdiff delta format.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	572 """
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	573
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	574 sidedata: bytes \| None
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	575 """Raw sidedata bytes for the given revision."""
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	576
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	577 protocol_flags: int
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	578 """Single byte of integer flags that can influence the protocol.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	579
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	580 This is a bitwise composition of the ``storageutil.CG_FLAG*`` constants.
2aada52e80d6 interfaces: convert `repository.irevisiondelta` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52496 diff changeset	581 """
47094 119790e1c67c cg4: introduce protocol flag to signify the presence of sidedata Rapha?l Gom?s <rgomes@octobus.net> parents: 46793 diff changeset	582
39258 b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	583
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	584 class ifilerevisionssequence(Protocol):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	585 """Contains index data for all revisions of a file.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	586
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	587 Types implementing this behave like lists of tuples. The index
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	588 in the list corresponds to the revision number. The values contain
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	589 index metadata.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	590
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	591 The null revision (revision number -1) is always the last item
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	592 in the index.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	593 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	594
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	595 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	596 def __len__(self):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	597 """The total number of revisions."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	598
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	599 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	600 def __getitem__(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	601 """Returns the object having a specific revision number.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	602
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	603 Returns an 8-tuple with the following fields:
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	604
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	605 offset+flags
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	606 Contains the offset and flags for the revision. 64-bit unsigned
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	607 integer where first 6 bytes are the offset and the next 2 bytes
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	608 are flags. The offset can be 0 if it is not used by the store.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	609 compressed size
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	610 Size of the revision data in the store. It can be 0 if it isn't
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	611 needed by the store.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	612 uncompressed size
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	613 Fulltext size. It can be 0 if it isn't needed by the store.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	614 base revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	615 Revision number of revision the delta for storage is encoded
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	616 against. -1 indicates not encoded against a base revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	617 link revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	618 Revision number of changelog revision this entry is related to.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	619 p1 revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	620 Revision number of 1st parent. -1 if no 1st parent.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	621 p2 revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	622 Revision number of 2nd parent. -1 if no 1st parent.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	623 node
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	624 Binary node value for this revision number.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	625
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	626 Negative values should index off the end of the sequence. ``-1``
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	627 should return the null revision. ``-2`` should return the most
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	628 recent revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	629 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	630
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	631 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	632 def __contains__(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	633 """Whether a revision number exists."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	634
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	635 @abc.abstractmethod
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	636 def insert(self, i, entry):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	637 """Add an item to the index at specific revision."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	638
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	639
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	640 class ifileindex(Protocol):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	641 """Storage interface for index data of a single file.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	642
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	643 File storage data is divided into index metadata and data storage.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	644 This interface defines the index portion of the interface.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	645
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	646 The index logically consists of:
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	647
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	648 * A mapping between revision numbers and nodes.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	649 * DAG data (storing and querying the relationship between nodes).
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	650 * Metadata to facilitate storage.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	651 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	652
52501 0d4ead4d88bd interfaces: convert `repository.ifileindex` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52498 diff changeset	653 nullid: bytes
0d4ead4d88bd interfaces: convert `repository.ifileindex` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52498 diff changeset	654 """node for the null revision for use as delta base."""
46793 6266d19556ad node: introduce nodeconstants class Joerg Sonnenberger <joerg@bec.de> parents: 46726 diff changeset	655
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	656 @abc.abstractmethod
52516 3daaa5195a30 typing: align the signatures of `repository.ifilestorage` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52515 diff changeset	657 def __len__(self) -> int:
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	658 """Obtain the number of revisions stored for this file."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	659
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	660 @abc.abstractmethod
52516 3daaa5195a30 typing: align the signatures of `repository.ifilestorage` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52515 diff changeset	661 def __iter__(self) -> Iterator[int]:
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	662 """Iterate over revision numbers for this file."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	663
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	664 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	665 def hasnode(self, node):
40387 f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	666 """Returns a bool indicating if a node is known to this store.
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	667
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	668 Implementations must only return True for full, binary node values:
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	669 hex nodes, revision numbers, and partial node matches must be
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	670 rejected.
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	671
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	672 The null node is never present.
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	673 """
f1a39128da95 filelog: add a hasnode() method (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 40279 diff changeset	674
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	675 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	676 def revs(self, start=0, stop=None):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	677 """Iterate over revision numbers for this file, with control."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	678
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	679 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	680 def parents(self, node):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	681 """Returns a 2-tuple of parent nodes for a revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	682
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	683 Values will be ``nullid`` if the parent is empty.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	684 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	685
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	686 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	687 def parentrevs(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	688 """Like parents() but operates on revision numbers."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	689
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	690 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	691 def rev(self, node):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	692 """Obtain the revision number given a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	693
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	694 Raises ``error.LookupError`` if the node is not known.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	695 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	696
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	697 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	698 def node(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	699 """Obtain the node value given a revision number.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	700
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	701 Raises ``IndexError`` if the node is not known.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	702 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	703
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	704 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	705 def lookup(self, node):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	706 """Attempt to resolve a value to a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	707
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	708 Value can be a binary node, hex node, revision number, or a string
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	709 that can be converted to an integer.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	710
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	711 Raises ``error.LookupError`` if a node could not be resolved.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	712 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	713
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	714 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	715 def linkrev(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	716 """Obtain the changeset revision number a revision is linked to."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	717
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	718 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	719 def iscensored(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	720 """Return whether a revision's content has been censored."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	721
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	722 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	723 def commonancestorsheads(self, node1, node2):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	724 """Obtain an iterable of nodes containing heads of common ancestors.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	725
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	726 See ``ancestor.commonancestorsheads()``.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	727 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	728
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	729 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	730 def descendants(self, revs):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	731 """Obtain descendant revision numbers for a set of revision numbers.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	732
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	733 If ``nullrev`` is in the set, this is equivalent to ``revs()``.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	734 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	735
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	736 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	737 def heads(self, start=None, stop=None):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	738 """Obtain a list of nodes that are DAG heads, with control.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	739
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	740 The set of revisions examined can be limited by specifying
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	741 ``start`` and ``stop``. ``start`` is a node. ``stop`` is an
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	742 iterable of nodes. DAG traversal starts at earlier revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	743 ``start`` and iterates forward until any node in ``stop`` is
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	744 encountered.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	745 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	746
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	747 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	748 def children(self, node):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	749 """Obtain nodes that are children of a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	750
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	751 Returns a list of nodes.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	752 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	753
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	754
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	755 class ifiledata(Protocol):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	756 """Storage interface for data storage of a specific file.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	757
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	758 This complements ``ifileindex`` and provides an interface for accessing
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	759 data for a tracked file.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	760 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	761
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	762 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	763 def size(self, rev):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	764 """Obtain the fulltext size of file data.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	765
39880 d909c44d29e1 filelog: stop proxying rawsize() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39878 diff changeset	766 Any metadata is excluded from size measurements.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	767 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	768
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	769 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	770 def revision(self, node):
45961 464539c305aa formatting: drop a few extra double quotes in docstrings Matt Harbison <matt_harbison@yahoo.com> parents: 45957 diff changeset	771 """Obtain fulltext data for a node.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	772
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	773 By default, any storage transformations are applied before the data
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	774 is returned. If ``raw`` is True, non-raw storage transformations
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	775 are not applied.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	776
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	777 The fulltext data may contain a header containing metadata. Most
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	778 consumers should use ``read()`` to obtain the actual file data.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	779 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	780
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	781 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	782 def rawdata(self, node):
45957 89a2afe31e82 formating: upgrade to black 20.8b1 Augie Fackler <raf@durin42.com> parents: 45811 diff changeset	783 """Obtain raw data for a node."""
42744 bbe71b5afd02 rawdata: register the method for `ifiledata` Pierre-Yves David <pierre-yves.david@octobus.net> parents: 42740 diff changeset	784
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	785 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	786 def read(self, node):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	787 """Resolve file fulltext data.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	788
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	789 This is similar to ``revision()`` except any metadata in the data
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	790 headers is stripped.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	791 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	792
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	793 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	794 def renamed(self, node):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	795 """Obtain copy metadata for a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	796
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	797 Returns ``False`` if no copy metadata is stored or a 2-tuple of
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	798 (path, node) from which this revision was copied.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	799 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	800
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	801 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	802 def cmp(self, node, fulltext):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	803 """Compare fulltext to another revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	804
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	805 Returns True if the fulltext is different from what is stored.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	806
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	807 This takes copy metadata into account.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	808
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	809 TODO better document the copy metadata and censoring logic.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	810 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	811
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	812 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	813 def emitrevisions(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	814 self,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	815 nodes,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	816 nodesorder=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	817 revisiondata=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	818 assumehaveparentrevisions=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	819 deltamode=CG_DELTAMODE_STD,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	820 ):
39867 5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	821 """Produce ``irevisiondelta`` for revisions.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	822
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	823 Given an iterable of nodes, emits objects conforming to the
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	824 ``irevisiondelta`` interface that describe revisions in storage.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	825
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	826 This method is a generator.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	827
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	828 The input nodes may be unordered. Implementations must ensure that a
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	829 node's parents are emitted before the node itself. Transitively, this
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	830 means that a node may only be emitted once all its ancestors in
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	831 ``nodes`` have also been emitted.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	832
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	833 By default, emits "index" data (the ``node``, ``p1node``, and
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	834 ``p2node`` attributes). If ``revisiondata`` is set, revision data
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	835 will also be present on the emitted objects.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	836
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	837 With default argument values, implementations can choose to emit
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	838 either fulltext revision data or a delta. When emitting deltas,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	839 implementations must consider whether the delta's base revision
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	840 fulltext is available to the receiver.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	841
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	842 The base revision fulltext is guaranteed to be available if any of
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	843 the following are met:
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	844
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	845 * Its fulltext revision was emitted by this method call.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	846 * A delta for that revision was emitted by this method call.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	847 * ``assumehaveparentrevisions`` is True and the base revision is a
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	848 parent of the node.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	849
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	850 ``nodesorder`` can be used to control the order that revisions are
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	851 emitted. By default, revisions can be reordered as long as they are
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	852 in DAG topological order (see above). If the value is ``nodes``,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	853 the iteration order from ``nodes`` should be used. If the value is
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	854 ``storage``, then the native order from the backing storage layer
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	855 is used. (Not all storage layers will have strong ordering and behavior
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	856 of this mode is storage-dependent.) ``nodes`` ordering can force
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	857 revisions to be emitted before their ancestors, so consumers should
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	858 use it with care.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	859
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	860 The ``linknode`` attribute on the returned ``irevisiondelta`` may not
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	861 be set and it is the caller's responsibility to resolve it, if needed.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	862
40496 6a917075535a storage: also use `deltamode argument` for ifiledata Boris Feld <boris.feld@octobus.net> parents: 40495 diff changeset	863 If ``deltamode`` is CG_DELTAMODE_PREV and revision data is requested,
6a917075535a storage: also use `deltamode argument` for ifiledata Boris Feld <boris.feld@octobus.net> parents: 40495 diff changeset	864 all revision data should be emitted as deltas against the revision
6a917075535a storage: also use `deltamode argument` for ifiledata Boris Feld <boris.feld@octobus.net> parents: 40495 diff changeset	865 emitted just prior. The initial revision should be a delta against its
6a917075535a storage: also use `deltamode argument` for ifiledata Boris Feld <boris.feld@octobus.net> parents: 40495 diff changeset	866 1st parent.
39867 5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	867 """
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	868
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	869
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	870 class ifilemutation(Protocol):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	871 """Storage interface for mutation events of a tracked file."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	872
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	873 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	874 def add(self, filedata, meta, transaction, linkrev, p1, p2):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	875 """Add a new revision to the store.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	876
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	877 Takes file data, dictionary of metadata, a transaction, linkrev,
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	878 and parent nodes.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	879
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	880 Returns the node that was added.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	881
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	882 May no-op if a revision matching the supplied data is already stored.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	883 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	884
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	885 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	886 def addrevision(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	887 self,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	888 revisiondata,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	889 transaction,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	890 linkrev,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	891 p1,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	892 p2,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	893 node=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	894 flags=0,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	895 cachedelta=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	896 ):
46560 f7b61ad3c64a revlog: change addrevision to return the new revision, not node Joerg Sonnenberger <joerg@bec.de> parents: 46445 diff changeset	897 """Add a new revision to the store and return its number.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	898
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	899 This is similar to ``add()`` except it operates at a lower level.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	900
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	901 The data passed in already contains a metadata header, if any.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	902
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	903 ``node`` and ``flags`` can be used to define the expected node and
40048 8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	904 the flags to use with storage. ``flags`` is a bitwise value composed
8e398628a3f2 repository: define and use revision flag constants Gregory Szorc <gregory.szorc@gmail.com> parents: 40028 diff changeset	905 of the various ``REVISION_FLAG_*`` constants.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	906
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	907 ``add()`` is usually called when adding files from e.g. the working
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	908 directory. ``addrevision()`` is often called by ``add()`` and for
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	909 scenarios where revision data has already been computed, such as when
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	910 applying raw data from a peer repo.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	911 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	912
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	913 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	914 def addgroup(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	915 self,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	916 deltas,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	917 linkmapper,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	918 transaction,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	919 addrevisioncb=None,
45811 a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	920 duplicaterevisioncb=None,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	921 maybemissingparents=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	922 ):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	923 """Process a series of deltas for storage.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	924
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	925 ``deltas`` is an iterable of 7-tuples of
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	926 (node, p1, p2, linknode, deltabase, delta, flags) defining revisions
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	927 to add.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	928
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	929 The ``delta`` field contains ``mpatch`` data to apply to a base
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	930 revision, identified by ``deltabase``. The base node can be
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	931 ``nullid``, in which case the header from the delta can be ignored
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	932 and the delta used as the fulltext.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	933
46445 711ba0f1057e revlog: decouple caching from addrevision callback for addgroup Joerg Sonnenberger <joerg@bec.de> parents: 46443 diff changeset	934 ``alwayscache`` instructs the lower layers to cache the content of the
711ba0f1057e revlog: decouple caching from addrevision callback for addgroup Joerg Sonnenberger <joerg@bec.de> parents: 46443 diff changeset	935 newly added revision, even if it needs to be explicitly computed.
711ba0f1057e revlog: decouple caching from addrevision callback for addgroup Joerg Sonnenberger <joerg@bec.de> parents: 46443 diff changeset	936 This used to be the default when ``addrevisioncb`` was provided up to
711ba0f1057e revlog: decouple caching from addrevision callback for addgroup Joerg Sonnenberger <joerg@bec.de> parents: 46443 diff changeset	937 Mercurial 5.8.
711ba0f1057e revlog: decouple caching from addrevision callback for addgroup Joerg Sonnenberger <joerg@bec.de> parents: 46443 diff changeset	938
46561 7a93b7b3dc2d revlog: change addgroup callbacks to take revision numbers Joerg Sonnenberger <joerg@bec.de> parents: 46560 diff changeset	939 ``addrevisioncb`` should be called for each new rev as it is committed.
7a93b7b3dc2d revlog: change addgroup callbacks to take revision numbers Joerg Sonnenberger <joerg@bec.de> parents: 46560 diff changeset	940 ``duplicaterevisioncb`` should be called for all revs with a
7a93b7b3dc2d revlog: change addgroup callbacks to take revision numbers Joerg Sonnenberger <joerg@bec.de> parents: 46560 diff changeset	941 pre-existing node.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	942
40389 1b183edbb68e repository: teach addgroup() to receive data with missing parents Gregory Szorc <gregory.szorc@gmail.com> parents: 40387 diff changeset	943 ``maybemissingparents`` is a bool indicating whether the incoming
1b183edbb68e repository: teach addgroup() to receive data with missing parents Gregory Szorc <gregory.szorc@gmail.com> parents: 40387 diff changeset	944 data may reference parents/ancestor revisions that aren't present.
1b183edbb68e repository: teach addgroup() to receive data with missing parents Gregory Szorc <gregory.szorc@gmail.com> parents: 40387 diff changeset	945 This flag is set when receiving data into a "shallow" store that
1b183edbb68e repository: teach addgroup() to receive data with missing parents Gregory Szorc <gregory.szorc@gmail.com> parents: 40387 diff changeset	946 doesn't hold all history.
1b183edbb68e repository: teach addgroup() to receive data with missing parents Gregory Szorc <gregory.szorc@gmail.com> parents: 40387 diff changeset	947
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	948 Returns a list of nodes that were processed. A node will be in the list
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	949 even if it existed in the store previously.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	950 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	951
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	952 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	953 def censorrevision(self, tr, node, tombstone=b''):
39794 a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	954 """Remove the content of a single revision.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	955
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	956 The specified ``node`` will have its content purged from storage.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	957 Future attempts to access the revision data for this node will
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	958 result in failure.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	959
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	960 A ``tombstone`` message can optionally be stored. This message may be
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	961 displayed to users when they attempt to access the missing revision
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	962 data.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	963
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	964 Storage backends may have stored deltas against the previous content
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	965 in this revision. As part of censoring a revision, these storage
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	966 backends are expected to rewrite any internally stored deltas such
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	967 that they no longer reference the deleted content.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	968 """
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	969
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	970 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	971 def getstrippoint(self, minlink):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	972 """Find the minimum revision that must be stripped to strip a linkrev.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	973
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	974 Returns a 2-tuple containing the minimum revision number and a set
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	975 of all revisions numbers that would be broken by this strip.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	976
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	977 TODO this is highly revlog centric and should be abstracted into
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	978 a higher-level deletion API. ``repair.strip()`` relies on this.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	979 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	980
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	981 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	982 def strip(self, minlink, transaction):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	983 """Remove storage of items starting at a linkrev.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	984
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	985 This uses ``getstrippoint()`` to determine the first node to remove.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	986 Then it effectively truncates storage for all revisions after that.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	987
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	988 TODO this is highly revlog centric and should be abstracted into a
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	989 higher-level deletion API.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	990 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	991
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	992
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	993 class ifilestorage(ifileindex, ifiledata, ifilemutation, Protocol):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	994 """Complete storage interface for a single tracked file."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	995
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	996 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	997 def files(self):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	998 """Obtain paths that are backing storage for this file.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	999
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	1000 TODO this is used heavily by verify code and there should probably
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	1001 be a better API for that.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	1002 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	1003
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	1004 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1005 def storageinfo(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1006 self,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1007 exclusivefiles=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1008 sharedfiles=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1009 revisionscount=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1010 trackedsize=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1011 storedsize=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1012 ):
39874 14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1013 """Obtain information about storage for this file's data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1014
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1015 Returns a dict describing storage for this tracked path. The keys
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1016 in the dict map to arguments of the same. The arguments are bools
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1017 indicating whether to calculate and obtain that data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1018
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1019 exclusivefiles
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1020 Iterable of (vfs, path) describing files that are exclusively
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1021 used to back storage for this tracked path.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1022
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1023 sharedfiles
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1024 Iterable of (vfs, path) describing files that are used to back
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1025 storage for this tracked path. Those files may also provide storage
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1026 for other stored entities.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1027
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1028 revisionscount
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1029 Number of revisions available for retrieval.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1030
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1031 trackedsize
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1032 Total size in bytes of all tracked revisions. This is a sum of the
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1033 length of the fulltext of all revisions.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1034
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1035 storedsize
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1036 Total size in bytes used to store data for all tracked revisions.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1037 This is commonly less than ``trackedsize`` due to internal usage
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1038 of deltas rather than fulltext revisions.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1039
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1040 Not all storage backends may support all queries are have a reasonable
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1041 value to use. In that case, the value should be set to ``None`` and
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1042 callers are expected to handle this special value.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1043 """
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1044
52517 8c89e978375c interfaces: convert `repository.ifilestorage` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52516 diff changeset	1045 @abc.abstractmethod
52516 3daaa5195a30 typing: align the signatures of `repository.ifilestorage` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52515 diff changeset	1046 def verifyintegrity(self, state) -> Iterable[iverifyproblem]:
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1047 """Verifies the integrity of file storage.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1048
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1049 ``state`` is a dict holding state of the verifier process. It can be
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1050 used to communicate data between invocations of multiple storage
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1051 primitives.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1052
39877 733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	1053 If individual revisions cannot have their revision content resolved,
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	1054 the method is expected to set the ``skipread`` key to a set of nodes
44073 b9e174d4ed11 verify: allow the storage to signal when renames can be tested on `skipread` Matt Harbison <matt_harbison@yahoo.com> parents: 43751 diff changeset	1055 that encountered problems. If set, the method can also add the node(s)
b9e174d4ed11 verify: allow the storage to signal when renames can be tested on `skipread` Matt Harbison <matt_harbison@yahoo.com> parents: 43751 diff changeset	1056 to ``safe_renamed`` in order to indicate nodes that may perform the
b9e174d4ed11 verify: allow the storage to signal when renames can be tested on `skipread` Matt Harbison <matt_harbison@yahoo.com> parents: 43751 diff changeset	1057 rename checks with currently accessible data.
39877 733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	1058
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1059 The method yields objects conforming to the ``iverifyproblem``
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1060 interface.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1061 """
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	1062
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1063
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1064 class idirs(Protocol):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1065 """Interface representing a collection of directories from paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1066
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1067 This interface is essentially a derived data structure representing
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1068 directories from a collection of paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1069 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1070
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	1071 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1072 def addpath(self, path):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1073 """Add a path to the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1074
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1075 All directories in the path will be added to the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1076 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1077
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	1078 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1079 def delpath(self, path):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1080 """Remove a path from the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1081
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1082 If the removal was the last path in a particular directory, the
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1083 directory is removed from the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1084 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1085
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	1086 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1087 def __iter__(self):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1088 """Iterate over the directories in this collection of paths."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1089
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	1090 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1091 def __contains__(self, path):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1092 """Whether a specific directory is in this collection."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1093
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1094
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1095 class imanifestdict(Protocol):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1096 """Interface representing a manifest data structure.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1097
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1098 A manifest is effectively a dict mapping paths to entries. Each entry
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1099 consists of a binary node and extra flags affecting that entry.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1100 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1101
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1102 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1103 def __getitem__(self, key: bytes) -> bytes:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1104 """Returns the binary node value for a path in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1105
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1106 Raises ``KeyError`` if the path does not exist in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1107
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1108 Equivalent to ``self.find(path)[0]``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1109 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1110
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1111 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1112 def find(self, path: bytes) -> tuple[bytes, bytes]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1113 """Returns the entry for a path in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1114
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1115 Returns a 2-tuple of (node, flags).
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1116
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1117 Raises ``KeyError`` if the path does not exist in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1118 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1119
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1120 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1121 def __len__(self) -> int:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1122 """Return the number of entries in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1123
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1124 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1125 def __nonzero__(self) -> bool:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1126 """Returns True if the manifest has entries, False otherwise."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1127
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1128 __bool__ = __nonzero__
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1129
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1130 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1131 def set(self, path: bytes, node: bytes, flags: bytes) -> None:
51812 421c9b3f2f4e commit: set whole manifest entries at once (node with its associated flags) Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 51579 diff changeset	1132 """Define the node value and flags for a path in the manifest.
421c9b3f2f4e commit: set whole manifest entries at once (node with its associated flags) Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 51579 diff changeset	1133
421c9b3f2f4e commit: set whole manifest entries at once (node with its associated flags) Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 51579 diff changeset	1134 Equivalent to __setitem__ followed by setflag, but can be more efficient.
421c9b3f2f4e commit: set whole manifest entries at once (node with its associated flags) Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 51579 diff changeset	1135 """
421c9b3f2f4e commit: set whole manifest entries at once (node with its associated flags) Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 51579 diff changeset	1136
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1137 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1138 def __setitem__(self, path: bytes, node: bytes) -> None:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1139 """Define the node value for a path in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1140
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1141 If the path is already in the manifest, its flags will be copied to
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1142 the new entry.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1143 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1144
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1145 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1146 def __contains__(self, path: bytes) -> bool:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1147 """Whether a path exists in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1148
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1149 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1150 def __delitem__(self, path: bytes) -> None:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1151 """Remove a path from the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1152
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1153 Raises ``KeyError`` if the path is not in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1154 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1155
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1156 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1157 def __iter__(self) -> Iterator[bytes]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1158 """Iterate over paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1159
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1160 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1161 def iterkeys(self) -> Iterator[bytes]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1162 """Iterate over paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1163
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1164 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1165 def keys(self) -> list[bytes]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1166 """Obtain a list of paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1167
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1168 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1169 def filesnotin(self, other, match=None) -> Set[bytes]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1170 """Obtain the set of paths in this manifest but not in another.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1171
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1172 ``match`` is an optional matcher function to be applied to both
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1173 manifests.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1174
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1175 Returns a set of paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1176 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1177
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1178 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1179 def dirs(self) -> pathutil.dirs:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1180 """Returns an object implementing the ``idirs`` interface."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1181
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1182 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1183 def hasdir(self, dir: bytes) -> bool:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1184 """Returns a bool indicating if a directory is in this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1185
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1186 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1187 def walk(self, match: matchmod.basematcher) -> Iterator[bytes]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1188 """Generator of paths in manifest satisfying a matcher.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1189
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1190 If the matcher has explicit files listed and they don't exist in
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1191 the manifest, ``match.bad()`` is called for each missing file.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1192 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1193
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1194 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1195 def diff(
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1196 self,
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1197 other: Any, # TODO: 'manifestdict' or (better) equivalent interface
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1198 match: matchmod.basematcher \| None = None,
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1199 clean: bool = False,
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1200 ) -> dict[
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1201 bytes,
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1202 tuple[tuple[bytes \| None, bytes], tuple[bytes \| None, bytes]] \| None,
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1203 ]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1204 """Find differences between this manifest and another.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1205
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1206 This manifest is compared to ``other``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1207
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1208 If ``match`` is provided, the two manifests are filtered against this
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1209 matcher and only entries satisfying the matcher are compared.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1210
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1211 If ``clean`` is True, unchanged files are included in the returned
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1212 object.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1213
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1214 Returns a dict with paths as keys and values of 2-tuples of 2-tuples of
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1215 the form ``((node1, flag1), (node2, flag2))`` where ``(node1, flag1)``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1216 represents the node and flags for this manifest and ``(node2, flag2)``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1217 are the same for the other manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1218 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1219
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1220 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1221 def setflag(self, path: bytes, flag: bytes) -> None:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1222 """Set the flag value for a given path.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1223
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1224 Raises ``KeyError`` if the path is not already in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1225 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1226
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1227 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1228 def get(self, path: bytes, default=None) -> bytes \| None:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1229 """Obtain the node value for a path or a default value if missing."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1230
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1231 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1232 def flags(self, path: bytes) -> bytes:
44304 dbbae122f5e4 manifest: remove optional default= argument on flags(path) Augie Fackler <augie@google.com> parents: 44073 diff changeset	1233 """Return the flags value for a path (default: empty bytestring)."""
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1234
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1235 @abc.abstractmethod
52670 4cb75772818d pyupgrade: drop the quoting around type annotations Matt Harbison <matt_harbison@yahoo.com> parents: 52548 diff changeset	1236 def copy(self) -> imanifestdict:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1237 """Return a copy of this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1238
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1239 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1240 def items(self) -> Iterator[tuple[bytes, bytes]]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1241 """Returns an iterable of (path, node) for items in this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1242
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1243 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1244 def iteritems(self) -> Iterator[tuple[bytes, bytes]]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1245 """Identical to items()."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1246
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1247 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1248 def iterentries(self) -> Iterator[tuple[bytes, bytes, bytes]]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1249 """Returns an iterable of (path, node, flags) for this manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1250
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1251 Similar to ``iteritems()`` except items are a 3-tuple and include
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1252 flags.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1253 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1254
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1255 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1256 def text(self) -> ByteString:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1257 """Obtain the raw data representation for this manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1258
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1259 Result is used to create a manifest revision.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1260 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1261
52522 3913f9509476 interfaces: make `repository.imanifestdict` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52521 diff changeset	1262 @abc.abstractmethod
52521 48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1263 def fastdelta(
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1264 self, base: ByteString, changes: Iterable[tuple[bytes, bool]]
48cdbd4d5443 typing: align the signatures of `repository.imanifestdict` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52519 diff changeset	1265 ) -> tuple[ByteString, ByteString]:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1266 """Obtain a delta between this manifest and another given changes.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1267
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1268 ``base`` in the raw data representation for another manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1269
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1270 ``changes`` is an iterable of ``(path, to_delete)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1271
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1272 Returns a 2-tuple containing ``bytearray(self.text())`` and the
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1273 delta between ``base`` and this manifest.
44665 948fac24bc39 manifest: introduce new exception to signal unavailability of fastdelta() Augie Fackler <augie@google.com> parents: 44386 diff changeset	1274
948fac24bc39 manifest: introduce new exception to signal unavailability of fastdelta() Augie Fackler <augie@google.com> parents: 44386 diff changeset	1275 If this manifest implementation can't support ``fastdelta()``,
948fac24bc39 manifest: introduce new exception to signal unavailability of fastdelta() Augie Fackler <augie@google.com> parents: 44386 diff changeset	1276 raise ``mercurial.manifest.FastdeltaUnavailable``.
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1277 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1278
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1279
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1280 class imanifestrevisionbase(Protocol):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1281 """Base interface representing a single revision of a manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1282
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1283 Should not be used as a primary interface: should always be inherited
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1284 as part of a larger interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1285 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1286
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	1287 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1288 def copy(self):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1289 """Obtain a copy of this manifest instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1290
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1291 Returns an object conforming to the ``imanifestrevisionwritable``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1292 interface. The instance will be associated with the same
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1293 ``imanifestlog`` collection as this instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1294 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1295
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	1296 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1297 def read(self):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1298 """Obtain the parsed manifest data structure.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1299
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1300 The returned object conforms to the ``imanifestdict`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1301 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1302
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1303
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1304 class imanifestrevisionstored(imanifestrevisionbase, Protocol):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1305 """Interface representing a manifest revision committed to storage."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1306
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1307 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1308 def node(self) -> bytes:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1309 """The binary node for this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1310
52502 a1dd484bf33b interfaces: convert `imanifestrevisionstored` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52501 diff changeset	1311 parents: list[bytes]
a1dd484bf33b interfaces: convert `imanifestrevisionstored` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52501 diff changeset	1312 """List of binary nodes that are parents for this manifest revision."""
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1313
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1314 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1315 def readdelta(self, shallow: bool = False):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1316 """Obtain the manifest data structure representing changes from parent.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1317
51827 ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1318 This manifest is compared to its 1st parent. A new manifest
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1319 representing those differences is constructed.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1320
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1321 If `shallow` is True, this will read the delta for this directory,
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1322 without recursively reading subdirectory manifests. Instead, any
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1323 subdirectory entry will be reported as it appears in the manifest, i.e.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1324 the subdirectory will be reported among files and distinguished only by
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1325 its 't' flag. This only apply if the underlying manifest support it.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1326
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1327 The returned object conforms to the ``imanifestdict`` interface.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1328 """
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1329
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1330 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1331 def read_any_fast_delta(
048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1332 self,
048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1333 valid_bases: Collection[int] \| None = None,
048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1334 *,
048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1335 shallow: bool = False,
048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1336 ):
51827 ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1337 """read some manifest information as fast if possible
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1338
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1339 This might return a "delta", a manifest object containing only file
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1340 changed compared to another revisions. The `valid_bases` argument
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1341 control the set of revision that might be used as a base.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1342
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1343 If no delta can be retrieved quickly, a full read of the manifest will
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1344 be performed instead.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1345
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1346 The function return a tuple with two elements. The first one is the
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1347 delta base used (or None if we did a full read), the second one is the
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1348 manifest information.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1349
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1350 If `shallow` is True, this will read the delta for this directory,
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1351 without recursively reading subdirectory manifests. Instead, any
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1352 subdirectory entry will be reported as it appears in the manifest, i.e.
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1353 the subdirectory will be reported among files and distinguished only by
ca4208713875 manifest: introduce a `read_any_fast_delta` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51812 diff changeset	1354 its 't' flag. This only apply if the underlying manifest support it.
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1355
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1356 The returned object conforms to the ``imanifestdict`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1357 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1358
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1359 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1360 def read_delta_parents(self, *, shallow: bool = False, exact: bool = True):
51833 a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1361 """return a diff from this revision against both parents.
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1362
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1363 If `exact` is False, this might return a superset of the diff, containing
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1364 files that are actually present as is in one of the parents.
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1365
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1366 If `shallow` is True, this will read the delta for this directory,
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1367 without recursively reading subdirectory manifests. Instead, any
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1368 subdirectory entry will be reported as it appears in the manifest, i.e.
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1369 the subdirectory will be reported among files and distinguished only by
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1370 its 't' flag. This only apply if the underlying manifest support it.
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1371
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1372 The returned object conforms to the ``imanifestdict`` interface."""
a891347058e7 manifest: introduce a `read_delta_parents` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51828 diff changeset	1373
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1374 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1375 def read_delta_new_entries(self, *, shallow: bool = False):
51837 bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1376 """Return a manifest containing just the entries that might be new to
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1377 the repository.
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1378
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1379 This is often equivalent to a diff against both parents, but without
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1380 garantee. For performance reason, It might contains more files in some cases.
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1381
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1382 If `shallow` is True, this will read the delta for this directory,
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1383 without recursively reading subdirectory manifests. Instead, any
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1384 subdirectory entry will be reported as it appears in the manifest, i.e.
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1385 the subdirectory will be reported among files and distinguished only by
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1386 its 't' flag. This only apply if the underlying manifest support it.
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1387
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1388 The returned object conforms to the ``imanifestdict`` interface."""
bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1389
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1390 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1391 def readfast(self, shallow: bool = False):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1392 """Calls either ``read()`` or ``readdelta()``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1393
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1394 The faster of the two options is called.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1395 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1396
52504 cdd4bc69bfc1 interfaces: convert `imanifestrevisionstored` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52503 diff changeset	1397 @abc.abstractmethod
52503 048c11993d6a typing: (mostly) align the signatures of `imanifestrevisionstored` overrides Matt Harbison <matt_harbison@yahoo.com> parents: 52502 diff changeset	1398 def find(self, key: bytes) -> tuple[bytes, bytes]:
52505 0c60be5e021a interfaces: fix a doc comment in `repository.imanifestrevisionstored.find()` Matt Harbison <matt_harbison@yahoo.com> parents: 52504 diff changeset	1399 """Calls ``self.read().find(key)``.
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1400
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1401 Returns a 2-tuple of ``(node, flags)`` or raises ``KeyError``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1402 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1403
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1404
52509 01818a59f463 interfaces: convert `imanifestrevisionwritable` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52508 diff changeset	1405 class imanifestrevisionwritable(imanifestrevisionbase, Protocol):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1406 """Interface representing a manifest revision that can be committed."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1407
52509 01818a59f463 interfaces: convert `imanifestrevisionwritable` to a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52508 diff changeset	1408 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1409 def write(
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1410 self, transaction, linkrev, p1node, p2node, added, removed, match=None
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1411 ):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1412 """Add this revision to storage.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1413
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1414 Takes a transaction object, the changeset revision number it will
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1415 be associated with, its parent nodes, and lists of added and
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1416 removed paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1417
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1418 If match is provided, storage can choose not to inspect or write out
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1419 items that do not match. Storage is still required to be able to provide
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1420 the full manifest in the future for any directories written (these
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1421 manifests should not be "narrowed on disk").
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1422
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1423 Returns the binary node of the created revision.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1424 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1425
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1426
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1427 class imanifeststorage(Protocol):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1428 """Storage interface for manifest data."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1429
52507 d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1430 nodeconstants: NodeConstants
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1431 """nodeconstants used by the current repository."""
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1432
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1433 tree: bytes
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1434 """The path to the directory this manifest tracks.
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1435
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1436 The empty bytestring represents the root manifest.
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1437 """
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1438
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1439 index: ifilerevisionssequence
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1440 """An ``ifilerevisionssequence`` instance."""
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1441
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1442 opener: Vfs
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1443 """VFS opener to use to access underlying files used for storage.
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1444
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1445 TODO this is revlog specific and should not be exposed.
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1446 """
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1447
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1448 # TODO: finish type hints
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1449 fulltextcache: dict
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1450 """Dict with cache of fulltexts.
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1451
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1452 TODO this doesn't feel appropriate for the storage interface.
d01af74e67b4 interfaces: convert `repository.imanifeststorage` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52505 diff changeset	1453 """
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1454
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1455 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1456 def __len__(self):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1457 """Obtain the number of revisions stored for this manifest."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1458
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1459 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1460 def __iter__(self):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1461 """Iterate over revision numbers for this manifest."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1462
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1463 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1464 def rev(self, node):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1465 """Obtain the revision number given a binary node.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1466
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1467 Raises ``error.LookupError`` if the node is not known.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1468 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1469
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1470 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1471 def node(self, rev):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1472 """Obtain the node value given a revision number.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1473
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1474 Raises ``error.LookupError`` if the revision is not known.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1475 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1476
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1477 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1478 def lookup(self, value):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1479 """Attempt to resolve a value to a node.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1480
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1481 Value can be a binary node, hex node, revision number, or a bytes
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1482 that can be converted to an integer.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1483
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1484 Raises ``error.LookupError`` if a ndoe could not be resolved.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1485 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1486
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1487 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1488 def parents(self, node):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1489 """Returns a 2-tuple of parent nodes for a node.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1490
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1491 Values will be ``nullid`` if the parent is empty.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1492 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1493
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1494 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1495 def parentrevs(self, rev):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1496 """Like parents() but operates on revision numbers."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1497
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1498 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1499 def linkrev(self, rev):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1500 """Obtain the changeset revision number a revision is linked to."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1501
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1502 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1503 def revision(self, node):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1504 """Obtain fulltext data for a node."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1505
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1506 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1507 def rawdata(self, node):
42740 2128c76c8970 rawdata: forward `rawdata` call on `manifestlog` Pierre-Yves David <pierre-yves.david@octobus.net> parents: 42620 diff changeset	1508 """Obtain raw data for a node."""
2128c76c8970 rawdata: forward `rawdata` call on `manifestlog` Pierre-Yves David <pierre-yves.david@octobus.net> parents: 42620 diff changeset	1509
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1510 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1511 def revdiff(self, rev1, rev2):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1512 """Obtain a delta between two revision numbers.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1513
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1514 The returned data is the result of ``bdiff.bdiff()`` on the raw
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1515 revision data.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1516 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1517
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1518 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1519 def cmp(self, node, fulltext):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1520 """Compare fulltext to another revision.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1521
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1522 Returns True if the fulltext is different from what is stored.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1523 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1524
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1525 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1526 def emitrevisions(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1527 self,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1528 nodes,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1529 nodesorder=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1530 revisiondata=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1531 assumehaveparentrevisions=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1532 ):
39867 5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1533 """Produce ``irevisiondelta`` describing revisions.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1534
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1535 See the documentation for ``ifiledata`` for more.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1536 """
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1537
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1538 @abc.abstractmethod
45811 a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1539 def addgroup(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1540 self,
45811 a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1541 deltas,
a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1542 linkmapper,
a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1543 transaction,
a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1544 addrevisioncb=None,
a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1545 duplicaterevisioncb=None,
a5206e71c536 revlog: extend addgroup() with callback for duplicates Joerg Sonnenberger <joerg@bec.de> parents: 45671 diff changeset	1546 ):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1547 """Process a series of deltas for storage.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1548
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1549 See the documentation in ``ifilemutation`` for more.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1550 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1551
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1552 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1553 def rawsize(self, rev):
39863 9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1554 """Obtain the size of tracked data.
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1555
42795 83d090ebec0c rawdata: update callers in repository Pierre-Yves David <pierre-yves.david@octobus.net> parents: 42744 diff changeset	1556 Is equivalent to ``len(m.rawdata(node))``.
39863 9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1557
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1558 TODO this method is only used by upgrade code and may be removed.
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1559 """
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1560
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1561 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1562 def getstrippoint(self, minlink):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1563 """Find minimum revision that must be stripped to strip a linkrev.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1564
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1565 See the documentation in ``ifilemutation`` for more.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1566 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1567
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1568 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1569 def strip(self, minlink, transaction):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1570 """Remove storage of items starting at a linkrev.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1571
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1572 See the documentation in ``ifilemutation`` for more.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1573 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1574
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1575 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1576 def checksize(self):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1577 """Obtain the expected sizes of backing files.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1578
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1579 TODO this is used by verify and it should not be part of the interface.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1580 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1581
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1582 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1583 def files(self):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1584 """Obtain paths that are backing storage for this manifest.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1585
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1586 TODO this is used by verify and there should probably be a better API
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1587 for this functionality.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1588 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1589
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1590 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1591 def deltaparent(self, rev):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1592 """Obtain the revision that a revision is delta'd against.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1593
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1594 TODO delta encoding is an implementation detail of storage and should
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1595 not be exposed to the storage interface.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1596 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1597
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1598 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1599 def clone(self, tr, dest, **kwargs):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1600 """Clone this instance to another."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1601
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1602 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1603 def clearcaches(self, clear_persisted_data=False):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1604 """Clear any caches associated with this instance."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1605
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1606 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1607 def dirlog(self, d):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1608 """Obtain a manifest storage instance for a tree."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1609
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1610 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1611 def add(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1612 self,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1613 m,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1614 transaction,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1615 link,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1616 p1,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1617 p2,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1618 added,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1619 removed,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1620 readtree=None,
c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1621 match=None,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1622 ):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1623 """Add a revision to storage.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1624
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1625 ``m`` is an object conforming to ``imanifestdict``.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1626
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1627 ``link`` is the linkrev revision number.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1628
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1629 ``p1`` and ``p2`` are the parent revision numbers.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1630
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1631 ``added`` and ``removed`` are iterables of added and removed paths,
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1632 respectively.
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1633
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1634 ``readtree`` is a function that can be used to read the child tree(s)
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1635 when recursively writing the full tree structure when using
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1636 treemanifets.
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1637
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1638 ``match`` is a matcher that can be used to hint to storage that not all
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1639 paths must be inspected; this is an optimization and can be safely
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1640 ignored. Note that the storage must still be able to reproduce a full
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1641 manifest including files that did not match.
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1642 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1643
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1644 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1645 def storageinfo(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1646 self,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1647 exclusivefiles=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1648 sharedfiles=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1649 revisionscount=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1650 trackedsize=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1651 storedsize=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1652 ):
39874 14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1653 """Obtain information about storage for this manifest's data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1654
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1655 See ``ifilestorage.storageinfo()`` for a description of this method.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1656 This one behaves the same way, except for manifest data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1657 """
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1658
52508 99ca58c7cd0d interfaces: make `repository.imanifeststorage` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52507 diff changeset	1659 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1660 def get_revlog(self):
50667 32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1661 """return an actual revlog instance if any
32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1662
32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1663 This exist because a lot of code leverage the fact the underlying
32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1664 storage is a revlog for optimization, so giving simple way to access
32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1665 the revlog instance helps such code.
32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1666 """
32837c7e2e4b revlog: add a `get_revlog` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50474 diff changeset	1667
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1668
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1669 class imanifestlog(Protocol):
39268 2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1670 """Interface representing a collection of manifest snapshots.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1671
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1672 Represents the root manifest in a repository.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1673
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1674 Also serves as a means to access nested tree manifests and to cache
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1675 tree manifests.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1676 """
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1677
52511 ed70604d6e07 interfaces: convert `repository.imanifestlog` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52509 diff changeset	1678 nodeconstants: NodeConstants
ed70604d6e07 interfaces: convert `repository.imanifestlog` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52509 diff changeset	1679 """nodeconstants used by the current repository."""
ed70604d6e07 interfaces: convert `repository.imanifestlog` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52509 diff changeset	1680
ed70604d6e07 interfaces: convert `repository.imanifestlog` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52509 diff changeset	1681 narrowed: bool
ed70604d6e07 interfaces: convert `repository.imanifestlog` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52509 diff changeset	1682 """True, is the manifest is narrowed by a matcher"""
51837 bcb825bf0c5e manifest: add a read_delta_new_entries method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 51833 diff changeset	1683
52512 196f441ffc93 interfaces: make `repository.imanifestlog` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52511 diff changeset	1684 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1685 def __getitem__(self, node):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1686 """Obtain a manifest instance for a given binary node.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1687
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1688 Equivalent to calling ``self.get('', node)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1689
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1690 The returned object conforms to the ``imanifestrevisionstored``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1691 interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1692 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1693
52512 196f441ffc93 interfaces: make `repository.imanifestlog` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52511 diff changeset	1694 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1695 def get(self, tree, node, verify=True):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1696 """Retrieve the manifest instance for a given directory and binary node.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1697
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1698 ``node`` always refers to the node of the root manifest (which will be
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1699 the only manifest if flat manifests are being used).
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1700
39263 43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1701 If ``tree`` is the empty string, the root manifest is returned.
43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1702 Otherwise the manifest for the specified directory will be returned
43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1703 (requires tree manifests).
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1704
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1705 If ``verify`` is True, ``LookupError`` is raised if the node is not
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1706 known.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1707
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1708 The returned object conforms to the ``imanifestrevisionstored``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1709 interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1710 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1711
52512 196f441ffc93 interfaces: make `repository.imanifestlog` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52511 diff changeset	1712 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1713 def getstorage(self, tree):
39272 73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1714 """Retrieve an interface to storage for a particular tree.
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1715
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1716 If ``tree`` is the empty bytestring, storage for the root manifest will
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1717 be returned. Otherwise storage for a tree manifest is returned.
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1718
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1719 TODO formalize interface for returned object.
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1720 """
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1721
52512 196f441ffc93 interfaces: make `repository.imanifestlog` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52511 diff changeset	1722 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1723 def clearcaches(self, clear_persisted_data: bool = False) -> None:
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1724 """Clear caches associated with this collection."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1725
52512 196f441ffc93 interfaces: make `repository.imanifestlog` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52511 diff changeset	1726 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1727 def rev(self, node):
38556 f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1728 """Obtain the revision number for a binary node.
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1729
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1730 Raises ``error.LookupError`` if the node is not known.
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1731 """
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1732
52512 196f441ffc93 interfaces: make `repository.imanifestlog` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52511 diff changeset	1733 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1734 def update_caches(self, transaction):
44864 97ebdb192b00 nodemap: also warm manifest nodemap with other caches Pierre-Yves David <pierre-yves.david@octobus.net> parents: 44665 diff changeset	1735 """update whatever cache are relevant for the used storage."""
97ebdb192b00 nodemap: also warm manifest nodemap with other caches Pierre-Yves David <pierre-yves.david@octobus.net> parents: 44665 diff changeset	1736
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1737
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1738 class ilocalrepositoryfilestorage(Protocol):
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1739 """Local repository sub-interface providing access to tracked file storage.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1740
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1741 This interface defines how a repository accesses storage for a single
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1742 tracked file path.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1743 """
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1744
52519 ef119f914fc1 localrepo: subclass the new `ilocalrepositoryfilestorage` Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52517 diff changeset	1745 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1746 def file(self, f):
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1747 """Obtain a filelog for a tracked path.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1748
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1749 The returned type conforms to the ``ifilestorage`` interface.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1750 """
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1751
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	1752
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	1753 class ilocalrepositorymain(Protocol):
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1754 """Main interface for local repositories.
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1755
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1756 This currently captures the reality of things - not how things should be.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1757 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1758
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1759 nodeconstants: NodeConstants
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1760 """Constant nodes matching the hash function used by the repository."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1761
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1762 nullid: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1763 """null revision for the hash function used by the repository."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1764
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1765 supported: set[bytes]
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1766 """Set of requirements that this repo is capable of opening."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1767
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1768 requirements: set[bytes]
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1769 """Set of requirements this repo uses."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1770
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1771 features: set[bytes]
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1772 """Set of "features" this repository supports.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1773
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1774 A "feature" is a loosely-defined term. It can refer to a feature
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1775 in the classical sense or can describe an implementation detail
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1776 of the repository. For example, a ``readonly`` feature may denote
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1777 the repository as read-only. Or a ``revlogfilestore`` feature may
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1778 denote that the repository is using revlogs for file storage.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1779
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1780 The intent of features is to provide a machine-queryable mechanism
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1781 for repo consumers to test for various repository characteristics.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1782
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1783 Features are similar to ``requirements``. The main difference is that
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1784 requirements are stored on-disk and represent requirements to open the
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1785 repository. Features are more run-time capabilities of the repository
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1786 and more granular capabilities (which may be derived from requirements).
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1787 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1788
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1789 filtername: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1790 """Name of the repoview that is active on this repo."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1791
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1792 vfs_map: Mapping[bytes, Vfs]
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1793 """a bytes-key → vfs mapping used by transaction and others"""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1794
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1795 wvfs: Vfs
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1796 """VFS used to access the working directory."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1797
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1798 vfs: Vfs
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1799 """VFS rooted at the .hg directory.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1800
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1801 Used to access repository data not in the store.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1802 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1803
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1804 svfs: Vfs
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1805 """VFS rooted at the store.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1806
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1807 Used to access repository data in the store. Typically .hg/store.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1808 But can point elsewhere if the store is shared.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1809 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1810
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1811 root: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1812 """Path to the root of the working directory."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1813
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1814 path: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1815 """Path to the .hg directory."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1816
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1817 origroot: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1818 """The filesystem path that was used to construct the repo."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1819
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1820 auditor: Any
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1821 """A pathauditor for the working directory.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1822
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1823 This checks if a path refers to a nested repository.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1824
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1825 Operates on the filesystem.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1826 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1827
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1828 nofsauditor: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1829 """A pathauditor for the working directory.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1830
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1831 This is like ``auditor`` except it doesn't do filesystem checks.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1832 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1833
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1834 baseui: Ui
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1835 """Original ui instance passed into constructor."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1836
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1837 ui: Ui
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1838 """Main ui instance for this instance."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1839
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1840 sharedpath: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1841 """Path to the .hg directory of the repo this repo was shared from."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1842
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1843 store: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1844 """A store instance."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1845
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1846 spath: bytes
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1847 """Path to the store."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1848
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1849 sjoin: Callable # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1850 """Alias to self.store.join."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1851
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1852 cachevfs: Vfs
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1853 """A VFS used to access the cache directory.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1854
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1855 Typically .hg/cache.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1856 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1857
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1858 wcachevfs: Vfs
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1859 """A VFS used to access the cache directory dedicated to working copy
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1860
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1861 Typically .hg/wcache.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1862 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1863
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1864 filteredrevcache: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1865 """Holds sets of revisions to be filtered."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1866
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1867 names: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1868 """A ``namespaces`` instance."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1869
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1870 filecopiesmode: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1871 """The way files copies should be dealt with in this repo."""
43142 beed7ce61681 sidedatacopies: write copies information in sidedata when applicable Pierre-Yves David <pierre-yves.david@octobus.net> parents: 43077 diff changeset	1872
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1873 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1874 def close(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1875 """Close the handle on this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1876
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1877 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1878 def peer(self, path=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1879 """Obtain an object conforming to the ``peer`` interface."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1880
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1881 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1882 def unfiltered(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1883 """Obtain an unfiltered/raw view of this repo."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1884
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1885 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1886 def filtered(self, name, visibilityexceptions=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1887 """Obtain a named view of this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1888
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1889 obsstore: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1890 """A store of obsolescence data."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1891
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1892 changelog: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1893 """A handle on the changelog revlog."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1894
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1895 manifestlog: imanifestlog
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1896 """An instance conforming to the ``imanifestlog`` interface.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1897
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1898 Provides access to manifests for the repository.
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1899 """
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1900
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1901 dirstate: intdirstate.idirstate
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1902 """Working directory state."""
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1903
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1904 narrowpats: Any # TODO: add type hints
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	1905 """Matcher patterns for this repository's narrowspec."""
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1906
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1907 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1908 def narrowmatch(self, match=None, includeexact=False):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1909 """Obtain a matcher for the narrowspec."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1910
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1911 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1912 def setnarrowpats(self, newincludes, newexcludes):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1913 """Define the narrowspec for this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1914
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1915 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1916 def __getitem__(self, changeid):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1917 """Try to resolve a changectx."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1918
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1919 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1920 def __contains__(self, changeid):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1921 """Whether a changeset exists."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1922
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1923 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1924 def __nonzero__(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1925 """Always returns True."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1926 return True
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1927
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1928 __bool__ = __nonzero__
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1929
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1930 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1931 def __len__(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1932 """Returns the number of changesets in the repo."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1933
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1934 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1935 def __iter__(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1936 """Iterate over revisions in the changelog."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1937
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1938 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1939 def revs(self, expr, *args):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1940 """Evaluate a revset.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1941
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1942 Emits revisions.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1943 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1944
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1945 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1946 def set(self, expr, *args):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1947 """Evaluate a revset.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1948
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1949 Emits changectx instances.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1950 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1951
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1952 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1953 def anyrevs(self, specs, user=False, localalias=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1954 """Find revisions matching one of the given revsets."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1955
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1956 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1957 def url(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1958 """Returns a string representing the location of this repo."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1959
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1960 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1961 def hook(self, name, throw=False, **args):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1962 """Call a hook."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1963
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1964 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1965 def tags(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1966 """Return a mapping of tag to node."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1967
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1968 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1969 def tagtype(self, tagname):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1970 """Return the type of a given tag."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1971
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1972 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1973 def tagslist(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1974 """Return a list of tags ordered by revision."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1975
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1976 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1977 def nodetags(self, node):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1978 """Return the tags associated with a node."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1979
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1980 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1981 def nodebookmarks(self, node):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1982 """Return the list of bookmarks pointing to the specified node."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1983
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1984 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1985 def branchmap(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1986 """Return a mapping of branch to heads in that branch."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1987
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1988 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1989 def revbranchcache(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1990 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1991
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	1992 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	1993 def register_changeset(self, rev, changelogrevision):
46443 0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	1994 """Extension point for caches for new nodes.
0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	1995
0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	1996 Multiple consumers are expected to need parts of the changelogrevision,
0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	1997 so it is provided as optimization to avoid duplicate lookups. A simple
0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	1998 cache would be fragile when other revisions are accessed, too."""
0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	1999 pass
0903d6b9b1df repository: introduce register_changeset callback Joerg Sonnenberger <joerg@bec.de> parents: 45961 diff changeset	2000
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2001 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2002 def branchtip(self, branchtip, ignoremissing=False):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2003 """Return the tip node for a given branch."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2004
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2005 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2006 def lookup(self, key):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2007 """Resolve the node for a revision."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2008
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2009 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2010 def lookupbranch(self, key):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2011 """Look up the branch name of the given revision or branch name."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2012
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2013 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2014 def known(self, nodes):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2015 """Determine whether a series of nodes is known.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2016
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2017 Returns a list of bools.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2018 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2019
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2020 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2021 def local(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2022 """Whether the repository is local."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2023 return True
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2024
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2025 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2026 def publishing(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2027 """Whether the repository is a publishing repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2028
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2029 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2030 def cancopy(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2031 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2032
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2033 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2034 def shared(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2035 """The type of shared repository or None."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2036
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2037 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2038 def wjoin(self, f, *insidef):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2039 """Calls self.vfs.reljoin(self.root, f, *insidef)"""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2040
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2041 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2042 def setparents(self, p1, p2):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2043 """Set the parent nodes of the working directory."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2044
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2045 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2046 def filectx(self, path, changeid=None, fileid=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2047 """Obtain a filectx for the given file revision."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2048
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2049 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2050 def getcwd(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2051 """Obtain the current working directory from the dirstate."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2052
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2053 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2054 def pathto(self, f, cwd=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2055 """Obtain the relative path to a file."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2056
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2057 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2058 def adddatafilter(self, name, fltr):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2059 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2060
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2061 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2062 def wread(self, filename):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2063 """Read a file from wvfs, using data filters."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2064
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2065 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2066 def wwrite(self, filename, data, flags, backgroundclose=False, **kwargs):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2067 """Write data to a file in the wvfs, using data filters."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2068
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2069 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2070 def wwritedata(self, filename, data):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2071 """Resolve data for writing to the wvfs, using data filters."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2072
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2073 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2074 def currenttransaction(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2075 """Obtain the current transaction instance or None."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2076
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2077 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2078 def transaction(self, desc, report=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2079 """Open a new transaction to write to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2080
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2081 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2082 def undofiles(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2083 """Returns a list of (vfs, path) for files to undo transactions."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2084
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2085 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2086 def recover(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2087 """Roll back an interrupted transaction."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2088
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2089 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2090 def rollback(self, dryrun=False, force=False):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2091 """Undo the last transaction.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2092
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2093 DANGEROUS.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2094 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2095
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2096 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2097 def updatecaches(self, tr=None, full=False, caches=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2098 """Warm repo caches."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2099
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2100 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2101 def invalidatecaches(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2102 """Invalidate cached data due to the repository mutating."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2103
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2104 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2105 def invalidatevolatilesets(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2106 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2107
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2108 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2109 def invalidatedirstate(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2110 """Invalidate the dirstate."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2111
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2112 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2113 def invalidate(self, clearfilecache=False):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2114 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2115
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2116 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2117 def invalidateall(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2118 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2119
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2120 @abc.abstractmethod
52739 0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2121 def lock(self, wait=True, steal_from=None):
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2122 """Lock the repository store and return a lock instance.
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2123
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2124 If another lock object is specified through the "steal_from" argument,
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2125 the new lock will reuse the on-disk lock of that "stolen" lock instead
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2126 of creating its own. The "stolen" lock is no longer usable for any
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2127 purpose and won't execute its release callback.
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2128
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2129 That steal_from argument is used during local clone when reloading a
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2130 repository. If we could remove the need for this during copy clone, we
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2131 could remove this function.
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2132 """
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2133
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2134 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2135 def currentlock(self):
50323 6901916458bd localrepo: add a `currentlock` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50281 diff changeset	2136 """Return the lock if it's held or None."""
6901916458bd localrepo: add a `currentlock` method Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50281 diff changeset	2137
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2138 @abc.abstractmethod
52739 0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2139 def wlock(self, wait=True, steal_from=None):
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2140 """Lock the non-store parts of the repository.
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2141
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2142 If another lock object is specified through the "steal_from" argument,
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2143 the new lock will reuse the on-disk lock of that "stolen" lock instead
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2144 of creating its own. The "stolen" lock is no longer usable for any
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2145 purpose and won't execute its release callback.
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2146
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2147 That steal_from argument is used during local clone when reloading a
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2148 repository. If we could remove the need for this during copy clone, we
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2149 could remove this function.
0f2268783c11 clone: explicitly steal lock instead of assigning previous lock Pierre-Yves David <pierre-yves.david@octobus.net> parents: 52679 diff changeset	2150 """
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2151
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2152 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2153 def currentwlock(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2154 """Return the wlock if it's held or None."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2155
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2156 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2157 def checkcommitpatterns(self, wctx, match, status, fail):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2158 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2159
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2160 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2161 def commit(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2162 self,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2163 text=b'',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2164 user=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2165 date=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2166 match=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2167 force=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2168 editor=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2169 extra=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2170 ):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2171 """Add a new revision to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2172
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2173 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2174 def commitctx(self, ctx, error=False, origctx=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2175 """Commit a commitctx instance to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2176
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2177 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2178 def destroying(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2179 """Inform the repository that nodes are about to be destroyed."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2180
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2181 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2182 def destroyed(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2183 """Inform the repository that nodes have been destroyed."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2184
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2185 @abc.abstractmethod
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2186 def status(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2187 self,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	2188 node1=b'.',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2189 node2=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2190 match=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2191 ignored=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2192 clean=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2193 unknown=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2194 listsubrepos=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2195 ):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2196 """Convenience method to call repo[x].status()."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2197
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2198 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2199 def addpostdsstatus(self, ps):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2200 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2201
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2202 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2203 def postdsstatus(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2204 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2205
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2206 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2207 def clearpostdsstatus(self):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2208 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2209
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2210 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2211 def heads(self, start=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2212 """Obtain list of nodes that are DAG heads."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2213
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2214 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2215 def branchheads(self, branch=None, start=None, closed=False):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2216 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2217
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2218 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2219 def branches(self, nodes):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2220 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2221
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2222 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2223 def between(self, pairs):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2224 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2225
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2226 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2227 def checkpush(self, pushop):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2228 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2229
52514 dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	2230 prepushoutgoinghooks: util.hooks
dfb60fb155da interfaces: convert `ilocalrepositorymain` from zope `Attribute` attrs Matt Harbison <matt_harbison@yahoo.com> parents: 52512 diff changeset	2231 """util.hooks instance."""
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2232
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2233 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2234 def pushkey(self, namespace, key, old, new):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2235 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2236
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2237 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2238 def listkeys(self, namespace):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2239 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2240
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2241 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2242 def debugwireargs(self, one, two, three=None, four=None, five=None):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2243 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2244
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2245 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2246 def savecommitmessage(self, text):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	2247 pass
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	2248
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2249 @abc.abstractmethod
47097 81eb7091c494 sidedata: add a way of replacing an existing sidedata computer Rapha?l Gom?s <rgomes@octobus.net> parents: 47095 diff changeset	2250 def register_sidedata_computer(
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2251 self, kind, category, keys, computer, flags, replace=False
47097 81eb7091c494 sidedata: add a way of replacing an existing sidedata computer Rapha?l Gom?s <rgomes@octobus.net> parents: 47095 diff changeset	2252 ):
46726 bc2519513ae0 sidedata-exchange: add `wanted_sidedata` and `sidedata_computers` to repos Rapha?l Gom?s <rgomes@octobus.net> parents: 46725 diff changeset	2253 pass
bc2519513ae0 sidedata-exchange: add `wanted_sidedata` and `sidedata_computers` to repos Rapha?l Gom?s <rgomes@octobus.net> parents: 46725 diff changeset	2254
52515 c0d9fda9f5f5 interfaces: make `repository.ilocalrepositorymain` methods abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52514 diff changeset	2255 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2256 def register_wanted_sidedata(self, category):
46726 bc2519513ae0 sidedata-exchange: add `wanted_sidedata` and `sidedata_computers` to repos Rapha?l Gom?s <rgomes@octobus.net> parents: 46725 diff changeset	2257 pass
bc2519513ae0 sidedata-exchange: add `wanted_sidedata` and `sidedata_computers` to repos Rapha?l Gom?s <rgomes@octobus.net> parents: 46725 diff changeset	2258
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2259
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2260 class completelocalrepository(
52529 3abf9bc10fcc interfaces: mark `completelocalrepository` as a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52528 diff changeset	2261 ilocalrepositorymain,
3abf9bc10fcc interfaces: mark `completelocalrepository` as a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52528 diff changeset	2262 ilocalrepositoryfilestorage,
3abf9bc10fcc interfaces: mark `completelocalrepository` as a Protocol class Matt Harbison <matt_harbison@yahoo.com> parents: 52528 diff changeset	2263 Protocol,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2264 ):
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	2265 """Complete interface for a local repository."""
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2266
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2267
52474 26dd402c3497 interfaces: convert the repository zope interfaces to Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52463 diff changeset	2268 class iwireprotocolcommandcacher(Protocol):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2269 """Represents a caching backend for wire protocol commands.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2270
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2271 Wire protocol version 2 supports transparent caching of many commands.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2272 To leverage this caching, servers can activate objects that cache
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2273 command responses. Objects handle both cache writing and reading.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2274 This interface defines how that response caching mechanism works.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2275
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2276 Wire protocol version 2 commands emit a series of objects that are
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2277 serialized and sent to the client. The caching layer exists between
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2278 the invocation of the command function and the sending of its output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2279 objects to an output layer.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2280
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2281 Instances of this interface represent a binding to a cache that
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2282 can serve a response (in place of calling a command function) and/or
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2283 write responses to a cache for subsequent use.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2284
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2285 When a command request arrives, the following happens with regards
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2286 to this interface:
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2287
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2288 1. The server determines whether the command request is cacheable.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2289 2. If it is, an instance of this interface is spawned.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2290 3. The cacher is activated in a context manager (``__enter__`` is called).
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2291 4. A cache key for that request is derived. This will call the
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2292 instance's ``adjustcachekeystate()`` method so the derivation
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2293 can be influenced.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2294 5. The cacher is informed of the derived cache key via a call to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2295 ``setcachekey()``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2296 6. The cacher's ``lookup()`` method is called to test for presence of
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2297 the derived key in the cache.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2298 7. If ``lookup()`` returns a hit, that cached result is used in place
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2299 of invoking the command function. ``__exit__`` is called and the instance
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2300 is discarded.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2301 8. The command function is invoked.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2302 9. ``onobject()`` is called for each object emitted by the command
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2303 function.
40279 4821affc154f wireproto: fix incorrect function name in docstring Connor Sheehan <sheehan@mozilla.com> parents: 40171 diff changeset	2304 10. After the final object is seen, ``onfinished()`` is called.
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2305 11. ``__exit__`` is called to signal the end of use of the instance.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2306
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2307 Cache key derivation can be influenced by the instance.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2308
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2309 Cache keys are initially derived by a deterministic representation of
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2310 the command request. This includes the command name, arguments, protocol
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2311 version, etc. This initial key derivation is performed by CBOR-encoding a
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2312 data structure and feeding that output into a hasher.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2313
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2314 Instances of this interface can influence this initial key derivation
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2315 via ``adjustcachekeystate()``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2316
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2317 The instance is informed of the derived cache key via a call to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2318 ``setcachekey()``. The instance must store the key locally so it can
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2319 be consulted on subsequent operations that may require it.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2320
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2321 When constructed, the instance has access to a callable that can be used
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2322 for encoding response objects. This callable receives as its single
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2323 argument an object emitted by a command function. It returns an iterable
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2324 of bytes chunks representing the encoded object. Unless the cacher is
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2325 caching native Python objects in memory or has a way of reconstructing
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2326 the original Python objects, implementations typically call this function
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2327 to produce bytes from the output objects and then store those bytes in
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2328 the cache. When it comes time to re-emit those bytes, they are wrapped
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2329 in a ``wireprototypes.encodedresponse`` instance to tell the output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2330 layer that they are pre-encoded.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2331
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2332 When receiving the objects emitted by the command function, instances
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2333 can choose what to do with those objects. The simplest thing to do is
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2334 re-emit the original objects. They will be forwarded to the output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2335 layer and will be processed as if the cacher did not exist.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2336
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2337 Implementations could also choose to not emit objects - instead locally
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2338 buffering objects or their encoded representation. They could then emit
40279 4821affc154f wireproto: fix incorrect function name in docstring Connor Sheehan <sheehan@mozilla.com> parents: 40171 diff changeset	2339 a single "coalesced" object when ``onfinished()`` is called. In
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2340 this way, the implementation would function as a filtering layer of
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2341 sorts.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2342
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2343 When caching objects, typically the encoded form of the object will
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2344 be stored. Keep in mind that if the original object is forwarded to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2345 the output layer, it will need to be encoded there as well. For large
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2346 output, this redundant encoding could add overhead. Implementations
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2347 could wrap the encoded object data in ``wireprototypes.encodedresponse``
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2348 instances to avoid this overhead.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2349 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43032 diff changeset	2350
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2351 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2352 def __enter__(self):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2353 """Marks the instance as active.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2354
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2355 Should return self.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2356 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2357
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2358 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2359 def __exit__(self, exctype, excvalue, exctb):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2360 """Called when cacher is no longer used.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2361
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2362 This can be used by implementations to perform cleanup actions (e.g.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2363 disconnecting network sockets, aborting a partially cached response.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2364 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2365
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2366 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2367 def adjustcachekeystate(self, state):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2368 """Influences cache key derivation by adjusting state to derive key.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2369
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2370 A dict defining the state used to derive the cache key is passed.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2371
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2372 Implementations can modify this dict to record additional state that
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2373 is wanted to influence key derivation.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2374
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2375 Implementations are highly encouraged to not modify or delete
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2376 existing keys.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2377 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2378
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2379 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2380 def setcachekey(self, key):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2381 """Record the derived cache key for this request.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2382
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2383 Instances may mutate the key for internal usage, as desired. e.g.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2384 instances may wish to prepend the repo name, introduce path
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2385 components for filesystem or URL addressing, etc. Behavior is up to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2386 the cache.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2387
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2388 Returns a bool indicating if the request is cacheable by this
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2389 instance.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2390 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2391
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2392 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2393 def lookup(self):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2394 """Attempt to resolve an entry in the cache.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2395
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2396 The instance is instructed to look for the cache key that it was
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2397 informed about via the call to ``setcachekey()``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2398
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2399 If there's no cache hit or the cacher doesn't wish to use the cached
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2400 entry, ``None`` should be returned.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2401
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2402 Else, a dict defining the cached result should be returned. The
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2403 dict may have the following keys:
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2404
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2405 objs
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2406 An iterable of objects that should be sent to the client. That
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2407 iterable of objects is expected to be what the command function
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2408 would return if invoked or an equivalent representation thereof.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2409 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2410
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2411 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2412 def onobject(self, obj):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2413 """Called when a new object is emitted from the command function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2414
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2415 Receives as its argument the object that was emitted from the
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2416 command function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2417
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2418 This method returns an iterator of objects to forward to the output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2419 layer. The easiest implementation is a generator that just
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2420 ``yield obj``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2421 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2422
52528 9358d786af24 interfaces: make all methods on any repository Protocol class abstract Matt Harbison <matt_harbison@yahoo.com> parents: 52526 diff changeset	2423 @abc.abstractmethod
52475 c1674551c109 interfaces: add the missing `self` arg to the repository Protocol classes Matt Harbison <matt_harbison@yahoo.com> parents: 52474 diff changeset	2424 def onfinished(self):
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2425 """Called after all objects have been emitted from the command function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2426
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2427 Implementations should return an iterator of objects to forward to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2428 the output layer.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2429
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2430 This method can be a generator.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	2431 """

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/interfaces/repository.py @ 52739:0f2268783c11