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

annotate mercurial/interfaces/repository.py @ 52493:73a46cef57c9

interfaces: rename `repository.ipeerconnection` to reflect it being private

author	Matt Harbison <matt_harbison@yahoo.com>
date	Tue, 22 Oct 2024 16:52:39 -0400
parents	0cfcc276b796
children	4cc186255672

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

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/interfaces/repository.py @ 52493:73a46cef57c9