upstream/mercurial-mirror Commit - r37828:856f381a

interfaceutil: module to stub out zope.interface...

Gregory Szorc -

r37828:856f381a stable

parent child

mercurial/utils/interfaceutil.py

0 created 644 +40 0

@@ -0,0 +1,40 b''
	1	# interfaceutil.py - Utilities for declaring interfaces.
	2	#
	3	# Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>
	4	#
	5	# This software may be used and distributed according to the terms of the
	6	# GNU General Public License version 2 or any later version.
	7
	8	# zope.interface imposes a run-time cost due to module import overhead and
	9	# bookkeeping for declaring interfaces. So, we use stubs for various
	10	# zope.interface primitives unless instructed otherwise.
	11
	12	from __future__ import absolute_import
	13
	14	from .. import (
	15	encoding,
	16	)
	17
	18	if encoding.environ.get('HGREALINTERFACES'):
	19	from ..thirdparty.zope import (
	20	interface as zi,
	21	)
	22
	23	Attribute = zi.Attribute
	24	Interface = zi.Interface
	25	implementer = zi.implementer
	26	else:
	27	class Attribute(object):
	28	def __init__(self, __name__, __doc__=''):
	29	pass
	30
	31	class Interface(object):
	32	def __init__(self, name, bases=(), attrs=None, __doc__=None,
	33	__module__=None):
	34	pass
	35
	36	def implementer(*ifaces):
	37	def wrapper(cls):
	38	return cls
	39
	40	return wrapper

mercurial/filelog.py

0 +4 -4

             from __future__ import absolute_import
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 error,
                 repository,
                 revlog,
             )
+            from .utils import (
+                interfaceutil,
+            )
-            @zi.implementer(repository.ifilestorage)
+            @interfaceutil.implementer(repository.ifilestorage)
             class filelog(object):
                 def __init__(self, opener, path):
                     self._revlog = revlog.revlog(opener,

mercurial/httppeer.py

0 +7 -6

             from .thirdparty import (
                 cbor,
             )
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 bundle2,
                 error,
                 wireprotov2peer,
                 wireprotov2server,
             )
+            from .utils import (
+                interfaceutil,
+            )
             httplib = util.httplib
             urlerr = util.urlerr
                     # will resolve to Future.result.
                     return self.result(timeout)
-            @zi.implementer(repository.ipeercommandexecutor)
+            @interfaceutil.implementer(repository.ipeercommandexecutor)
             class httpv2executor(object):
                 def __init__(self, ui, opener, requestbuilder, apiurl, descriptor):
                     self._ui = ui
                         pass
             # TODO implement interface for version 2 peers
-            @zi.implementer(repository.ipeerconnection, repository.ipeercapabilities,
+            @interfaceutil.implementer(repository.ipeerconnection,
-                            repository.ipeerrequests)
+                                       repository.ipeercapabilities,
+                                       repository.ipeerrequests)
             class httpv2peer(object):
                 def __init__(self, ui, repourl, apipath, opener, requestbuilder,
                              apidescriptor):

mercurial/localrepo.py

0 +5 -7

                 nullid,
                 short,
             )
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 bookmarks,
                 branchmap,
                 vfs as vfsmod,
             )
             from .utils import (
+                interfaceutil,
                 procutil,
                 stringutil,
             )
                           'unbundle'}
             legacycaps = moderncaps.union({'changegroupsubset'})
-            @zi.implementer(repository.ipeercommandexecutor)
+            @interfaceutil.implementer(repository.ipeercommandexecutor)
             class localcommandexecutor(object):
                 def __init__(self, peer):
                     self._peer = peer
                 def close(self):
                     self._closed = True
-            @zi.implementer(repository.ipeercommands)
+            @interfaceutil.implementer(repository.ipeercommands)
             class localpeer(repository.peer):
                 '''peer for a local repo; reflects only the most recent API'''
                 # End of peer interface.
-            @zi.implementer(repository.ipeerlegacycommands)
+            @interfaceutil.implementer(repository.ipeerlegacycommands)
             class locallegacypeer(localpeer):
                 '''peer extension which implements legacy methods too; used for tests with
                 restricted capabilities'''
             # set to reflect that the extension knows how to handle that requirements.
             featuresetupfuncs = set()
-            @zi.implementer(repository.completelocalrepository)
+            @interfaceutil.implementer(repository.completelocalrepository)
             class localrepository(object):
                 # obsolete experimental requirements:

