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

annotate mercurial/repository.py @ 40028:83146d176c03

localrepo: add repository feature when repo can be stream cloned Right now, the wire protocol server assumes all repository objects can be stream cloned (unless the stream clone feature is disabled via config option). But not all storage backends or repository objects may support stream clone. This commit defines a repository feature denoting whether stream clone is supported. The feature is defined for revlog-based repositories, which should currently be "all repositories." Differential Revision: https://phab.mercurial-scm.org/D4852

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Tue, 02 Oct 2018 12:40:39 -0700
parents	c537144fdbef
children	8e398628a3f2

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'
40028 83146d176c03 localrepo: add repository feature when repo can be stream cloned Gregory Szorc <gregory.szorc@gmail.com> parents: 40022 diff changeset	30 # Repository supports being stream cloned.
83146d176c03 localrepo: add repository feature when repo can be stream cloned Gregory Szorc <gregory.szorc@gmail.com> parents: 40022 diff changeset	31 REPO_FEATURE_STREAM_CLONE = b'streamclone'
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	32
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	33 class ipeerconnection(interfaceutil.Interface):
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	34 """Represents a "connection" to a repository.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	35
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	36 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	37 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	38
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39 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	40 outside of this module.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	41 """
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	42 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	43
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	44 def url():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	45 """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	46
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	47 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	48 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	49 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	50 data leakage.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	51
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	52 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	53 value.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	54 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	55
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	56 def local():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	57 """Returns a local repository instance.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	58
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	59 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	60 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	61 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	62
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	63 def peer():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	64 """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	65
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	66 Most implementations will ``return self``.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	67 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	68
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	69 def canpush():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	70 """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	71
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	72 def close():
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	73 """Close the connection to this peer.
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	74
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	75 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	76 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	77 """
f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	78
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	79 class ipeercapabilities(interfaceutil.Interface):
37610 98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	80 """Peer sub-interface related to capabilities."""
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	81
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	82 def capable(name):
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	83 """Determine support for a named capability.
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 ``False`` if capability not supported.
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	86
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	87 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	88 if capability support is non-boolean.
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 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	91 """
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	92
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	93 def requirecap(name, purpose):
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	94 """Require a capability to be 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 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	97 """
98861a2298b5 repository: split capabilities methods into separate interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37440 diff changeset	98
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	99 class ipeercommands(interfaceutil.Interface):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	100 """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	101
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	102 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	103 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	104 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	105
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	106 def branchmap():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	107 """Obtain heads in named branches.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	108
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	109 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	110 heads on that branch.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	111 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	112
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	113 def capabilities():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	114 """Obtain capabilities of the peer.
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 Returns a set of string capabilities.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	117 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	118
37649 a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	119 def clonebundles():
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	120 """Obtains the clone bundles manifest for the repo.
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 Returns the manifest as unparsed bytes.
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	123 """
a168799687e5 wireproto: properly call clonebundles command Gregory Szorc <gregory.szorc@gmail.com> parents: 37635 diff changeset	124
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	125 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	126 """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	127
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	128 def getbundle(source, **kwargs):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	129 """Obtain remote repository data as a bundle.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	130
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	131 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	132 the peer to the local repository
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 Returns a generator of bundle data.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	135 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	136
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	137 def heads():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	138 """Determine all known head revisions in the peer.
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 Returns an iterable of binary nodes.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	141 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	142
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	143 def known(nodes):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	144 """Determine whether multiple nodes are known.
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 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	147
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	148 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	149 at that index is known to the peer.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	150 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	151
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	152 def listkeys(namespace):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	153 """Obtain all keys in a pushkey namespace.
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 Returns an iterable of key names.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	156 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	157
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	158 def lookup(key):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	159 """Resolve a value to a known revision.
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 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	162 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	163
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	164 def pushkey(namespace, key, old, new):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	165 """Set a value using the ``pushkey`` protocol.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	166
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	167 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	168 the old and new values for that key.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	169
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	170 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	171 namespace.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	172 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	173
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	174 def stream_out():
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	175 """Obtain streaming clone data.
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 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	178 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	179
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	180 def unbundle(bundle, heads, url):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	181 """Transfer repository data to the peer.
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 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	184
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	185 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	186 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	187
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	188 class ipeerlegacycommands(interfaceutil.Interface):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	189 """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	190
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	191 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	192 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	193 legacy, the interfaces are split.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	194 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	195
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	196 def between(pairs):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	197 """Obtain nodes between pairs of nodes.
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 ``pairs`` is an iterable of node pairs.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	200
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	201 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	202 requested pair.
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	203 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	204
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	205 def branches(nodes):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	206 """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	207
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	208 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	209 a DAG root or is a merge.
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 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	212 """
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	213
37635 cc8c06835097 wireproto: convert legacy commands to command executor Gregory Szorc <gregory.szorc@gmail.com> parents: 37633 diff changeset	214 def changegroup(nodes, source):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	215 """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	216
37635 cc8c06835097 wireproto: convert legacy commands to command executor Gregory Szorc <gregory.szorc@gmail.com> parents: 37633 diff changeset	217 def changegroupsubset(bases, heads, source):
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	218 pass
558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	219
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	220 class ipeercommandexecutor(interfaceutil.Interface):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	221 """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	222
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	223 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	224 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	225 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	226 outstanding requests are waited on.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	227 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	228
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	229 def callcommand(name, args):
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	230 """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	231
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	232 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	233
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	234 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	235 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	236 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	237
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	238 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	239 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	240 used and the command itself.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	241
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	242 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	243 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	244
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	245 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	246 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	247 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	248 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	249 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	250
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	251 def sendcommands():
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	252 """Trigger submission of queued command requests.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	253
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	254 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	255 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	256 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	257
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	258 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	259 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	260
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	261 def close():
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	262 """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	263
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	264 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	265 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	266 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	267 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	268 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	269 to finish.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	270
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	271 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	272 context manager.
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 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	275 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	276
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	277 class ipeerrequests(interfaceutil.Interface):
37629 fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	278 """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	279
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	280 def commandexecutor():
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	281 """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	282
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	283 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	284 to the peer.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	285
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	286 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	287 requests.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	288
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	289 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	290 (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	291 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	292 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	293 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	294 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	295 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	296 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	297 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	298 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	299 being issued.
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	300 """
fa0382088993 repository: define new interface for running commands Gregory Szorc <gregory.szorc@gmail.com> parents: 37610 diff changeset	301
37650 62ebfda864de repository: remove ipeercommands from ipeerbase Gregory Szorc <gregory.szorc@gmail.com> parents: 37649 diff changeset	302 class ipeerbase(ipeerconnection, ipeercapabilities, ipeerrequests):
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	303 """Unified interface for peer repositories.
33821 f257943e47ab repository: formalize peer interface with abstract base class Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	304
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	305 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	306 """
33822 558f5b2ee10e repository: formalize wire protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 33821 diff changeset	307
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	308 @interfaceutil.implementer(ipeerbase)
37320 39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	309 class peer(object):
39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	310 """Base class for peer repositories."""
39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	311
39f7d4ee8bcd repository: port peer interfaces to zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37316 diff changeset	312 def capable(self, name):
33823 a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	313 caps = self.capabilities()
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	314 if name in caps:
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	315 return True
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	316
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	317 name = '%s=' % name
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	318 for cap in caps:
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	319 if cap.startswith(name):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	320 return cap[len(name):]
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 return False
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	323
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	324 def requirecap(self, name, purpose):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	325 if self.capable(name):
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	326 return
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	327
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	328 raise error.CapabilityError(
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	329 _('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	330 'capability') % (purpose, name))
a0aad86b3b6a repository: implement generic capability methods on peer class Gregory Szorc <gregory.szorc@gmail.com> parents: 33822 diff changeset	331
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	332 class iverifyproblem(interfaceutil.Interface):
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	333 """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	334
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	335 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	336 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	337
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	338 Instances are essentially messages associated with severity.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	339 """
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	340 warning = interfaceutil.Attribute(
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	341 """Message indicating a non-fatal problem.""")
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	342
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	343 error = interfaceutil.Attribute(
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	344 """Message indicating a fatal problem.""")
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	345
39877 733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	346 node = interfaceutil.Attribute(
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	347 """Revision encountering the problem.
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	348
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	349 ``None`` means the problem doesn't apply to a single revision.
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	350 """)
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	351
39258 b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	352 class irevisiondelta(interfaceutil.Interface):
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	353 """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	354
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	355 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	356 with another repository.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	357
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	358 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	359 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	360 are mutually exclusive.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	361
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	362 Typically used for changegroup generation.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	363 """
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	364
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	365 node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	366 """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	367
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	368 p1node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	369 """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	370
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	371 p2node = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	372 """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	373
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	374 linknode = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	375 """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	376
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	377 flags = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	378 """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	379
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	380 basenode = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	381 """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	382
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	383 ``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	384 a delta.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	385 """)
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	386
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	387 baserevisionsize = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	388 """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	389
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	390 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	391 """)
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 revision = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	394 """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	395
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	396 delta = interfaceutil.Attribute(
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	397 """Delta between ``basenode`` and ``node``.
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	398
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	399 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	400 """)
b518d495a560 repository: formalize interfaces for revision deltas and requests Gregory Szorc <gregory.szorc@gmail.com> parents: 38874 diff changeset	401
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	402 class ifilerevisionssequence(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	403 """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	404
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	405 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	406 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	407 index metadata.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	408
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	409 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	410 in the index.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	411 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	412
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	413 def __len__():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	414 """The total number of revisions."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	415
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	416 def __getitem__(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	417 """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	418
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	419 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	420
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	421 offset+flags
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	422 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	423 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	424 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	425 compressed size
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	426 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	427 needed by the store.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	428 uncompressed size
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	429 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	430 base revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	431 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	432 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	433 link revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	434 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	435 p1 revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	436 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	437 p2 revision
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	438 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	439 node
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	440 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	441
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	442 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	443 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	444 recent revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	445 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	446
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	447 def __contains__(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	448 """Whether a revision number exists."""
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	449
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	450 def insert(self, i, entry):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	451 """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	452
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	453 class ifileindex(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	454 """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	455
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	456 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	457 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	458
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	459 The index logically consists of:
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	460
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	461 * 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	462 * 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	463 * Metadata to facilitate storage.
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 def __len__():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	466 """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	467
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	468 def __iter__():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	469 """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	470
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	471 def revs(start=0, stop=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	472 """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	473
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	474 def parents(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	475 """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	476
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	477 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	478 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	479
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	480 def parentrevs(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	481 """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	482
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	483 def rev(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	484 """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	485
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	486 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	487 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	488
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	489 def node(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	490 """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	491
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	492 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	493 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	494
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	495 def lookup(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	496 """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	497
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	498 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	499 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	500
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	501 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	502 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	503
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	504 def linkrev(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	505 """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	506
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	507 def iscensored(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	508 """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	509
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	510 def commonancestorsheads(node1, node2):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	511 """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	512
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	513 See ``ancestor.commonancestorsheads()``.
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
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	516 def descendants(revs):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	517 """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	518
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	519 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	520 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	521
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	522 def heads(start=None, stop=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	523 """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	524
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	525 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	526 ``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	527 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	528 ``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	529 encountered.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	530 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	531
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	532 def children(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	533 """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	534
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	535 Returns a list of nodes.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	536 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	537
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	538 class ifiledata(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	539 """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	540
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	541 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	542 data for a tracked file.
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 def size(rev):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	545 """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	546
39880 d909c44d29e1 filelog: stop proxying rawsize() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39878 diff changeset	547 Any metadata is excluded from size measurements.
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	548 """
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 def revision(node, raw=False):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	551 """"Obtain fulltext data for a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	552
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	553 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	554 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	555 are not applied.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	556
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	557 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	558 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	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 read(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	562 """Resolve file fulltext data.
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 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	565 headers is stripped.
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
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	568 def renamed(node):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	569 """Obtain copy metadata for a node.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	570
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	571 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	572 (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	573 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	574
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	575 def cmp(node, fulltext):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	576 """Compare fulltext to another revision.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	577
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	578 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	579
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	580 This takes copy metadata into account.
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 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	583 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	584
39867 5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	585 def emitrevisions(nodes,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	586 nodesorder=None,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	587 revisiondata=False,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	588 assumehaveparentrevisions=False,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	589 deltaprevious=False):
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	590 """Produce ``irevisiondelta`` for revisions.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	591
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	592 Given an iterable of nodes, emits objects conforming to the
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	593 ``irevisiondelta`` interface that describe revisions in storage.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	594
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	595 This method is a generator.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	596
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	597 The input nodes may be unordered. Implementations must ensure that a
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	598 node's parents are emitted before the node itself. Transitively, this
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	599 means that a node may only be emitted once all its ancestors in
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	600 ``nodes`` have also been emitted.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	601
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	602 By default, emits "index" data (the ``node``, ``p1node``, and
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	603 ``p2node`` attributes). If ``revisiondata`` is set, revision data
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	604 will also be present on the emitted objects.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	605
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	606 With default argument values, implementations can choose to emit
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	607 either fulltext revision data or a delta. When emitting deltas,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	608 implementations must consider whether the delta's base revision
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	609 fulltext is available to the receiver.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	610
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	611 The base revision fulltext is guaranteed to be available if any of
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	612 the following are met:
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	613
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	614 * Its fulltext revision was emitted by this method call.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	615 * A delta for that revision was emitted by this method call.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	616 * ``assumehaveparentrevisions`` is True and the base revision is a
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	617 parent of the node.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	618
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	619 ``nodesorder`` can be used to control the order that revisions are
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	620 emitted. By default, revisions can be reordered as long as they are
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	621 in DAG topological order (see above). If the value is ``nodes``,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	622 the iteration order from ``nodes`` should be used. If the value is
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	623 ``storage``, then the native order from the backing storage layer
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	624 is used. (Not all storage layers will have strong ordering and behavior
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	625 of this mode is storage-dependent.) ``nodes`` ordering can force
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	626 revisions to be emitted before their ancestors, so consumers should
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	627 use it with care.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	628
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	629 The ``linknode`` attribute on the returned ``irevisiondelta`` may not
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	630 be set and it is the caller's responsibility to resolve it, if needed.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	631
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	632 If ``deltaprevious`` is True and revision data is requested, all
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	633 revision data should be emitted as deltas against the revision
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	634 emitted just prior. The initial revision should be a delta against
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	635 its 1st parent.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	636 """
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	637
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	638 class ifilemutation(interfaceutil.Interface):
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	639 """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	640
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	641 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	642 """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	643
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	644 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	645 and parent nodes.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	646
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	647 Returns the node that was added.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	648
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	649 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	650 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	651
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	652 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	653 flags=0, cachedelta=None):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	654 """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	655
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	656 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	657
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	658 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	659
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	660 ``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	661 the flags to use with storage.
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 ``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	664 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	665 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	666 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	667 """
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 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	670 """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	671
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	672 ``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	673 (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	674 to add.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	675
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	676 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	677 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	678 ``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	679 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	680
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	681 ``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	682
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	683 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	684 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	685 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	686
39794 a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	687 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	688 """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	689
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	690 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	691 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	692 result in failure.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	693
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	694 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	695 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	696 data.
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	697
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	698 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	699 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	700 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	701 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	702 """
a6b3c4c1019f revlog: move censor logic out of censor extension Gregory Szorc <gregory.szorc@gmail.com> parents: 39792 diff changeset	703
37440 4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	704 def getstrippoint(minlink):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	705 """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	706
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	707 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	708 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	709
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	710 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	711 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	712 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	713
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	714 def strip(minlink, transaction):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	715 """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	716
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	717 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	718 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	719
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	720 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	721 higher-level deletion API.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	722 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	723
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	724 class ifilestorage(ifileindex, ifiledata, ifilemutation):
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	725 """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	726
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	727 def files():
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	728 """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	729
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	730 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	731 be a better API for that.
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	732 """
4335a75f0bd0 repository: define existing interface for file storage Gregory Szorc <gregory.szorc@gmail.com> parents: 37351 diff changeset	733
39874 14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	734 def storageinfo(exclusivefiles=False, sharedfiles=False,
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	735 revisionscount=False, trackedsize=False,
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	736 storedsize=False):
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	737 """Obtain information about storage for this file's data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	738
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	739 Returns a dict describing storage for this tracked path. The keys
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	740 in the dict map to arguments of the same. The arguments are bools
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	741 indicating whether to calculate and obtain that data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	742
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	743 exclusivefiles
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	744 Iterable of (vfs, path) describing files that are exclusively
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	745 used to back storage for this tracked path.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	746
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	747 sharedfiles
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	748 Iterable of (vfs, path) describing files that are used to back
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	749 storage for this tracked path. Those files may also provide storage
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	750 for other stored entities.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	751
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	752 revisionscount
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	753 Number of revisions available for retrieval.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	754
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	755 trackedsize
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	756 Total size in bytes of all tracked revisions. This is a sum of the
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	757 length of the fulltext of all revisions.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	758
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	759 storedsize
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	760 Total size in bytes used to store data for all tracked revisions.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	761 This is commonly less than ``trackedsize`` due to internal usage
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	762 of deltas rather than fulltext revisions.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	763
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	764 Not all storage backends may support all queries are have a reasonable
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	765 value to use. In that case, the value should be set to ``None`` and
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	766 callers are expected to handle this special value.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	767 """
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	768
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	769 def verifyintegrity(state):
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	770 """Verifies the integrity of file storage.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	771
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	772 ``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	773 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	774 primitives.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	775
39877 733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	776 If individual revisions cannot have their revision content resolved,
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	777 the method is expected to set the ``skipread`` key to a set of nodes
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	778 that encountered problems.
733db72f0f54 revlog: move revision verification out of verify Gregory Szorc <gregory.szorc@gmail.com> parents: 39874 diff changeset	779
39847 97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	780 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	781 interface.
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	782 """
97986c9c69d3 verify: start to abstract file verification Gregory Szorc <gregory.szorc@gmail.com> parents: 39801 diff changeset	783
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	784 class idirs(interfaceutil.Interface):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	785 """Interface representing a collection of directories from paths.
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 This interface is essentially a derived data structure representing
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	788 directories from a collection of paths.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	791 def addpath(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	792 """Add a path to the collection.
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 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	795 """
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 delpath(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	798 """Remove a path from the 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 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	801 directory is removed from the collection.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	804 def __iter__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	805 """Iterate over the directories in this collection of paths."""
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 __contains__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	808 """Whether a specific directory is in this collection."""
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 class imanifestdict(interfaceutil.Interface):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	811 """Interface representing a manifest data structure.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	812
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	813 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	814 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	815 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	816
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	817 def __getitem__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	818 """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	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 Equivalent to ``self.find(path)[0]``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	823 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	824
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	825 def find(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	826 """Returns the entry for a path in the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	827
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	828 Returns a 2-tuple of (node, flags).
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	829
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	830 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	831 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	832
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	833 def __len__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	834 """Return the number of entries in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	835
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	836 def __nonzero__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	837 """Returns True if the manifest has entries, False otherwise."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	838
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	839 __bool__ = __nonzero__
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 __setitem__(path, node):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	842 """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	843
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	844 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	845 the new entry.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	848 def __contains__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	849 """Whether a path exists in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	850
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	851 def __delitem__(path):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	852 """Remove a path from the manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	853
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	854 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	855 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	856
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	857 def __iter__():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	858 """Iterate over paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	859
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	860 def iterkeys():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	861 """Iterate over paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	862
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	863 def keys():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	864 """Obtain a list of paths in the manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	865
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	866 def filesnotin(other, match=None):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	867 """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	868
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	869 ``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	870 manifests.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	871
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	872 Returns a set of paths.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	875 def dirs():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	876 """Returns an object implementing the ``idirs`` interface."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	877
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	878 def hasdir(dir):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	879 """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	880
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	881 def matches(match):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	882 """Generate a new manifest filtered through a matcher.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	883
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	884 Returns an object conforming to the ``imanifestdict`` interface.
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 walk(match):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	888 """Generator of paths in manifest satisfying a matcher.
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 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	891 manifest object is not created.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	892
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	893 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	894 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	895 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	896
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	897 def diff(other, match=None, clean=False):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	898 """Find differences between this manifest and another.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	899
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	900 This manifest is compared to ``other``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	901
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	902 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	903 matcher and only entries satisfying the matcher are compared.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	904
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	905 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	906 object.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	907
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	908 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	909 the form ``((node1, flag1), (node2, flag2))`` where ``(node1, flag1)``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	910 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	911 are the same for the other manifest.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	914 def setflag(path, flag):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	915 """Set the flag value for a given path.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	916
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	917 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	918 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	919
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	920 def get(path, default=None):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	921 """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	922
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	923 def flags(path, default=''):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	924 """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	925
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	926 def copy():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	927 """Return a copy of this manifest."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	928
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	929 def items():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	930 """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	931
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	932 def iteritems():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	933 """Identical to items()."""
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 def iterentries():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	936 """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	937
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	938 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	939 flags.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	942 def text():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	943 """Obtain the raw data representation for this manifest.
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 Result is used to create a manifest revision.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	946 """
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 def fastdelta(base, changes):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	949 """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	950
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	951 ``base`` in the raw data representation for another manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	952
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	953 ``changes`` is an iterable of ``(path, to_delete)``.
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 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	956 delta between ``base`` and this manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	957 """
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 class imanifestrevisionbase(interfaceutil.Interface):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	960 """Base interface representing a single revision of a manifest.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	961
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	962 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	963 as part of a larger interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	964 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	965
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	966 def new():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	967 """Obtain a new manifest instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	968
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	969 Returns an object conforming to the ``imanifestrevisionwritable``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	970 interface. The instance will be associated with the same
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	971 ``imanifestlog`` collection as this instance.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	972 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	973
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	974 def copy():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	975 """Obtain a copy of this manifest instance.
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 Returns an object conforming to the ``imanifestrevisionwritable``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	978 interface. The instance will be associated with the same
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	979 ``imanifestlog`` collection as this instance.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	982 def read():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	983 """Obtain the parsed manifest data structure.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	984
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	985 The returned object conforms to the ``imanifestdict`` interface.
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 class imanifestrevisionstored(imanifestrevisionbase):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	989 """Interface representing a manifest revision committed to storage."""
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 def node():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	992 """The binary node for this manifest."""
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 parents = interfaceutil.Attribute(
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	995 """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	996 )
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	997
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	998 def readdelta(shallow=False):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	999 """Obtain the manifest data structure representing changes from parent.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1000
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1001 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	1002 those differences is constructed.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1003
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1004 The returned object conforms to the ``imanifestdict`` interface.
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
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1007 def readfast(shallow=False):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1008 """Calls either ``read()`` or ``readdelta()``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1009
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1010 The faster of the two options is called.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1011 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1012
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1013 def find(key):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1014 """Calls self.read().find(key)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1015
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1016 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	1017 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1018
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1019 class imanifestrevisionwritable(imanifestrevisionbase):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1020 """Interface representing a manifest revision that can be committed."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1021
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1022 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	1023 """Add this revision to storage.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1024
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1025 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	1026 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	1027 removed paths.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1028
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1029 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	1030 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	1031 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	1032 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	1033
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1034 Returns the binary node of the created revision.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1035 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1036
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1037 class imanifeststorage(interfaceutil.Interface):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1038 """Storage interface for manifest data."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1039
39342 57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1040 tree = interfaceutil.Attribute(
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1041 """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	1042
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1043 The empty bytestring represents the root manifest.
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1044 """)
57c3864f3aad manifest: make tree a public attribute Gregory Szorc <gregory.szorc@gmail.com> parents: 39341 diff changeset	1045
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1046 index = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1047 """An ``ifilerevisionssequence`` instance.""")
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1048
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1049 indexfile = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1050 """Path of revlog index file.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1051
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1052 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	1053 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1054
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1055 opener = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1056 """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	1057
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1058 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	1059 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1060
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1061 version = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1062 """Revlog version number.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1063
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1064 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	1065 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1066
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1067 _generaldelta = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1068 """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	1069
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1070 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	1071 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1072
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1073 fulltextcache = interfaceutil.Attribute(
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1074 """Dict with cache of fulltexts.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1075
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1076 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	1077 """)
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1078
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1079 def __len__():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1080 """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	1081
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1082 def __iter__():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1083 """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	1084
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1085 def rev(node):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1086 """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	1087
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1088 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	1089 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1090
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1091 def node(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1092 """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	1093
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1094 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	1095 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1096
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1097 def lookup(value):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1098 """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	1099
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1100 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	1101 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	1102
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1103 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	1104 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1105
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1106 def parents(node):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1107 """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	1108
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1109 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	1110 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1111
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1112 def parentrevs(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1113 """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	1114
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1115 def linkrev(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1116 """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	1117
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1118 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	1119 """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	1120
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1121 def revdiff(rev1, rev2):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1122 """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	1123
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1124 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	1125 revision data.
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
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1128 def cmp(node, fulltext):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1129 """Compare fulltext to another revision.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1130
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1131 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	1132 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1133
39867 5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1134 def emitrevisions(nodes,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1135 nodesorder=None,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1136 revisiondata=False,
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1137 assumehaveparentrevisions=False):
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1138 """Produce ``irevisiondelta`` describing revisions.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1139
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1140 See the documentation for ``ifiledata`` for more.
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1141 """
5a9ab91e0a45 revlog: new API to emit revision data Gregory Szorc <gregory.szorc@gmail.com> parents: 39865 diff changeset	1142
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1143 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	1144 """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	1145
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1146 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	1147 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1148
39863 9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1149 def rawsize(rev):
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1150 """Obtain the size of tracked data.
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1151
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1152 Is equivalent to ``len(m.revision(node, raw=True))``.
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1153
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1154 TODO this method is only used by upgrade code and may be removed.
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1155 """
9534fe1e5d28 manifest: add rawsize() proxy (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39856 diff changeset	1156
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1157 def getstrippoint(minlink):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1158 """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	1159
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1160 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	1161 """
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 def strip(minlink, transaction):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1164 """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	1165
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1166 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	1167 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1168
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1169 def checksize():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1170 """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	1171
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1172 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	1173 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1174
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1175 def files():
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1176 """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	1177
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1178 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	1179 for this functionality.
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1180 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1181
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1182 def deltaparent(rev):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1183 """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	1184
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1185 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	1186 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	1187 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1188
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1189 def clone(tr, dest, **kwargs):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1190 """Clone this instance to another."""
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1191
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1192 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	1193 """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	1194
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1195 def dirlog(d):
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1196 """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	1197
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1198 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	1199 match=None):
39341 7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1200 """Add a revision to storage.
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 ``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	1203
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1204 ``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	1205
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1206 ``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	1207
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1208 ``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	1209 respectively.
39684 24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1210
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1211 ``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	1212 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	1213 treemanifets.
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1214
24870f1be088 narrow: when writing treemanifests, skip inspecting directories outside narrow spectral <spectral@google.com> parents: 39342 diff changeset	1215 ``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	1216 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	1217 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	1218 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	1219 """
7f5e6d3e9032 manifest: proxy to revlog instance instead of inheriting Gregory Szorc <gregory.szorc@gmail.com> parents: 39272 diff changeset	1220
39874 14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1221 def storageinfo(exclusivefiles=False, sharedfiles=False,
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1222 revisionscount=False, trackedsize=False,
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1223 storedsize=False):
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1224 """Obtain information about storage for this manifest's data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1225
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1226 See ``ifilestorage.storageinfo()`` for a description of this method.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1227 This one behaves the same way, except for manifest data.
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1228 """
14e500b58263 revlog: add method for obtaining storage info (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39872 diff changeset	1229
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1230 class imanifestlog(interfaceutil.Interface):
39268 2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1231 """Interface representing a collection of manifest snapshots.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1232
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1233 Represents the root manifest in a repository.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1234
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1235 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	1236 tree manifests.
2af6b2d8d1d8 repository: clarify role of imanifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 39263 diff changeset	1237 """
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1238
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1239 def __getitem__(node):
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1240 """Obtain a manifest instance for a given binary node.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1241
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1242 Equivalent to calling ``self.get('', node)``.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1243
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1244 The returned object conforms to the ``imanifestrevisionstored``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1245 interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1246 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1247
39263 43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1248 def get(tree, node, verify=True):
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1249 """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	1250
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1251 ``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	1252 the only manifest if flat manifests are being used).
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1253
39263 43387fd2aa1f manifest: rename dir to tree to avoid shadowing built-in Gregory Szorc <gregory.szorc@gmail.com> parents: 39262 diff changeset	1254 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	1255 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	1256 (requires tree manifests).
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1257
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1258 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	1259 known.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1260
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1261 The returned object conforms to the ``imanifestrevisionstored``
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1262 interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1263 """
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1264
39272 73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1265 def getstorage(tree):
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1266 """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	1267
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1268 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	1269 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	1270
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1271 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	1272 """
73cf21b2e8a6 manifest: add getstorage() to manifestlog and use it globally Gregory Szorc <gregory.szorc@gmail.com> parents: 39269 diff changeset	1273
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1274 def clearcaches():
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1275 """Clear caches associated with this collection."""
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1276
38556 f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1277 def rev(node):
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1278 """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	1279
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1280 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	1281 """
f2f9bacf0587 manifest: define and implement rev() on manifestlog Gregory Szorc <gregory.szorc@gmail.com> parents: 38532 diff changeset	1282
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1283 class ilocalrepositoryfilestorage(interfaceutil.Interface):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1284 """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	1285
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1286 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	1287 tracked file path.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1288 """
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1289
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1290 def file(f):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1291 """Obtain a filelog for a tracked path.
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1292
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1293 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	1294 """
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1295
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1296 class ilocalrepositorymain(interfaceutil.Interface):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1297 """Main interface for local repositories.
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1298
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1299 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	1300 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1301
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1302 supportedformats = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1303 """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	1304
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1305 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	1306 """)
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 supported = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1309 """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	1310
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1311 requirements = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1312 """Set of requirements this repo uses.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1313
39855 d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1314 features = interfaceutil.Attribute(
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1315 """Set of "features" this repository supports.
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1316
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1317 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	1318 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	1319 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	1320 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	1321 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	1322
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1323 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	1324 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	1325
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1326 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	1327 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	1328 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	1329 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	1330 """)
d89d5bc06eaa localrepo: define "features" on repository instances (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 39849 diff changeset	1331
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1332 filtername = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1333 """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	1334
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1335 wvfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1336 """VFS used to access the working directory.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1337
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1338 vfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1339 """VFS rooted at the .hg directory.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1340
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1341 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	1342 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1343
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1344 svfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1345 """VFS rooted at the store.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1346
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1347 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	1348 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	1349 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1350
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1351 root = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1352 """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	1353
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1354 path = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1355 """Path to the .hg directory.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1356
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1357 origroot = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1358 """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	1359
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1360 auditor = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1361 """A pathauditor for the working directory.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1362
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1363 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	1364
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1365 Operates on the filesystem.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1366 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1367
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1368 nofsauditor = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1369 """A pathauditor for the working directory.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1370
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1371 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	1372 """)
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 baseui = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1375 """Original ui instance passed into constructor.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1376
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1377 ui = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1378 """Main ui instance for this instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1379
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1380 sharedpath = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1381 """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	1382
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1383 store = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1384 """A store instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1385
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1386 spath = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1387 """Path to the store.""")
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 sjoin = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1390 """Alias to self.store.join.""")
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 cachevfs = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1393 """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	1394
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1395 Typically .hg/cache.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1396 """)
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1397
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1398 filteredrevcache = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1399 """Holds sets of revisions to be filtered.""")
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 names = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1402 """A ``namespaces`` instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1403
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1404 def close():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1405 """Close the handle on this repository."""
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 peer():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1408 """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	1409
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1410 def unfiltered():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1411 """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	1412
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1413 def filtered(name, visibilityexceptions=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1414 """Obtain a named view of this repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1415
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1416 obsstore = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1417 """A store of obsolescence data.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1418
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1419 changelog = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1420 """A handle on the changelog revlog.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1421
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1422 manifestlog = interfaceutil.Attribute(
38532 c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1423 """An instance conforming to the ``imanifestlog`` interface.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1424
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1425 Provides access to manifests for the repository.
c82ea938efbb repository: define manifest interfaces Gregory Szorc <gregory.szorc@gmail.com> parents: 38513 diff changeset	1426 """)
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1427
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1428 dirstate = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1429 """Working directory state.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1430
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1431 narrowpats = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1432 """Matcher patterns for this repository's narrowspec.""")
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 def narrowmatch():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1435 """Obtain a matcher for the narrowspec."""
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 setnarrowpats(newincludes, newexcludes):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1438 """Define the narrowspec for this repository."""
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 def __getitem__(changeid):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1441 """Try to resolve a changectx."""
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 __contains__(changeid):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1444 """Whether a changeset exists."""
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 __nonzero__():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1447 """Always returns True."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1448 return True
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1449
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1450 __bool__ = __nonzero__
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 __len__():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1453 """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	1454
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1455 def __iter__():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1456 """Iterate over revisions in the changelog."""
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 revs(expr, *args):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1459 """Evaluate a revset.
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 Emits revisions.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1462 """
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 set(expr, *args):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1465 """Evaluate a revset.
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 Emits changectx instances.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1468 """
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 anyrevs(specs, user=False, localalias=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1471 """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	1472
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1473 def url():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1474 """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	1475
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1476 def hook(name, throw=False, **args):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1477 """Call a hook."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1478
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1479 def tags():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1480 """Return a mapping of tag to node."""
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 tagtype(tagname):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1483 """Return the type of a given tag."""
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 def tagslist():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1486 """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	1487
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1488 def nodetags(node):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1489 """Return the tags associated with a node."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1490
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1491 def nodebookmarks(node):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1492 """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	1493
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1494 def branchmap():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1495 """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	1496
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1497 def revbranchcache():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1498 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1499
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1500 def branchtip(branchtip, ignoremissing=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1501 """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	1502
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1503 def lookup(key):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1504 """Resolve the node for a revision."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1505
37351 fdd22bf6398f localrepo: drop "remote" argument from lookupbranch() (API) Martin von Zweigbergk <martinvonz@google.com> parents: 37320 diff changeset	1506 def lookupbranch(key):
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1507 """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	1508
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1509 def known(nodes):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1510 """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	1511
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1512 Returns a list of bools.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1513 """
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1514
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1515 def local():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1516 """Whether the repository is local."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1517 return True
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 publishing():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1520 """Whether the repository is a publishing repository."""
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 cancopy():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1523 pass
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 shared():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1526 """The type of shared repository or None."""
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 wjoin(f, *insidef):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1529 """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	1530
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1531 def setparents(p1, p2):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1532 """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	1533
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1534 def filectx(path, changeid=None, fileid=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1535 """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	1536
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1537 def getcwd():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1538 """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	1539
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1540 def pathto(f, cwd=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1541 """Obtain the relative path to a file."""
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 def adddatafilter(name, fltr):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1544 pass
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 wread(filename):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1547 """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	1548
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1549 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	1550 """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	1551
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1552 def wwritedata(filename, data):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1553 """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	1554
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1555 def currenttransaction():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1556 """Obtain the current transaction instance or None."""
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 transaction(desc, report=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1559 """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	1560
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1561 def undofiles():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1562 """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	1563
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1564 def recover():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1565 """Roll back an interrupted transaction."""
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 rollback(dryrun=False, force=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1568 """Undo the last transaction.
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 DANGEROUS.
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1571 """
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 updatecaches(tr=None, full=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1574 """Warm repo caches."""
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 invalidatecaches():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1577 """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	1578
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1579 def invalidatevolatilesets():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1580 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1581
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1582 def invalidatedirstate():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1583 """Invalidate the dirstate."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1584
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1585 def invalidate(clearfilecache=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1586 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1587
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1588 def invalidateall():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1589 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1590
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1591 def lock(wait=True):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1592 """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	1593
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1594 def wlock(wait=True):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1595 """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	1596
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1597 def currentwlock():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1598 """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	1599
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1600 def checkcommitpatterns(wctx, vdirs, match, status, fail):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1601 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1602
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1603 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	1604 editor=False, extra=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1605 """Add a new revision to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1606
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1607 def commitctx(ctx, error=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1608 """Commit a commitctx instance to the repository."""
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1609
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1610 def destroying():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1611 """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	1612
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1613 def destroyed():
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1614 """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	1615
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1616 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	1617 clean=False, unknown=False, listsubrepos=False):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1618 """Convenience method to call repo[x].status()."""
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 addpostdsstatus(ps):
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 postdsstatus():
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 clearpostdsstatus():
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 heads(start=None):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1630 """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	1631
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1632 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	1633 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1634
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1635 def branches(nodes):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1636 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1637
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1638 def between(pairs):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1639 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1640
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1641 def checkpush(pushop):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1642 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1643
37810 856f381ad74b interfaceutil: module to stub out zope.interface Gregory Szorc <gregory.szorc@gmail.com> parents: 37650 diff changeset	1644 prepushoutgoinghooks = interfaceutil.Attribute(
37183 0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1645 """util.hooks instance.""")
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1646
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1647 def pushkey(namespace, key, old, new):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1648 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1649
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1650 def listkeys(namespace):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1651 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1652
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1653 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	1654 pass
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1655
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1656 def savecommitmessage(text):
0dfb5672f015 repository: define interface for local repositories Gregory Szorc <gregory.szorc@gmail.com> parents: 33823 diff changeset	1657 pass
39780 e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1658
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1659 class completelocalrepository(ilocalrepositorymain,
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1660 ilocalrepositoryfilestorage):
e4e881572382 localrepo: iteratively derive local repository type Gregory Szorc <gregory.szorc@gmail.com> parents: 39716 diff changeset	1661 """Complete interface for a local repository."""
40022 c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1662
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1663 class iwireprotocolcommandcacher(interfaceutil.Interface):
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1664 """Represents a caching backend for wire protocol commands.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1665
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1666 Wire protocol version 2 supports transparent caching of many commands.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1667 To leverage this caching, servers can activate objects that cache
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1668 command responses. Objects handle both cache writing and reading.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1669 This interface defines how that response caching mechanism works.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1670
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1671 Wire protocol version 2 commands emit a series of objects that are
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1672 serialized and sent to the client. The caching layer exists between
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1673 the invocation of the command function and the sending of its output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1674 objects to an output layer.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1675
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1676 Instances of this interface represent a binding to a cache that
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1677 can serve a response (in place of calling a command function) and/or
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1678 write responses to a cache for subsequent use.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1679
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1680 When a command request arrives, the following happens with regards
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1681 to this interface:
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1682
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1683 1. The server determines whether the command request is cacheable.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1684 2. If it is, an instance of this interface is spawned.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1685 3. The cacher is activated in a context manager (``__enter__`` is called).
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1686 4. A cache key for that request is derived. This will call the
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1687 instance's ``adjustcachekeystate()`` method so the derivation
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1688 can be influenced.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1689 5. The cacher is informed of the derived cache key via a call to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1690 ``setcachekey()``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1691 6. The cacher's ``lookup()`` method is called to test for presence of
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1692 the derived key in the cache.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1693 7. If ``lookup()`` returns a hit, that cached result is used in place
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1694 of invoking the command function. ``__exit__`` is called and the instance
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1695 is discarded.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1696 8. The command function is invoked.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1697 9. ``onobject()`` is called for each object emitted by the command
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1698 function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1699 10. After the final object is seen, ``onoutputfinished()`` is called.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1700 11. ``__exit__`` is called to signal the end of use of the instance.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1701
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1702 Cache key derivation can be influenced by the instance.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1703
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1704 Cache keys are initially derived by a deterministic representation of
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1705 the command request. This includes the command name, arguments, protocol
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1706 version, etc. This initial key derivation is performed by CBOR-encoding a
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1707 data structure and feeding that output into a hasher.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1708
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1709 Instances of this interface can influence this initial key derivation
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1710 via ``adjustcachekeystate()``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1711
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1712 The instance is informed of the derived cache key via a call to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1713 ``setcachekey()``. The instance must store the key locally so it can
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1714 be consulted on subsequent operations that may require it.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1715
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1716 When constructed, the instance has access to a callable that can be used
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1717 for encoding response objects. This callable receives as its single
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1718 argument an object emitted by a command function. It returns an iterable
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1719 of bytes chunks representing the encoded object. Unless the cacher is
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1720 caching native Python objects in memory or has a way of reconstructing
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1721 the original Python objects, implementations typically call this function
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1722 to produce bytes from the output objects and then store those bytes in
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1723 the cache. When it comes time to re-emit those bytes, they are wrapped
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1724 in a ``wireprototypes.encodedresponse`` instance to tell the output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1725 layer that they are pre-encoded.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1726
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1727 When receiving the objects emitted by the command function, instances
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1728 can choose what to do with those objects. The simplest thing to do is
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1729 re-emit the original objects. They will be forwarded to the output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1730 layer and will be processed as if the cacher did not exist.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1731
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1732 Implementations could also choose to not emit objects - instead locally
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1733 buffering objects or their encoded representation. They could then emit
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1734 a single "coalesced" object when ``onoutputfinished()`` is called. In
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1735 this way, the implementation would function as a filtering layer of
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1736 sorts.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1737
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1738 When caching objects, typically the encoded form of the object will
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1739 be stored. Keep in mind that if the original object is forwarded to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1740 the output layer, it will need to be encoded there as well. For large
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1741 output, this redundant encoding could add overhead. Implementations
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1742 could wrap the encoded object data in ``wireprototypes.encodedresponse``
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1743 instances to avoid this overhead.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1744 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1745 def __enter__():
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1746 """Marks the instance as active.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1747
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1748 Should return self.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1749 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1750
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1751 def __exit__(exctype, excvalue, exctb):
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1752 """Called when cacher is no longer used.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1753
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1754 This can be used by implementations to perform cleanup actions (e.g.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1755 disconnecting network sockets, aborting a partially cached response.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1756 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1757
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1758 def adjustcachekeystate(state):
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1759 """Influences cache key derivation by adjusting state to derive key.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1760
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1761 A dict defining the state used to derive the cache key is passed.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1762
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1763 Implementations can modify this dict to record additional state that
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1764 is wanted to influence key derivation.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1765
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1766 Implementations are highly encouraged to not modify or delete
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1767 existing keys.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1768 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1769
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1770 def setcachekey(key):
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1771 """Record the derived cache key for this request.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1772
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1773 Instances may mutate the key for internal usage, as desired. e.g.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1774 instances may wish to prepend the repo name, introduce path
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1775 components for filesystem or URL addressing, etc. Behavior is up to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1776 the cache.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1777
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1778 Returns a bool indicating if the request is cacheable by this
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1779 instance.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1780 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1781
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1782 def lookup():
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1783 """Attempt to resolve an entry in the cache.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1784
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1785 The instance is instructed to look for the cache key that it was
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1786 informed about via the call to ``setcachekey()``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1787
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1788 If there's no cache hit or the cacher doesn't wish to use the cached
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1789 entry, ``None`` should be returned.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1790
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1791 Else, a dict defining the cached result should be returned. The
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1792 dict may have the following keys:
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1793
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1794 objs
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1795 An iterable of objects that should be sent to the client. That
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1796 iterable of objects is expected to be what the command function
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1797 would return if invoked or an equivalent representation thereof.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1798 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1799
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1800 def onobject(obj):
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1801 """Called when a new object is emitted from the command function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1802
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1803 Receives as its argument the object that was emitted from the
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1804 command function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1805
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1806 This method returns an iterator of objects to forward to the output
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1807 layer. The easiest implementation is a generator that just
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1808 ``yield obj``.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1809 """
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1810
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1811 def onfinished():
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1812 """Called after all objects have been emitted from the command function.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1813
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1814 Implementations should return an iterator of objects to forward to
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1815 the output layer.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1816
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1817 This method can be a generator.
c537144fdbef wireprotov2: support response caching Gregory Szorc <gregory.szorc@gmail.com> parents: 40003 diff changeset	1818 """

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/repository.py @ 40028:83146d176c03