( )⚙ D3255 repository: split capabilities methods into separate interface

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3255

repository: split capabilities methods into separate interface
ClosedPublic

Authored by indygreg on Apr 11 2018, 7:42 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG98861a2298b5: repository: split capabilities methods into separate interface
Summary

So we can implement them without having to implement support for
every command.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Apr 11 2018, 7:42 PM
durin42 accepted this revision.Apr 12 2018, 6:21 PM
This revision is now accepted and ready to land.Apr 12 2018, 6:21 PM
Closed by commit rHG98861a2298b5: repository: split capabilities methods into separate interface (authored by indygreg). · Explain WhyApr 12 2018, 6:23 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/repository.py (37 lines)

Diff 8021

mercurial/repository.py

def close(): def close():
"""Close the connection to this peer. """Close the connection to this peer.
This is called when the peer will no longer be used. Resources This is called when the peer will no longer be used. Resources
associated with the peer should be cleaned up. associated with the peer should be cleaned up.
""" """
class ipeercapabilities(zi.Interface):
"""Peer sub-interface related to capabilities."""
def capable(name):
"""Determine support for a named capability.
Returns ``False`` if capability not supported.
Returns ``True`` if boolean capability is supported. Returns a string
if capability support is non-boolean.
Capability strings may or may not map to wire protocol capabilities.
"""
def requirecap(name, purpose):
"""Require a capability to be present.
Raises a ``CapabilityError`` if the capability isn't present.
"""
class ipeercommands(zi.Interface): class ipeercommands(zi.Interface):
"""Client-side interface for communicating over the wire protocol. """Client-side interface for communicating over the wire protocol.
This interface is used as a gateway to the Mercurial wire protocol. This interface is used as a gateway to the Mercurial wire protocol.
methods commonly call wire protocol commands of the same name. methods commonly call wire protocol commands of the same name.
""" """
def branchmap(): def branchmap():
""" """
def changegroup(nodes, kind): def changegroup(nodes, kind):
"""Obtain a changegroup with data for descendants of specified nodes.""" """Obtain a changegroup with data for descendants of specified nodes."""
def changegroupsubset(bases, heads, kind): def changegroupsubset(bases, heads, kind):
pass pass
class ipeerbase(ipeerconnection, ipeercommands): class ipeerbase(ipeerconnection, ipeercapabilities, ipeercommands):
"""Unified interface for peer repositories. """Unified interface for peer repositories.
All peer instances must conform to this interface. All peer instances must conform to this interface.
""" """
def iterbatch(): def iterbatch():
"""Obtain an object to be used for multiple method calls. """Obtain an object to be used for multiple method calls.
Various operations call several methods on peer instances. If each Various operations call several methods on peer instances. If each
perform all queued batchable method calls. A ``results()`` method perform all queued batchable method calls. A ``results()`` method
exposes the results of queued/batched method calls. It is a generator exposes the results of queued/batched method calls. It is a generator
of results in the order they were called. of results in the order they were called.
Not all peers or wire protocol implementations may actually batch method Not all peers or wire protocol implementations may actually batch method
calls. However, they must all support this API. calls. However, they must all support this API.
""" """
def capable(name):
"""Determine support for a named capability.
Returns ``False`` if capability not supported.
Returns ``True`` if boolean capability is supported. Returns a string
if capability support is non-boolean.
"""
def requirecap(name, purpose):
"""Require a capability to be present.
Raises a ``CapabilityError`` if the capability isn't present.
"""
class ipeerbaselegacycommands(ipeerbase, ipeerlegacycommands): class ipeerbaselegacycommands(ipeerbase, ipeerlegacycommands):
"""Unified peer interface that supports legacy commands.""" """Unified peer interface that supports legacy commands."""
@zi.implementer(ipeerbase) @zi.implementer(ipeerbase)
class peer(object): class peer(object):
"""Base class for peer repositories.""" """Base class for peer repositories."""
def capable(self, name): def capable(self, name):