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

annotate mercurial/repository.py @ 39856:1f7b3b980af8

lfs: add repository feature denoting the use of LFS Whether LFS is enabled seems like a useful feature to expose. This will also facilitate some future work around LFS feature compatibility. Differential Revision: https://phab.mercurial-scm.org/D4710

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Wed, 19 Sep 2018 13:48:59 -0700
parents	d89d5bc06eaa
children	9534fe1e5d28

rev	line source
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1 # repository.py - Interfaces and base classes for repositories and peers.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	2 #
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3 # Copyright 2017 Gregory Szorc <gregory.szorc@gmail.com>
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	4 #
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	5 # This software may be used and distributed according to the terms of the
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 # GNU General Public License version 2 or any later version.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	7
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	8 from __future__ import absolute_import
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	9
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	10 from .i18n import _
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	11 from . import (
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	12 error,
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	13 )
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	14 from .utils import (
856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	15 interfaceutil,
856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	16 )
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	17
38874 a232e6744ba3 narrow: move requirement constant from changegroup to repository Martin von Zweigbergk <martinvonz@google.com> parents: 38557 diff changeset	18 # When narrowing is finalized and no longer subject to format changes,
a232e6744ba3 narrow: move requirement constant from changegroup to repository Martin von Zweigbergk <martinvonz@google.com> parents: 38557 diff changeset	19 # we should move this to just "narrow" or similar.
a232e6744ba3 narrow: move requirement constant from changegroup to repository Martin von Zweigbergk <martinvonz@google.com> parents: 38557 diff changeset	20 NARROW_REQUIREMENT = 'narrowhg-experimental'
a232e6744ba3 narrow: move requirement constant from changegroup to repository Martin von Zweigbergk <martinvonz@google.com> parents: 38557 diff changeset	21
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	22 # Local repository feature string.
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	23
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	24 # 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	25 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	26 # 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	27 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	28 # 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	29 REPO_FEATURE_LFS = b'lfs'
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	30
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	31 class ipeerconnection(interfaceutil.Interface):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	32 """Represents a "connection" to a repository.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	33
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	34 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	35 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	36
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	37 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	38 outside of this module.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39 """
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	40 ui = interfaceutil.Attribute("""ui.ui instance""")
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	41
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	42 def url():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	43 """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	44
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	45 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	46 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	47 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	48 data leakage.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	49
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	50 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	51 value.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	52 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	53
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	54 def local():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	55 """Returns a local repository instance.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	56
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	57 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	58 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	59 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	60
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	61 def peer():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	62 """Returns an object conforming to this interface.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	63
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	64 Most implementations will ``return self``.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	65 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	66
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	67 def canpush():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	68 """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	69
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	70 def close():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	71 """Close the connection to this peer.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	72
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	73 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	74 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	75 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	76
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	77 class ipeercapabilities(interfaceutil.Interface):
37610 98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	78 """Peer sub-interface related to capabilities."""
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	79
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	80 def capable(name):
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	81 """Determine support for a named capability.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	82
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	83 Returns ``False`` if capability not supported.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	84
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	85 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	86 if capability support is non-boolean.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	87
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	88 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	89 """
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	90
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	91 def requirecap(name, purpose):
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	92 """Require a capability to be present.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	93
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	94 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	95 """
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	96
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	97 class ipeercommands(interfaceutil.Interface):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	98 """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	99
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	100 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	101 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	102 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	103
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	104 def branchmap():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	105 """Obtain heads in named branches.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	106
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	107 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	108 heads on that branch.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	109 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	110
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	111 def capabilities():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	112 """Obtain capabilities of the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	113
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	114 Returns a set of string capabilities.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	115 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	116
37649 a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	117 def clonebundles():
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	118 """Obtains the clone bundles manifest for the repo.
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	119
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	120 Returns the manifest as unparsed bytes.
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	121 """
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	122
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	123 def debugwireargs(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	124 """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	125
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	126 def getbundle(source, **kwargs):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	127 """Obtain remote repository data as a bundle.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	128
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	129 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	130 the peer to the local repository
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	131
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	132 Returns a generator of bundle data.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	133 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	134
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	135 def heads():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	136 """Determine all known head revisions in the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	137
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	138 Returns an iterable of binary nodes.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	139 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	140
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	141 def known(nodes):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	142 """Determine whether multiple nodes are known.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	143
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	144 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	145
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	146 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	147 at that index is known to the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	148 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	149
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	150 def listkeys(namespace):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	151 """Obtain all keys in a pushkey namespace.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	152
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	153 Returns an iterable of key names.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	154 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	155
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	156 def lookup(key):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	157 """Resolve a value to a known revision.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	158
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	159 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	160 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	161
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	162 def pushkey(namespace, key, old, new):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	163 """Set a value using the ``pushkey`` protocol.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	164
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	165 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	166 the old and new values for that key.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	167
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	168 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	169 namespace.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	170 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	171
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	172 def stream_out():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	173 """Obtain streaming clone data.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	174
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	175 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	176 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	177
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	178 def unbundle(bundle, heads, url):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	179 """Transfer repository data to the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	180
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	181 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	182
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	183 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	184 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	185
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	186 class ipeerlegacycommands(interfaceutil.Interface):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	187 """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	188
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	189 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	190 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	191 legacy, the interfaces are split.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	192 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	193
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	194 def between(pairs):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	195 """Obtain nodes between pairs of nodes.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	196
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	197 ``pairs`` is an iterable of node pairs.
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 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	200 requested pair.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	201 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	202
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	203 def branches(nodes):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	204 """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	205
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	206 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	207 a DAG root or is a merge.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	208
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	209 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	210 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	211
37635 cc8c06835097 wireproto: convert legacy commands to command executor Gregory Szorc <gregory.szorc@gmail.com> parents: 37633 diff changeset	212 def changegroup(nodes, source):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	213 """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	214
37635 cc8c06835097 wireproto: convert legacy commands to command executor Gregory Szorc <gregory.szorc@gmail.com> parents: 37633 diff changeset	215 def changegroupsubset(bases, heads, source):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	216 pass
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	217
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	218 class ipeercommandexecutor(interfaceutil.Interface):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	219 """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	220
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	221 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	222 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	223 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	224 outstanding requests are waited on.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	225 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	226
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	227 def callcommand(name, args):
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	228 """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	229
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	230 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	231
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	232 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	233 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	234 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	235
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	236 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	237 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	238 used and the command itself.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	239
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	240 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	241 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	242
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	243 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	244 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	245 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	246 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	247 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	248
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	249 def sendcommands():
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	250 """Trigger submission of queued command requests.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	251
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	252 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	253 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	254 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	255
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	256 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	257 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	258
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	259 def close():
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	260 """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	261
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	262 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	263 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	264 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	265 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	266 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	267 to finish.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	268
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	269 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	270 context manager.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	271
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	272 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	273 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	274
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	275 class ipeerrequests(interfaceutil.Interface):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	276 """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	277
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	278 def commandexecutor():
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	279 """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	280
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	281 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	282 to the peer.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	283
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	284 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	285 requests.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	286
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	287 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	288 (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	289 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	290 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	291 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	292 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	293 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	294 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	295 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	296 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	297 being issued.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	298 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	299
37650 62ebfda864de repository: remove ipeercommands from ipeerbase Gregory Szorc <gregory.szorc@gmail.com> parents: 37649 diff changeset	300 class ipeerbase(ipeerconnection, ipeercapabilities, ipeerrequests):
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	301 """Unified interface for peer repositories.
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	302
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	303 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	304 """
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	305
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	306 @interfaceutil.implementer(ipeerbase)
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	307 class peer(object):
39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	308 """Base class for peer repositories."""
39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	309
39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	310 def capable(self, name):
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	311 caps = self.capabilities()
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	312 if name in caps:
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	313 return True
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	314
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	315 name = '%s=' % name
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	316 for cap in caps:
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	317 if cap.startswith(name):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	318 return cap[len(name):]
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	319
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	320 return False
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	321
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	322 def requirecap(self, name, purpose):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	323 if self.capable(name):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	324 return
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	325
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	326 raise error.CapabilityError(
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	327 _('cannot %s; remote repository does not support the %r '
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	328 'capability') % (purpose, name))
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	329
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	330 class iverifyproblem(interfaceutil.Interface):
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	331 """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	332
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	333 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	334 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	335
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	336 Instances are essentially messages associated with severity.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	337 """
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	338 warning = interfaceutil.Attribute(
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	339 """Message indicating a non-fatal problem.""")
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	340
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	341 error = interfaceutil.Attribute(
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	342 """Message indicating a fatal problem.""")
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	343
39258 b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	344 class irevisiondelta(interfaceutil.Interface):
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	345 """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	346
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	347 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	348 with another repository.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	349
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	350 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	351 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	352 are mutually exclusive.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	353
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	354 Typically used for changegroup generation.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	355 """
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	356
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	357 node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	358 """20 byte node of this revision.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	359
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	360 p1node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	361 """20 byte node of 1st parent of this revision.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	362
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	363 p2node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	364 """20 byte node of 2nd parent of this revision.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	365
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	366 linknode = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	367 """20 byte node of the changelog revision this node is linked to.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	368
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	369 flags = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	370 """2 bytes of integer flags that apply to this revision.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	371
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	372 basenode = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	373 """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	374
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	375 ``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	376 a delta.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	377 """)
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	378
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	379 baserevisionsize = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	380 """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	381
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	382 May be ``None`` if ``basenode`` is ``nullid``.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	383 """)
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	384
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	385 revision = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	386 """Raw fulltext of revision data for this node.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	387
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	388 delta = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	389 """Delta between ``basenode`` and ``node``.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	390
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	391 Stored in the bdiff delta format.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	392 """)
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	393
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	394 class irevisiondeltarequest(interfaceutil.Interface):
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	395 """Represents a request to generate an ``irevisiondelta``."""
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	396
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	397 node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	398 """20 byte node of revision being requested.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	399
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	400 p1node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	401 """20 byte node of 1st parent of revision.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	402
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	403 p2node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	404 """20 byte node of 2nd parent of revision.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	405
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	406 linknode = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	407 """20 byte node to store in ``linknode`` attribute.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	408
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	409 basenode = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	410 """Base revision that delta should be generated against.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	411
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	412 If ``nullid``, the derived ``irevisiondelta`` should have its
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	413 ``revision`` field populated and no delta should be generated.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	414
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	415 If ``None``, the delta may be generated against any revision that
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	416 is an ancestor of this revision. Or a full revision may be used.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	417
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	418 If any other value, the delta should be produced against that
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	419 revision.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	420 """)
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	421
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	422 ellipsis = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	423 """Boolean on whether the ellipsis flag should be set.""")
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	424
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	425 class ifilerevisionssequence(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	426 """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	427
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	428 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	429 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	430 index metadata.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	431
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	432 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	433 in the index.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	434 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	435
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	436 def __len__():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	437 """The total number of revisions."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	438
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	439 def __getitem__(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	440 """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	441
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	442 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	443
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	444 offset+flags
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	445 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	446 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	447 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	448 compressed size
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	449 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	450 needed by the store.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	451 uncompressed size
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	452 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	453 base revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	454 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	455 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	456 link revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	457 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	458 p1 revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	459 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	460 p2 revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	461 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	462 node
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	463 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	464
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	465 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	466 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	467 recent revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	468 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	469
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	470 def __contains__(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	471 """Whether a revision number exists."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	472
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	473 def insert(self, i, entry):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	474 """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	475
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	476 class ifileindex(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	477 """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	478
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	479 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	480 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	481
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	482 The index logically consists of:
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	483
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	484 * 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	485 * 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	486 * Metadata to facilitate storage.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	487 """
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	488 index = interfaceutil.Attribute(
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	489 """An ``ifilerevisionssequence`` instance.""")
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	490
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	491 def __len__():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	492 """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	493
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	494 def __iter__():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	495 """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	496
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	497 def revs(start=0, stop=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	498 """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	499
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	500 def parents(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	501 """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	502
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	503 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	504 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	505
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	506 def parentrevs(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	507 """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	508
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	509 def rev(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	510 """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	511
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	512 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	513 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	514
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	515 def node(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	516 """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	517
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	518 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	519 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	520
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	521 def lookup(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	522 """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	523
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	524 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	525 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	526
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	527 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	528 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	529
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	530 def linkrev(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	531 """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	532
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	533 def flags(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	534 """Obtain flags used to affect storage of a revision."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	535
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	536 def iscensored(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	537 """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	538
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	539 def commonancestorsheads(node1, node2):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	540 """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	541
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	542 See ``ancestor.commonancestorsheads()``.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	543 """
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 def descendants(revs):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	546 """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	547
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	548 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	549 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	550
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	551 def heads(start=None, stop=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	552 """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	553
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	554 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	555 ``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	556 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	557 ``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	558 encountered.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	559 """
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 def children(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	562 """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	563
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	564 Returns a list of nodes.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	565 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	566
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	567 def deltaparent(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	568 """"Return the revision that is a suitable parent to delta against."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	569
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	570 class ifiledata(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	571 """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	572
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	573 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	574 data for a tracked file.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	575 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	576 def rawsize(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	577 """The size of the fulltext data for a revision as stored."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	578
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	579 def size(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	580 """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	581
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	582 Any metadata is excluded from size measurements. Use ``rawsize()`` if
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	583 metadata size is important.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	584 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	585
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	586 def checkhash(fulltext, node, p1=None, p2=None, rev=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	587 """Validate the stored hash of a given fulltext and node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	588
39792 cb65d4b7e429 error: introduce StorageError Gregory Szorc <gregory.szorc@gmail.com> parents: 39780 diff changeset	589 Raises ``error.StorageError`` is hash validation fails.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	590 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	591
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	592 def revision(node, raw=False):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	593 """"Obtain fulltext data for a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	594
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	595 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	596 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	597 are not applied.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	598
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	599 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	600 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	601 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	602
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	603 def read(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	604 """Resolve file fulltext data.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	605
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	606 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	607 headers is stripped.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	608 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	609
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	610 def renamed(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	611 """Obtain copy metadata for a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	612
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	613 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	614 (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	615 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	616
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	617 def cmp(node, fulltext):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	618 """Compare fulltext to another revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	619
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	620 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	621
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	622 This takes copy metadata into account.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	623
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	624 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	625 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	626
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	627 def revdiff(rev1, rev2):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	628 """Obtain a delta between two revision numbers.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	629
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	630 Operates on raw data in the store (``revision(node, raw=True)``).
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	631
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	632 The returned data is the result of ``bdiff.bdiff`` on the raw
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	633 revision data.
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
39259 b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	636 def emitrevisiondeltas(requests):
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	637 """Produce ``irevisiondelta`` from ``irevisiondeltarequest``s.
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	638
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	639 Given an iterable of objects conforming to the ``irevisiondeltarequest``
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	640 interface, emits objects conforming to the ``irevisiondelta``
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	641 interface.
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	642
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	643 This method is a generator.
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	644
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	645 ``irevisiondelta`` should be emitted in the same order of
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	646 ``irevisiondeltarequest`` that was passed in.
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	647
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	648 The emitted objects MUST conform by the results of
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	649 ``irevisiondeltarequest``. Namely, they must respect any requests
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	650 for building a delta from a specific ``basenode`` if defined.
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	651
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	652 When sending deltas, implementations must take into account whether
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	653 the client has the base delta before encoding a delta against that
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	654 revision. A revision encountered previously in ``requests`` is
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	655 always a suitable base revision. An example of a bad delta is a delta
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	656 against a non-ancestor revision. Another example of a bad delta is a
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	657 delta against a censored revision.
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	658 """
b41d023a412a repository: establish API for emitting revision deltas Gregory Szorc <gregory.szorc@gmail.com> parents: 39258 diff changeset	659
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	660 class ifilemutation(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	661 """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	662
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	663 def add(filedata, meta, transaction, linkrev, p1, p2):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	664 """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	665
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	666 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	667 and parent nodes.
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 Returns the node that was added.
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 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	672 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	673
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	674 def addrevision(revisiondata, transaction, linkrev, p1, p2, node=None,
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	675 flags=0, cachedelta=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	676 """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	677
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	678 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	679
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	680 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	681
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	682 ``node`` and ``flags`` can be used to define the expected node and
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	683 the flags to use with storage.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	684
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	685 ``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	686 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	687 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	688 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	689 """
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 def addgroup(deltas, linkmapper, transaction, addrevisioncb=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	692 """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	693
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	694 ``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	695 (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	696 to add.
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 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	699 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	700 ``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	701 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	702
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	703 ``addrevisioncb`` should be called for each node as it is committed.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	704
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	705 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	706 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	707 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	708
39794 a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	709 def censorrevision(tr, node, tombstone=b''):
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	710 """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	711
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	712 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	713 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	714 result in failure.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	715
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	716 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	717 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	718 data.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	719
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	720 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	721 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	722 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	723 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	724 """
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	725
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	726 def getstrippoint(minlink):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	727 """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	728
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	729 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	730 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	731
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	732 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	733 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	734 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	735
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	736 def strip(minlink, transaction):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	737 """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	738
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	739 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	740 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	741
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	742 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	743 higher-level deletion API.
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
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	746 class ifilestorage(ifileindex, ifiledata, ifilemutation):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	747 """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	748
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	749 _generaldelta = interfaceutil.Attribute(
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	750 """Whether deltas can be against any parent revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	751
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	752 TODO this is used by changegroup code and it could probably be
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	753 folded into another API.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	754 """)
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	755
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	756 def files():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	757 """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	758
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	759 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	760 be a better API for that.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	761 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	762
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	763 def verifyintegrity(state):
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	764 """Verifies the integrity of file storage.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	765
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	766 ``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	767 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	768 primitives.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	769
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	770 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	771 interface.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	772 """
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	773
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	774 class idirs(interfaceutil.Interface):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	775 """Interface representing a collection of directories from paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	776
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	777 This interface is essentially a derived data structure representing
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	778 directories from a collection of paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	779 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	780
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	781 def addpath(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	782 """Add a path to the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	783
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	784 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	785 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	786
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	787 def delpath(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	788 """Remove a path from the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	789
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	790 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	791 directory is removed from the collection.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	792 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	793
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	794 def __iter__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	795 """Iterate over the directories in this collection of paths."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	796
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	797 def __contains__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	798 """Whether a specific directory is in this collection."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	799
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	800 class imanifestdict(interfaceutil.Interface):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	801 """Interface representing a manifest data structure.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	802
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	803 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	804 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	805 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	806
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	807 def __getitem__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	808 """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	809
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	810 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	811
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	812 Equivalent to ``self.find(path)[0]``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	813 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	814
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	815 def find(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	816 """Returns the entry for a path in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	817
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	818 Returns a 2-tuple of (node, flags).
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	819
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	820 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	821 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	822
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	823 def __len__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	824 """Return the number of entries in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	825
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	826 def __nonzero__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	827 """Returns True if the manifest has entries, False otherwise."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	828
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	829 __bool__ = __nonzero__
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	830
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	831 def __setitem__(path, node):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	832 """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	833
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	834 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	835 the new entry.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	836 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	837
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	838 def __contains__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	839 """Whether a path exists in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	840
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	841 def __delitem__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	842 """Remove a path from the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	843
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	844 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	845 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	846
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	847 def __iter__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	848 """Iterate over paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	849
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	850 def iterkeys():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	851 """Iterate over paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	852
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	853 def keys():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	854 """Obtain a list of paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	855
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	856 def filesnotin(other, match=None):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	857 """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	858
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	859 ``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	860 manifests.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	861
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	862 Returns a set of paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	863 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	864
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	865 def dirs():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	866 """Returns an object implementing the ``idirs`` interface."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	867
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	868 def hasdir(dir):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	869 """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	870
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	871 def matches(match):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	872 """Generate a new manifest filtered through a matcher.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	873
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	874 Returns an object conforming to the ``imanifestdict`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	875 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	876
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	877 def walk(match):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	878 """Generator of paths in manifest satisfying a matcher.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	879
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	880 This is equivalent to ``self.matches(match).iterkeys()`` except a new
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	881 manifest object is not created.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	882
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	883 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	884 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	885 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	886
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	887 def diff(other, match=None, clean=False):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	888 """Find differences between this manifest and another.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	889
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	890 This manifest is compared to ``other``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	891
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	892 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	893 matcher and only entries satisfying the matcher are compared.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	894
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	895 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	896 object.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	897
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	898 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	899 the form ``((node1, flag1), (node2, flag2))`` where ``(node1, flag1)``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	900 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	901 are the same for the other manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	902 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	903
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	904 def setflag(path, flag):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	905 """Set the flag value for a given path.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	906
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	907 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	908 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	909
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	910 def get(path, default=None):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	911 """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	912
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	913 def flags(path, default=''):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	914 """Return the flags 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	915
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	916 def copy():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	917 """Return a copy of this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	918
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	919 def items():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	920 """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	921
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	922 def iteritems():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	923 """Identical to items()."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	924
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	925 def iterentries():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	926 """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	927
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	928 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	929 flags.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	930 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	931
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	932 def text():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	933 """Obtain the raw data representation for this manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	934
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	935 Result is used to create a manifest revision.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	936 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	937
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	938 def fastdelta(base, changes):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	939 """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	940
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	941 ``base`` in the raw data representation for another manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	942
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	943 ``changes`` is an iterable of ``(path, to_delete)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	944
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	945 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	946 delta between ``base`` and this manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	947 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	948
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	949 class imanifestrevisionbase(interfaceutil.Interface):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	950 """Base interface representing a single revision of a manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	951
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	952 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	953 as part of a larger interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	954 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	955
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	956 def new():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	957 """Obtain a new manifest instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	958
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	959 Returns an object conforming to the ``imanifestrevisionwritable``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	960 interface. The instance will be associated with the same
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	961 ``imanifestlog`` collection as this instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	962 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	963
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	964 def copy():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	965 """Obtain a copy of this manifest instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	966
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	967 Returns an object conforming to the ``imanifestrevisionwritable``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	968 interface. The instance will be associated with the same
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	969 ``imanifestlog`` collection as this instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	970 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	971
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	972 def read():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	973 """Obtain the parsed manifest data structure.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	974
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	975 The returned object conforms to the ``imanifestdict`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	976 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	977
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	978 class imanifestrevisionstored(imanifestrevisionbase):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	979 """Interface representing a manifest revision committed to storage."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	980
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	981 def node():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	982 """The binary node for this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	983
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	984 parents = interfaceutil.Attribute(
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	985 """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	986 )
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	987
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	988 def readdelta(shallow=False):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	989 """Obtain the manifest data structure representing changes from parent.
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 manifest is compared to its 1st parent. A new manifest representing
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	992 those differences is constructed.
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 The returned object conforms to the ``imanifestdict`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	995 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	996
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	997 def readfast(shallow=False):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	998 """Calls either ``read()`` or ``readdelta()``.
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 The faster of the two options is called.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1001 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1002
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1003 def find(key):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1004 """Calls self.read().find(key)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1005
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1006 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	1007 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1008
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1009 class imanifestrevisionwritable(imanifestrevisionbase):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1010 """Interface representing a manifest revision that can be committed."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1011
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1012 def write(transaction, linkrev, p1node, p2node, added, removed, match=None):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1013 """Add this revision to storage.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1014
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1015 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	1016 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	1017 removed paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1018
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1019 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	1020 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	1021 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	1022 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	1023
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1024 Returns the binary node of the created revision.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1025 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1026
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1027 class imanifeststorage(interfaceutil.Interface):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1028 """Storage interface for manifest data."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1029
39342 57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1030 tree = interfaceutil.Attribute(
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1031 """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	1032
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1033 The empty bytestring represents the root manifest.
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1034 """)
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1035
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1036 index = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1037 """An ``ifilerevisionssequence`` instance.""")
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1038
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1039 indexfile = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1040 """Path of revlog index file.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1041
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1042 TODO this is revlog specific and should not be exposed.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1043 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1044
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1045 opener = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1046 """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	1047
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1048 TODO this is revlog specific and should not be exposed.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1049 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1050
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1051 version = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1052 """Revlog version number.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1053
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1054 TODO this is revlog specific and should not be exposed.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1055 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1056
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1057 _generaldelta = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1058 """Whether generaldelta storage is being used.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1059
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1060 TODO this is revlog specific and should not be exposed.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1061 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1062
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1063 fulltextcache = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1064 """Dict with cache of fulltexts.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1065
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1066 TODO this doesn't feel appropriate for the storage interface.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1067 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1068
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1069 def __len__():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1070 """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	1071
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1072 def __iter__():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1073 """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	1074
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1075 def rev(node):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1076 """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	1077
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1078 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	1079 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1080
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1081 def node(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1082 """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	1083
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1084 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	1085 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1086
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1087 def lookup(value):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1088 """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	1089
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1090 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	1091 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	1092
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1093 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	1094
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1095 TODO this is only used by debug* commands and can probably be deleted
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1096 easily.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1097 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1098
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1099 def parents(node):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1100 """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	1101
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1102 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	1103 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1104
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1105 def parentrevs(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1106 """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	1107
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1108 def linkrev(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1109 """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	1110
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1111 def revision(node, _df=None, raw=False):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1112 """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	1113
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1114 def revdiff(rev1, rev2):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1115 """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	1116
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1117 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	1118 revision data.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1119 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1120
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1121 def cmp(node, fulltext):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1122 """Compare fulltext to another revision.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1123
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1124 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	1125 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1126
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1127 def emitrevisiondeltas(requests):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1128 """Produce ``irevisiondelta`` from ``irevisiondeltarequest``s.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1129
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1130 See the documentation for ``ifiledata`` for more.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1131 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1132
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1133 def addgroup(deltas, linkmapper, transaction, addrevisioncb=None):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1134 """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	1135
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1136 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	1137 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1138
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1139 def getstrippoint(minlink):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1140 """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	1141
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1142 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	1143 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1144
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1145 def strip(minlink, transaction):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1146 """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	1147
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1148 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	1149 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1150
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1151 def checksize():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1152 """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	1153
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1154 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	1155 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1156
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1157 def files():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1158 """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	1159
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1160 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	1161 for this functionality.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1162 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1163
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1164 def deltaparent(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1165 """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	1166
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1167 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	1168 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	1169 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1170
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1171 def clone(tr, dest, **kwargs):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1172 """Clone this instance to another."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1173
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1174 def clearcaches(clear_persisted_data=False):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1175 """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	1176
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1177 def dirlog(d):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1178 """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	1179
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1180 def add(m, transaction, link, p1, p2, added, removed, readtree=None,
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1181 match=None):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1182 """Add a revision to storage.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1183
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1184 ``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	1185
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1186 ``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	1187
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1188 ``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	1189
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1190 ``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	1191 respectively.
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1192
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1193 ``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	1194 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	1195 treemanifets.
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1196
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1197 ``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	1198 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	1199 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	1200 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	1201 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1202
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1203 class imanifestlog(interfaceutil.Interface):
39268 2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1204 """Interface representing a collection of manifest snapshots.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1205
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1206 Represents the root manifest in a repository.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1207
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1208 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	1209 tree manifests.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1210 """
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1211
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1212 def __getitem__(node):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1213 """Obtain a manifest instance for a given binary node.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1214
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1215 Equivalent to calling ``self.get('', node)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1216
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1217 The returned object conforms to the ``imanifestrevisionstored``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1218 interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1219 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1220
39263 43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1221 def get(tree, node, verify=True):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1222 """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	1223
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1224 ``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	1225 the only manifest if flat manifests are being used).
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1226
39263 43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1227 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	1228 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	1229 (requires tree manifests).
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1230
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1231 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	1232 known.
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 The returned object conforms to the ``imanifestrevisionstored``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1235 interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1236 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1237
39272 73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1238 def getstorage(tree):
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1239 """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	1240
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1241 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	1242 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	1243
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1244 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	1245 """
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1246
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1247 def clearcaches():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1248 """Clear caches associated with this collection."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1249
38556 f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1250 def rev(node):
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1251 """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	1252
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1253 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	1254 """
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1255
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1256 class ilocalrepositoryfilestorage(interfaceutil.Interface):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1257 """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	1258
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1259 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	1260 tracked file path.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1261 """
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1262
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1263 def file(f):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1264 """Obtain a filelog for a tracked path.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1265
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1266 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	1267 """
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1268
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1269 class ilocalrepositorymain(interfaceutil.Interface):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1270 """Main interface for local repositories.
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1271
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1272 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	1273 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1274
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1275 supportedformats = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1276 """Set of requirements that apply to stream clone.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1277
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1278 This is actually a class attribute and is shared among all instances.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1279 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1280
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1281 supported = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1282 """Set of requirements that this repo is capable of opening.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1283
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1284 requirements = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1285 """Set of requirements this repo uses.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1286
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1287 features = interfaceutil.Attribute(
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1288 """Set of "features" this repository supports.
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1289
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1290 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	1291 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	1292 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	1293 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	1294 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	1295
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1296 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	1297 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	1298
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1299 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	1300 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	1301 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	1302 and more granular capabilities (which may be derived from requirements).
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1303 """)
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1304
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1305 filtername = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1306 """Name of the repoview that is active on this repo.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1307
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1308 wvfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1309 """VFS used to access the working directory.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1310
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1311 vfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1312 """VFS rooted at the .hg directory.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1313
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1314 Used to access repository data not in the store.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1315 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1316
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1317 svfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1318 """VFS rooted at the store.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1319
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1320 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	1321 But can point elsewhere if the store is shared.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1322 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1323
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1324 root = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1325 """Path to the root of the working directory.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1326
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1327 path = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1328 """Path to the .hg directory.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1329
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1330 origroot = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1331 """The filesystem path that was used to construct the repo.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1332
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1333 auditor = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1334 """A pathauditor for the working directory.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1335
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1336 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	1337
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1338 Operates on the filesystem.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1339 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1340
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1341 nofsauditor = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1342 """A pathauditor for the working directory.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1343
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1344 This is like ``auditor`` except it doesn't do filesystem checks.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1345 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1346
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1347 baseui = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1348 """Original ui instance passed into constructor.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1349
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1350 ui = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1351 """Main ui instance for this instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1352
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1353 sharedpath = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1354 """Path to the .hg directory of the repo this repo was shared from.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1355
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1356 store = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1357 """A store instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1358
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1359 spath = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1360 """Path to the store.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1361
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1362 sjoin = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1363 """Alias to self.store.join.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1364
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1365 cachevfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1366 """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	1367
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1368 Typically .hg/cache.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1369 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1370
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1371 filteredrevcache = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1372 """Holds sets of revisions to be filtered.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1373
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1374 names = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1375 """A ``namespaces`` instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1376
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1377 def close():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1378 """Close the handle on this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1379
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1380 def peer():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1381 """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	1382
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1383 def unfiltered():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1384 """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	1385
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1386 def filtered(name, visibilityexceptions=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1387 """Obtain a named view of this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1388
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1389 obsstore = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1390 """A store of obsolescence data.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1391
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1392 changelog = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1393 """A handle on the changelog revlog.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1394
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1395 manifestlog = interfaceutil.Attribute(
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1396 """An instance conforming to the ``imanifestlog`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1397
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1398 Provides access to manifests for the repository.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1399 """)
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1400
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1401 dirstate = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1402 """Working directory state.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1403
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1404 narrowpats = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1405 """Matcher patterns for this repository's narrowspec.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1406
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1407 def narrowmatch():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1408 """Obtain a matcher for the narrowspec."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1409
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1410 def setnarrowpats(newincludes, newexcludes):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1411 """Define the narrowspec for this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1412
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1413 def __getitem__(changeid):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1414 """Try to resolve a changectx."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1415
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1416 def __contains__(changeid):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1417 """Whether a changeset exists."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1418
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1419 def __nonzero__():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1420 """Always returns True."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1421 return True
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1422
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1423 __bool__ = __nonzero__
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1424
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1425 def __len__():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1426 """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	1427
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1428 def __iter__():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1429 """Iterate over revisions in the changelog."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1430
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1431 def revs(expr, *args):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1432 """Evaluate a revset.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1433
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1434 Emits revisions.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1435 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1436
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1437 def set(expr, *args):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1438 """Evaluate a revset.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1439
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1440 Emits changectx instances.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1441 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1442
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1443 def anyrevs(specs, user=False, localalias=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1444 """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	1445
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1446 def url():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1447 """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	1448
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1449 def hook(name, throw=False, **args):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1450 """Call a hook."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1451
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1452 def tags():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1453 """Return a mapping of tag to node."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1454
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1455 def tagtype(tagname):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1456 """Return the type of a given tag."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1457
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1458 def tagslist():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1459 """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	1460
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1461 def nodetags(node):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1462 """Return the tags associated with a node."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1463
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1464 def nodebookmarks(node):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1465 """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	1466
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1467 def branchmap():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1468 """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	1469
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1470 def revbranchcache():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1471 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1472
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1473 def branchtip(branchtip, ignoremissing=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1474 """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	1475
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1476 def lookup(key):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1477 """Resolve the node for a revision."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1478
37351 fdd22bf6398f localrepo: drop "remote" argument from lookupbranch() (API) Martin von Zweigbergk <martinvonz@google.com> parents: 37320 diff changeset	1479 def lookupbranch(key):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1480 """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	1481
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1482 def known(nodes):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1483 """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	1484
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1485 Returns a list of bools.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1486 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1487
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1488 def local():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1489 """Whether the repository is local."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1490 return True
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1491
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1492 def publishing():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1493 """Whether the repository is a publishing repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1494
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1495 def cancopy():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1496 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1497
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1498 def shared():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1499 """The type of shared repository or None."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1500
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1501 def wjoin(f, *insidef):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1502 """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	1503
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1504 def setparents(p1, p2):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1505 """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	1506
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1507 def filectx(path, changeid=None, fileid=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1508 """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	1509
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1510 def getcwd():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1511 """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	1512
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1513 def pathto(f, cwd=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1514 """Obtain the relative path to a file."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1515
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1516 def adddatafilter(name, fltr):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1517 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1518
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1519 def wread(filename):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1520 """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	1521
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1522 def wwrite(filename, data, flags, backgroundclose=False, **kwargs):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1523 """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	1524
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1525 def wwritedata(filename, data):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1526 """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	1527
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1528 def currenttransaction():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1529 """Obtain the current transaction instance or None."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1530
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1531 def transaction(desc, report=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1532 """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	1533
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1534 def undofiles():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1535 """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	1536
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1537 def recover():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1538 """Roll back an interrupted transaction."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1539
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1540 def rollback(dryrun=False, force=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1541 """Undo the last transaction.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1542
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1543 DANGEROUS.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1544 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1545
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1546 def updatecaches(tr=None, full=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1547 """Warm repo caches."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1548
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1549 def invalidatecaches():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1550 """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	1551
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1552 def invalidatevolatilesets():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1553 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1554
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1555 def invalidatedirstate():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1556 """Invalidate the dirstate."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1557
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1558 def invalidate(clearfilecache=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1559 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1560
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1561 def invalidateall():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1562 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1563
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1564 def lock(wait=True):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1565 """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	1566
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1567 def wlock(wait=True):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1568 """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	1569
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1570 def currentwlock():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1571 """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	1572
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1573 def checkcommitpatterns(wctx, vdirs, match, status, fail):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1574 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1575
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1576 def commit(text='', user=None, date=None, match=None, force=False,
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1577 editor=False, extra=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1578 """Add a new revision to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1579
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1580 def commitctx(ctx, error=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1581 """Commit a commitctx instance to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1582
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1583 def destroying():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1584 """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	1585
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1586 def destroyed():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1587 """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	1588
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1589 def status(node1='.', node2=None, match=None, ignored=False,
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1590 clean=False, unknown=False, listsubrepos=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1591 """Convenience method to call repo[x].status()."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1592
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1593 def addpostdsstatus(ps):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1594 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1595
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1596 def postdsstatus():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1597 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1598
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1599 def clearpostdsstatus():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1600 pass
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 def heads(start=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1603 """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	1604
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1605 def branchheads(branch=None, start=None, closed=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1606 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1607
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1608 def branches(nodes):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1609 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1610
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1611 def between(pairs):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1612 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1613
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1614 def checkpush(pushop):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1615 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1616
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1617 prepushoutgoinghooks = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1618 """util.hooks instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1619
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1620 def pushkey(namespace, key, old, new):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1621 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1622
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1623 def listkeys(namespace):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1624 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1625
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1626 def debugwireargs(one, two, three=None, four=None, five=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1627 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1628
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1629 def savecommitmessage(text):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1630 pass
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1631
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1632 class completelocalrepository(ilocalrepositorymain,
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1633 ilocalrepositoryfilestorage):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1634 """Complete interface for a local repository."""

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/repository.py @ 39856:1f7b3b980af8