Fixed Docstrings to apply PEP 257 convention

Author: dongsam

ethereum/__init__.py

@@ -42,7 +42,7 @@
 
 # ########### endversion ##################
 
-'''from ethereum import utils
+"""from ethereum import utils
 from ethereum import trie
 from ethereum import securetrie
 from ethereum import blocks
@@ -51,4 +51,4 @@
 from ethereum import tester
 from ethereum import abi
 from ethereum import keys
-from ethereum import ethash'''
+from ethereum import ethash"""

ethereum/abi.py

@@ -135,7 +135,7 @@ def event_id(name, encode_types):
 
 
 def decint(n, signed=False):  # pylint: disable=invalid-name,too-many-branches
-    ''' Decode an unsigned/signed integer. '''
+    """ Decode an unsigned/signed integer. """
 
     if isinstance(n, str):
         n = utils.to_string(n)
@@ -185,7 +185,7 @@ def decint(n, signed=False):  # pylint: disable=invalid-name,too-many-branches
 
 
 def encode_single(typ, arg):  # pylint: disable=too-many-return-statements,too-many-branches,too-many-statements,too-many-locals
-    ''' Encode `arg` as `typ`.
+    """ Encode `arg` as `typ`.
 
     `arg` will be encoded in a best effort manner, were necessary the function
     will try to correctly define the underlying binary representation (ie.
@@ -223,7 +223,7 @@ def encode_single(typ, arg):  # pylint: disable=too-many-return-statements,too-m
     Note:
         This function don't work with array types, for that use the `enc`
         function.
-    '''
+    """
     base, sub, _ = typ
 
     if base == 'uint':

ethereum/experimental/pruning_trie.py

@@ -168,9 +168,9 @@ def unpack_to_nibbles(bindata):
 
 
 def starts_with(full, part):
-    ''' test whether the items in the part is
+    """ test whether the items in the part is
     the leading items of the full
-    '''
+    """
     if len(full) < len(part):
         return False
     return full[:len(part)] == part
@@ -200,11 +200,11 @@ def transient_trie_exception(*args):
 class Trie(object):
 
     def __init__(self, db, root_hash=BLANK_ROOT, transient=False):
-        '''it also present a dictionary like interface
+        """it also present a dictionary like interface
 
         :param db key value database
         :root: blank or trie node in form of [key, value] or [v0,v1..v15,v]
-        '''
+        """
         self.db = db  # Pass in a database object directly
         self.transient = transient
         if self.transient:
@@ -215,11 +215,11 @@ def __init__(self, db, root_hash=BLANK_ROOT, transient=False):
         self.journal = []
 
     # def __init__(self, dbfile, root_hash=BLANK_ROOT):
-    #     '''it also present a dictionary like interface
+    #     """it also present a dictionary like interface
 
     #     :param dbfile: key value database
     #     :root: blank or trie node in form of [key, value] or [v0,v1..v15,v]
-    #     '''
+    #     """
     #     if isinstance(dbfile, str):
     #         dbfile = os.path.abspath(dbfile)
     #         self.db = DB(dbfile)
@@ -251,8 +251,8 @@ def spv_storing(self, node):
 
     @property
     def root_hash(self):
-        '''always empty or a 32 bytes string
-        '''
+        """always empty or a 32 bytes string
+        """
         return self.get_root_hash()
 
     def get_root_hash(self):
@@ -311,8 +311,8 @@ def all_nodes(self, node=None):
         # return o
 
     def clear(self):
-        ''' clear all tree data
-        '''
+        """ clear all tree data
+        """
         self._delete_child_storage(self.root_node)
         self._delete_node_storage(self.root_node)
         self.root_node = BLANK_NODE
@@ -349,11 +349,11 @@ def _decode_to_node(self, encoded):
         return o
 
     def _get_node_type(self, node):
-        ''' get node type and content
+        """ get node type and content
 
         :param node: node in form of list, or BLANK_NODE
         :return: node type
-        '''
+        """
         if node == BLANK_NODE:
             return NODE_TYPE_BLANK
 
@@ -603,9 +603,9 @@ def prev(self, key):
         return nibbles_to_bin(o) if o else None
 
     def _delete_node_storage(self, node, is_root=False):
-        '''delete storage
+        """delete storage
         :param node: node in form of list, or BLANK_NODE
-        '''
+        """
         if node == BLANK_NODE:
             return
         # assert isinstance(node, list)
@@ -645,8 +645,8 @@ def _delete(self, node, key):
 
     def _normalize_branch_node(self, node):
         # sys.stderr.write('nbn\n')
-        '''node should have only one item changed
-        '''
+        """node should have only one item changed
+        """
         not_blank_items_count = sum(1 for x in range(17) if node[x])
         assert not_blank_items_count >= 1
 
@@ -772,9 +772,9 @@ def _delete_kv_node(self, node, key):
         assert False
 
     def delete(self, key):
-        '''
+        """
         :param key: a string with length of [0, 32]
-        '''
+        """
         if not is_string(key):
             raise Exception("Key must be string")
 
@@ -808,10 +808,10 @@ def clear_all(self, node=None):
                 self.clear_all(self._decode_to_node(node[i]))
 
     def _get_size(self, node):
-        '''Get counts of (key, value) stored in this and the descendant nodes
+        """Get counts of (key, value) stored in this and the descendant nodes
 
         :param node: node in form of list, or BLANK_NODE
-        '''
+        """
         if node == BLANK_NODE:
             return 0
 
@@ -830,15 +830,15 @@ def _get_size(self, node):
             return sum(sizes)
 
     def _to_dict(self, node):
-        '''convert (key, value) stored in this and the descendant nodes
+        """convert (key, value) stored in this and the descendant nodes
         to dict items.
 
         :param node: node in form of list, or BLANK_NODE
 
         .. note::
 
             Here key is in full form, rather than key of the individual node
-        '''
+        """
         if node == BLANK_NODE:
             return {}
 
@@ -894,12 +894,12 @@ def iter_branch(self):
             yield key, value
 
     def _iter_branch(self, node):
-        '''yield (key, value) stored in this and the descendant nodes
+        """yield (key, value) stored in this and the descendant nodes
         :param node: node in form of list, or BLANK_NODE
 
         .. note::
             Here key is in full form, rather than key of the individual node
-        '''
+        """
         if node == BLANK_NODE:
             raise StopIteration
 
@@ -949,10 +949,10 @@ def __contains__(self, key):
         return self.get(key) != BLANK_NODE
 
     def update(self, key, value):
-        '''
+        """
         :param key: a string
         :value: a string
-        '''
+        """
         if not is_string(key):
             raise Exception("Key must be string")
 

ethereum/trie.py

@@ -112,9 +112,9 @@ def unpack_to_nibbles(bindata):
 
 
 def starts_with(full, part):
-    ''' test whether the items in the part is
+    """ test whether the items in the part is
     the leading items of the full
-    '''
+    """
     if len(full) < len(part):
         return False
     return full[:len(part)] == part
@@ -140,20 +140,20 @@ def is_key_value_type(node_type):
 class Trie(object):
 
     def __init__(self, db, root_hash=BLANK_ROOT):
-        '''it also present a dictionary like interface
+        """it also present a dictionary like interface
 
         :param db key value database
         :root: blank or trie node in form of [key, value] or [v0,v1..v15,v]
-        '''
+        """
         self.db = db  # Pass in a database object directly
         self.set_root_hash(root_hash)
 
     # def __init__(self, dbfile, root_hash=BLANK_ROOT):
-    #     '''it also present a dictionary like interface
+    #     """it also present a dictionary like interface
 
     #     :param dbfile: key value database
     #     :root: blank or trie node in form of [key, value] or [v0,v1..v15,v]
-    #     '''
+    #     """
     #     if isinstance(dbfile, str):
     #         dbfile = os.path.abspath(dbfile)
     #         self.db = DB(dbfile)
@@ -163,8 +163,8 @@ def __init__(self, db, root_hash=BLANK_ROOT):
 
     @property
     def root_hash(self):
-        '''always empty or a 32 bytes string
-        '''
+        """always empty or a 32 bytes string
+        """
         return self._root_hash
 
     def get_root_hash(self):
@@ -191,8 +191,8 @@ def set_root_hash(self, root_hash):
         self._root_hash = root_hash
 
     def clear(self):
-        ''' clear all tree data
-        '''
+        """ clear all tree data
+        """
         self._delete_child_storage(self.root_node)
         self._delete_node_storage(self.root_node)
         self.root_node = BLANK_NODE
@@ -227,11 +227,11 @@ def _decode_to_node(self, encoded):
         return o
 
     def _get_node_type(self, node):
-        ''' get node type and content
+        """ get node type and content
 
         :param node: node in form of list, or BLANK_NODE
         :return: node type
-        '''
+        """
         if node == BLANK_NODE:
             return NODE_TYPE_BLANK
 
@@ -592,9 +592,9 @@ def prev(self, key):
         return nibbles_to_bin(without_terminator(o)) if o else None
 
     def _delete_node_storage(self, node):
-        '''delete storage
+        """delete storage
         :param node: node in form of list, or BLANK_NODE
-        '''
+        """
         if node == BLANK_NODE:
             return
         # assert isinstance(node, list)
@@ -631,8 +631,8 @@ def _delete(self, node, key):
             return self._delete_kv_node(node, key)
 
     def _normalize_branch_node(self, node):
-        '''node should have only one item changed
-        '''
+        """node should have only one item changed
+        """
         not_blank_items_count = sum(1 for x in range(17) if node[x])
         assert not_blank_items_count >= 1
 
@@ -729,9 +729,9 @@ def _delete_kv_node(self, node, key):
         assert False
 
     def delete(self, key):
-        '''
+        """
         :param key: a string with length of [0, 32]
-        '''
+        """
         if not is_string(key):
             raise Exception("Key must be string")
 
@@ -744,10 +744,10 @@ def delete(self, key):
         self._update_root_hash()
 
     def _get_size(self, node):
-        '''Get counts of (key, value) stored in this and the descendant nodes
+        """Get counts of (key, value) stored in this and the descendant nodes
 
         :param node: node in form of list, or BLANK_NODE
-        '''
+        """
         if node == BLANK_NODE:
             return 0
 
@@ -766,12 +766,12 @@ def _get_size(self, node):
             return sum(sizes)
 
     def _iter_branch(self, node):
-        '''yield (key, value) stored in this and the descendant nodes
+        """yield (key, value) stored in this and the descendant nodes
         :param node: node in form of list, or BLANK_NODE
 
         .. note::
             Here key is in full form, rather than key of the individual node
-        '''
+        """
         if node == BLANK_NODE:
             raise StopIteration
 
@@ -809,15 +809,15 @@ def iter_branch(self):
             yield key, value
 
     def _to_dict(self, node):
-        '''convert (key, value) stored in this and the descendant nodes
+        """convert (key, value) stored in this and the descendant nodes
         to dict items.
 
         :param node: node in form of list, or BLANK_NODE
 
         .. note::
 
             Here key is in full form, rather than key of the individual node
-        '''
+        """
         if node == BLANK_NODE:
             return {}
 
@@ -885,10 +885,10 @@ def __contains__(self, key):
         return self.get(key) != BLANK_NODE
 
     def update(self, key, value):
-        '''
+        """
         :param key: a string
         :value: a string
-        '''
+        """
         if not is_string(key):
             raise Exception("Key must be string")