This is an archive of the discontinued Mercurial Phabricator instance.

Differential D334

repository: implement generic capability methods on peer class
ClosedPublic

Authored by indygreg on Aug 11 2017, 12:20 AM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGa0aad86b3b6a: repository: implement generic capability methods on peer class
Summary

These methods are part of the peer interface, are generic, and can
be implemented in terms of other members of the peer interface. So we
implement them on the peer base class as a convenience.

The implementation is essentially copied from peer.py. The code
in peer.py will eventually be deleted.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Aug 11 2017, 12:20 AM
durin42 accepted this revision.Aug 11 2017, 2:27 PM
This revision is now accepted and ready to land.Aug 11 2017, 2:27 PM
indygreg updated this revision to Diff 849.Aug 13 2017, 2:18 PM
Closed by commit rHGa0aad86b3b6a: repository: implement generic capability methods on peer class (authored by indygreg). · Explain WhyAug 15 2017, 1:51 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/repository.py (36 lines)

Diff 933

mercurial/repository.py

# repository.py - Interfaces and base classes for repositories and peers. # repository.py - Interfaces and base classes for repositories and peers.
# #
# Copyright 2017 Gregory Szorc <gregory.szorc@gmail.com> # Copyright 2017 Gregory Szorc <gregory.szorc@gmail.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import abc import abc
from .i18n import _
from . import (
error,
)
class _basepeer(object): class _basepeer(object):
"""Represents a "connection" to a repository. """Represents a "connection" to a repository.
This is the base interface for representing a connection to a repository. This is the base interface for representing a connection to a repository.
It holds basic properties and methods applicable to all peer types. It holds basic properties and methods applicable to all peer types.
This is not a complete interface definition and should not be used This is not a complete interface definition and should not be used
outside of this module. outside of this module.
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(self, 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.
"""
caps = self.capabilities()
if name in caps:
return True
name = '%s=' % name
for cap in caps:
if cap.startswith(name):
return cap[len(name):]
return False
def requirecap(self, name, purpose):
"""Require a capability to be present.
Raises a ``CapabilityError`` if the capability isn't present.
"""
if self.capable(name):
return
raise error.CapabilityError(
_('cannot %s; remote repository does not support the %r '
'capability') % (purpose, name))
class legacypeer(peer, _baselegacywirecommands): class legacypeer(peer, _baselegacywirecommands):
"""peer but with support for legacy wire protocol commands.""" """peer but with support for legacy wire protocol commands."""