D2065: wireprotoserver: rename abstractserverproto and improve docstring

indygreg (Gregory Szorc) phabricator at mercurial-scm.org
Tue Feb 6 16:04:54 EST 2018


indygreg created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REVISION SUMMARY
  The docstring isn't completely accurate for the current state
  of the world. But it does describe the direction future patches
  will be taking things.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D2065

AFFECTED FILES
  mercurial/wireprotoserver.py

CHANGE DETAILS

diff --git a/mercurial/wireprotoserver.py b/mercurial/wireprotoserver.py
--- a/mercurial/wireprotoserver.py
+++ b/mercurial/wireprotoserver.py
@@ -32,10 +32,13 @@
 HGTYPE2 = 'application/mercurial-0.2'
 HGERRTYPE = 'application/hg-error'
 
-class abstractserverproto(object):
-    """abstract class that summarizes the protocol API
+class baseprotocolhandler(object):
+    """Abstract base class for wire protocol handlers.
 
-    Used as reference and documentation.
+    A wire protocol handler serves as an interface between protocol command
+    handlers and the wire protocol transport layer. Protocol handlers provide
+    methods to read command arguments, redirect stdio for the duration of
+    the request, handle response types, etc.
     """
 
     __metaclass__ = abc.ABCMeta
@@ -98,7 +101,7 @@
 
     return ''.join(chunks)
 
-class webproto(abstractserverproto):
+class webproto(baseprotocolhandler):
     def __init__(self, req, ui):
         self._req = req
         self._ui = ui
@@ -327,7 +330,7 @@
 
     return ''
 
-class sshserver(abstractserverproto):
+class sshserver(baseprotocolhandler):
     def __init__(self, ui, repo):
         self._ui = ui
         self._repo = repo



To: indygreg, #hg-reviewers
Cc: mercurial-devel


More information about the Mercurial-devel mailing list