Small code review

Constants in jsonrpclib.utils have been renamed to respect PEP-8 naming
conventions: string_types => STRING_TYPES, ...

Author: tcalmant

jsonrpclib/SimpleJSONRPCServer.py

@@ -121,7 +121,7 @@ def validate_request(request, json_config):
     params = request.get('params')
     param_types = (utils.ListType, utils.DictType, utils.TupleType)
 
-    if not method or not isinstance(method, utils.string_types) or \
+    if not method or not isinstance(method, utils.STRING_TYPES) or \
             not isinstance(params, param_types):
         # Invalid type of method name or parameters
         fault = Fault(-32600, 'Invalid request parameters or method.',

jsonrpclib/jsonclass.py

@@ -45,8 +45,8 @@
 # ------------------------------------------------------------------------------
 
 # Supported transmitted code
-SUPPORTED_TYPES = (utils.DictType,) + utils.iterable_types \
-    + utils.primitive_types
+SUPPORTED_TYPES = (utils.DictType,) + utils.ITERABLE_TYPES \
+    + utils.PRIMITIVE_TYPES
 
 # Regex of invalid module characters
 INVALID_MODULE_CHARS = r'[^a-zA-Z0-9\_\.]'
@@ -134,11 +134,11 @@ def dump(obj, serialize_method=None, ignore_attribute=None, ignore=None,
                               ignore, config)
 
     # Primitive
-    if isinstance(obj, utils.primitive_types):
+    if isinstance(obj, utils.PRIMITIVE_TYPES):
         return obj
 
     # Iterative
-    elif isinstance(obj, utils.iterable_types):
+    elif isinstance(obj, utils.ITERABLE_TYPES):
         # List, set or tuple
         return [dump(item, serialize_method, ignore_attribute, ignore, config)
                 for item in obj]
@@ -207,11 +207,11 @@ def load(obj, classes=None):
     :return: The loaded object
     """
     # Primitive
-    if isinstance(obj, utils.primitive_types):
+    if isinstance(obj, utils.PRIMITIVE_TYPES):
         return obj
 
     # List, set or tuple
-    elif isinstance(obj, utils.iterable_types):
+    elif isinstance(obj, utils.ITERABLE_TYPES):
         # This comes from a JSON parser, so it can only be a list...
         return [load(entry) for entry in obj]
 
@@ -234,15 +234,13 @@ def load(obj, classes=None):
 
     # Load the class
     json_module_parts = json_module_clean.split('.')
-    json_class = None
     if classes and len(json_module_parts) == 1:
         # Local class name -- probably means it won't work
         try:
             json_class = classes[json_module_parts[0]]
         except KeyError:
             raise TranslationError('Unknown class or module {0}.'
                                    .format(json_module_parts[0]))
-
     else:
         # Module + class
         json_class_name = json_module_parts.pop()
@@ -262,21 +260,18 @@ def load(obj, classes=None):
                                    .format(json_module_tree, json_class_name))
 
     # Create the object
-    new_obj = None
     if isinstance(params, utils.ListType):
         try:
             new_obj = json_class(*params)
         except TypeError as ex:
             raise TranslationError("Error instantiating {0}: {1}"
                                    .format(json_class.__name__, ex))
-
     elif isinstance(params, utils.DictType):
         try:
             new_obj = json_class(**params)
         except TypeError as ex:
             raise TranslationError("Error instantiating {0}: {1}"
                                    .format(json_class.__name__, ex))
-
     else:
         raise TranslationError("Constructor args must be a dict or a list, "
                                "not {0}".format(type(params).__name__))

jsonrpclib/jsonrpc.py

@@ -131,14 +131,12 @@ def jloads(json_string):
         to a Python object, using cjson.
         """
         return cjson.decode(json_string)
-
 except ImportError:
     # pylint: disable=F0401,E0611
     # Use json or simplejson
     try:
         import json
         _logger.debug("Using json as JSON library")
-
     except ImportError:
         try:
             import simplejson as json
@@ -156,7 +154,6 @@ def jdumps(obj, encoding='utf-8'):
             """
             # Python 2 (explicit encoding)
             return json.dumps(obj, encoding=encoding)
-
     else:
         # Python 3
         def jdumps(obj, encoding='utf-8'):
@@ -223,7 +220,8 @@ def feed(self, data):
         """
         self.target.feed(data)
 
-    def close(self):
+    @staticmethod
+    def close():
         """
         Does nothing
         """
@@ -428,7 +426,8 @@ def send_content(self, connection, request_body):
         if request_body:
             connection.send(request_body)
 
-    def getparser(self):
+    @staticmethod
+    def getparser():
         """
         Create an instance of the parser, and attach it to an unmarshalling
         object. Return both objects.
@@ -594,7 +593,6 @@ def __call__(self, attr):
         """
         if attr == "close":
             return self.__close
-
         elif attr == "transport":
             return self.__transport
 
@@ -763,7 +761,8 @@ def __init__(self, results):
         """
         self.results = results
 
-    def __get_result(self, item):
+    @staticmethod
+    def __get_result(item):
         """
         Checks for error and returns the "real" result stored in a MultiCall
         result.
@@ -958,7 +957,7 @@ def request(self, method, params=None):
         :param params: Method parameters
         :return: A JSON-RPC request dictionary
         """
-        if not isinstance(method, utils.string_types):
+        if not isinstance(method, utils.STRING_TYPES):
             raise ValueError('Method name must be a string.')
 
         if not self.id:
@@ -1056,7 +1055,7 @@ def dump(params=None, methodname=None, rpcid=None, version=None,
     if is_response:
         valid_params.append(type(None))
 
-    if isinstance(methodname, utils.string_types) and \
+    if isinstance(methodname, utils.STRING_TYPES) and \
             not isinstance(params, tuple(valid_params)):
         """
         If a method, and params are not in a listish or a Fault,
@@ -1073,7 +1072,7 @@ def dump(params=None, methodname=None, rpcid=None, version=None,
         # pylint: disable=E1103
         return payload.error(params.faultCode, params.faultString, params.data)
 
-    if not isinstance(methodname, utils.string_types) and not is_response:
+    if not isinstance(methodname, utils.STRING_TYPES) and not is_response:
         # Neither a request nor a response
         raise ValueError('Method name must be a string, or is_response '
                          'must be set to True.')

jsonrpclib/utils.py

@@ -40,17 +40,18 @@
 
 if sys.version_info[0] < 3:
     # Python 2
+    # pylint: disable=E1101
     import types
     try:
-        string_types = (
+        STRING_TYPES = (
             types.StringType,
             types.UnicodeType
         )
     except NameError:
         # Python built without unicode support
-        string_types = (types.StringType,)
+        STRING_TYPES = (types.StringType,)
 
-    numeric_types = (
+    NUMERIC_TYPES = (
         types.IntType,
         types.LongType,
         types.FloatType
@@ -60,6 +61,7 @@ def to_bytes(string):
         """
         Converts the given string into bytes
         """
+        # pylint: disable=E0602
         if type(string) is unicode:
             return str(string)
         return string
@@ -74,12 +76,13 @@ def from_bytes(data):
 
 else:
     # Python 3
-    string_types = (
+    # pylint: disable=E1101
+    STRING_TYPES = (
         bytes,
         str
     )
 
-    numeric_types = (
+    NUMERIC_TYPES = (
         int,
         float
     )
@@ -108,15 +111,15 @@ def from_bytes(data):
 ListType = list
 TupleType = tuple
 
-iterable_types = (
+ITERABLE_TYPES = (
     list,
     set, frozenset,
     tuple
 )
 
-value_types = (
+VALUE_TYPES = (
     bool,
     type(None)
 )
 
-primitive_types = string_types + numeric_types + value_types
+PRIMITIVE_TYPES = STRING_TYPES + NUMERIC_TYPES + VALUE_TYPES