mercurial/repository.py

0 +48 -48

             from __future__ import absolute_import
             from .i18n import _
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 error,
             )
+            from .utils import (
+                interfaceutil,
+            )
-            class ipeerconnection(zi.Interface):
+            class ipeerconnection(interfaceutil.Interface):
                 """Represents a "connection" to a repository.
                 This is the base interface for representing a connection to a repository.
                 This is not a complete interface definition and should not be used
                 outside of this module.
                 """
-                ui = zi.Attribute("""ui.ui instance""")
+                ui = interfaceutil.Attribute("""ui.ui instance""")
                 def url():
                     """Returns a URL string representing this peer.
                     associated with the peer should be cleaned up.
                     """
-            class ipeercapabilities(zi.Interface):
+            class ipeercapabilities(interfaceutil.Interface):
                 """Peer sub-interface related to capabilities."""
                 def capable(name):
                     Raises a ``CapabilityError`` if the capability isn't present.
                     """
-            class ipeercommands(zi.Interface):
+            class ipeercommands(interfaceutil.Interface):
                 """Client-side interface for communicating over the wire protocol.
                 This interface is used as a gateway to the Mercurial wire protocol.
                     Returns the integer number of heads added to the peer.
                     """
-            class ipeerlegacycommands(zi.Interface):
+            class ipeerlegacycommands(interfaceutil.Interface):
                 """Interface for implementing support for legacy wire protocol commands.
                 Wire protocol commands transition to legacy status when they are no longer
                 def changegroupsubset(bases, heads, source):
                     pass
-            class ipeercommandexecutor(zi.Interface):
+            class ipeercommandexecutor(interfaceutil.Interface):
                 """Represents a mechanism to execute remote commands.
                 This is the primary interface for requesting that wire protocol commands
                     This method may call ``sendcommands()`` if there are buffered commands.
                     """
-            class ipeerrequests(zi.Interface):
+            class ipeerrequests(interfaceutil.Interface):
                 """Interface for executing commands on a peer."""
                 def commandexecutor():
                 All peer instances must conform to this interface.
                 """
-            @zi.implementer(ipeerbase)
+            @interfaceutil.implementer(ipeerbase)
             class peer(object):
                 """Base class for peer repositories."""
                         _('cannot %s; remote repository does not support the %r '
                           'capability') % (purpose, name))
-            class ifilerevisionssequence(zi.Interface):
+            class ifilerevisionssequence(interfaceutil.Interface):
                 """Contains index data for all revisions of a file.
                 Types implementing this behave like lists of tuples. The index
                 def insert(self, i, entry):
                     """Add an item to the index at specific revision."""
-            class ifileindex(zi.Interface):
+            class ifileindex(interfaceutil.Interface):
                 """Storage interface for index data of a single file.
                 File storage data is divided into index metadata and data storage.
                 * DAG data (storing and querying the relationship between nodes).
                 * Metadata to facilitate storage.
                 """
