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

annotate mercurial/interfaces/repository.py @ 52487:3daaa5195a30

typing: align the signatures of `repository.ifilestorage` overrides This is the same as 048c11993d6a for `imanifestrevisionstored`, with the same belated realization about missing the Protocol marker. Since I've been jumping around to the various subclasses and copying extant hints to places where they're missing, do that here too. This also covers the 3 interfaces subclassed by `repository.ifilestorage` (`repository.ifileindex`, `repository.ifiledata`, and `repository.ifilemutation`). Obviously the whole base class needs hints, but I don't want to get side tracked here- it doesn't look like any of the implementing classes have any additional hints.

author	Matt Harbison <matt_harbison@yahoo.com>
date	Wed, 23 Oct 2024 12:21:52 -0400
parents	c0d9fda9f5f5
children	8c89e978375c

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

Mercurial > public > mercurial-scm > hg

annotate mercurial/interfaces/repository.py @ 52487:3daaa5195a30