-                index = zi.Attribute(
+                index = interfaceutil.Attribute(
                     """An ``ifilerevisionssequence`` instance.""")
                 def __len__():
                 def candelta(baserev, rev):
                     """"Whether a delta can be generated between two revisions."""
-            class ifiledata(zi.Interface):
+            class ifiledata(interfaceutil.Interface):
                 """Storage interface for data storage of a specific file.
                 This complements ``ifileindex`` and provides an interface for accessing
                     revision data.
                     """
-            class ifilemutation(zi.Interface):
+            class ifilemutation(interfaceutil.Interface):
                 """Storage interface for mutation events of a tracked file."""
                 def add(filedata, meta, transaction, linkrev, p1, p2):
             class ifilestorage(ifileindex, ifiledata, ifilemutation):
                 """Complete storage interface for a single tracked file."""
-                version = zi.Attribute(
+                version = interfaceutil.Attribute(
                     """Version number of storage.
                     TODO this feels revlog centric and could likely be removed.
                     """)
-                storedeltachains = zi.Attribute(
+                storedeltachains = interfaceutil.Attribute(
                     """Whether the store stores deltas.
                     TODO deltachains are revlog centric. This can probably removed
                     data.
                     """)
-                _generaldelta = zi.Attribute(
+                _generaldelta = interfaceutil.Attribute(
                     """Whether deltas can be against any parent revision.
                     TODO this is used by changegroup code and it could probably be
                     TODO this is used by verify and it should not be part of the interface.
                     """
-            class completelocalrepository(zi.Interface):
+            class completelocalrepository(interfaceutil.Interface):
                 """Monolithic interface for local repositories.
                 This currently captures the reality of things - not how things should be.
                 """
-                supportedformats = zi.Attribute(
+                supportedformats = interfaceutil.Attribute(
                     """Set of requirements that apply to stream clone.
                     This is actually a class attribute and is shared among all instances.
                     """)
-                openerreqs = zi.Attribute(
+                openerreqs = interfaceutil.Attribute(
                     """Set of requirements that are passed to the opener.
                     This is actually a class attribute and is shared among all instances.
                     """)
-                supported = zi.Attribute(
+                supported = interfaceutil.Attribute(
                     """Set of requirements that this repo is capable of opening.""")
-                requirements = zi.Attribute(
+                requirements = interfaceutil.Attribute(
                     """Set of requirements this repo uses.""")
-                filtername = zi.Attribute(
+                filtername = interfaceutil.Attribute(
                     """Name of the repoview that is active on this repo.""")
-                wvfs = zi.Attribute(
+                wvfs = interfaceutil.Attribute(
                     """VFS used to access the working directory.""")
-                vfs = zi.Attribute(
+                vfs = interfaceutil.Attribute(
                     """VFS rooted at the .hg directory.
                     Used to access repository data not in the store.
                     """)
-                svfs = zi.Attribute(
+                svfs = interfaceutil.Attribute(
                     """VFS rooted at the store.
                     Used to access repository data in the store. Typically .hg/store.
                     But can point elsewhere if the store is shared.
                     """)
-                root = zi.Attribute(
+                root = interfaceutil.Attribute(
                     """Path to the root of the working directory.""")
-                path = zi.Attribute(
+                path = interfaceutil.Attribute(
                     """Path to the .hg directory.""")
-                origroot = zi.Attribute(
+                origroot = interfaceutil.Attribute(
                     """The filesystem path that was used to construct the repo.""")
-                auditor = zi.Attribute(
+                auditor = interfaceutil.Attribute(
                     """A pathauditor for the working directory.
                     This checks if a path refers to a nested repository.
                     Operates on the filesystem.
                     """)
-                nofsauditor = zi.Attribute(
+                nofsauditor = interfaceutil.Attribute(
                     """A pathauditor for the working directory.
                     This is like ``auditor`` except it doesn't do filesystem checks.
                     """)
-                baseui = zi.Attribute(
+                baseui = interfaceutil.Attribute(
                     """Original ui instance passed into constructor.""")
-                ui = zi.Attribute(
+                ui = interfaceutil.Attribute(
                     """Main ui instance for this instance.""")
-                sharedpath = zi.Attribute(
+                sharedpath = interfaceutil.Attribute(
                     """Path to the .hg directory of the repo this repo was shared from.""")
-                store = zi.Attribute(
+                store = interfaceutil.Attribute(
                     """A store instance.""")
-                spath = zi.Attribute(
+                spath = interfaceutil.Attribute(
                     """Path to the store.""")
-                sjoin = zi.Attribute(
+                sjoin = interfaceutil.Attribute(
                     """Alias to self.store.join.""")
-                cachevfs = zi.Attribute(
+                cachevfs = interfaceutil.Attribute(
                     """A VFS used to access the cache directory.
                     Typically .hg/cache.
                     """)
-                filteredrevcache = zi.Attribute(
+                filteredrevcache = interfaceutil.Attribute(
                     """Holds sets of revisions to be filtered.""")
-                names = zi.Attribute(
+                names = interfaceutil.Attribute(
                     """A ``namespaces`` instance.""")
                 def close():
                 def filtered(name, visibilityexceptions=None):
                     """Obtain a named view of this repository."""
-                obsstore = zi.Attribute(
+                obsstore = interfaceutil.Attribute(
                     """A store of obsolescence data.""")
-                changelog = zi.Attribute(
+                changelog = interfaceutil.Attribute(
                     """A handle on the changelog revlog.""")
-                manifestlog = zi.Attribute(
+                manifestlog = interfaceutil.Attribute(
                     """A handle on the root manifest revlog.""")
-                dirstate = zi.Attribute(
+                dirstate = interfaceutil.Attribute(
                     """Working directory state.""")
-                narrowpats = zi.Attribute(
+                narrowpats = interfaceutil.Attribute(
                     """Matcher patterns for this repository's narrowspec.""")
                 def narrowmatch():
                 def checkpush(pushop):
                     pass
-                prepushoutgoinghooks = zi.Attribute(
+                prepushoutgoinghooks = interfaceutil.Attribute(
                     """util.hooks instance.""")
                 def pushkey(namespace, key, old, new):

mercurial/wireprotoserver.py

0 +3 -5

             from .thirdparty import (
                 cbor,
             )
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 encoding,
                 error,
                 wireprotov2server,
             )
             from .utils import (
+                interfaceutil,
                 procutil,
             )
                 return ''.join(chunks)
-            @zi.implementer(wireprototypes.baseprotocolhandler)
+            @interfaceutil.implementer(wireprototypes.baseprotocolhandler)
             class httpv1protocolhandler(object):
                 def __init__(self, req, ui, checkperm):
                     self._req = req
                 fout.write(b'\n')
                 fout.flush()
-            @zi.implementer(wireprototypes.baseprotocolhandler)
+            @interfaceutil.implementer(wireprototypes.baseprotocolhandler)
             class sshv1protocolhandler(object):
                 """Handler for requests services via version 1 of SSH protocol."""
                 def __init__(self, ui, fin, fout):

mercurial/wireprototypes.py

0 +5 -5

                 bin,
                 hex,
             )
-            from .thirdparty.zope import (
-                interface as zi,
             from .i18n import _
             from . import (
                 error,
                 util,
             )
+            from .utils import (
+                interfaceutil,
+            )
             # Names of the SSH protocol implementations.
             SSHV1 = 'ssh-v1'
                 'stream': 'boolean',
             }
-            class baseprotocolhandler(zi.Interface):
+            class baseprotocolhandler(interfaceutil.Interface):
                 """Abstract base class for wire protocol handlers.
                 A wire protocol handler serves as an interface between protocol command
                 the request, handle response types, etc.
                 """
-                name = zi.Attribute(
+                name = interfaceutil.Attribute(
                     """The name of the protocol implementation.
                     Used for uniquely identifying the transport type.

mercurial/wireprotov1peer.py

0 +6 -5

             from .node import (
                 bin,
             )
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 bundle2,
                 changegroup as changegroupmod,
                 util,
                 wireprototypes,
             )
+            from .utils import (
+                interfaceutil,
+            )
             urlreq = util.urlreq
                     # on that.
                     return self.result(timeout)
-            @zi.implementer(repository.ipeercommandexecutor)
+            @interfaceutil.implementer(repository.ipeercommandexecutor)
             class peerexecutor(object):
                 def __init__(self, peer):
                     self._peer = peer
                         else:
                             f.set_result(result)
-            @zi.implementer(repository.ipeercommands, repository.ipeerlegacycommands)
+            @interfaceutil.implementer(repository.ipeercommands,
+                                       repository.ipeerlegacycommands)
             class wirepeer(repository.peer):
                 """Client-side interface for communicating with a peer repository.

mercurial/wireprotov2server.py

0 +4 -4

             from .thirdparty import (
                 cbor,
             )
-            from .thirdparty.zope import (
-                interface as zi,
             from . import (
                 encoding,
                 error,
                 wireprotoframing,
                 wireprototypes,
             )
+            from .utils import (
+                interfaceutil,
+            )
             FRAMINGTYPE = b'application/mercurial-exp-framing-0005'
                 return func(repo, proto, **args)
-            @zi.implementer(wireprototypes.baseprotocolhandler)
+            @interfaceutil.implementer(wireprototypes.baseprotocolhandler)
             class httpv2protocolhandler(object):
                 def __init__(self, req, ui, args=None):
                     self._req = req

tests/test-check-interfaces.py

0 +3 0

             from __future__ import absolute_import, print_function
+            from mercurial import encoding
+            encoding.environ[b'HGREALINTERFACES'] = b'1'
             import os
             from mercurial.thirdparty.zope import (

tests/test-check-module-imports.t

0 +1 0

               > -X i18n/posplit \
               > -X mercurial/thirdparty \
               > -X tests/hypothesishelpers.py \
+              > -X tests/test-check-interfaces.py \
               > -X tests/test-commit-interactive.t \
               > -X tests/test-contrib-check-code.t \
               > -X tests/test-demandimport.py \

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages