Merge pull request #5 from SAP/small-correct

correct minor typos, unused import, coding convention

Author: bobevenup

sap/cf_logging/__init__.py

@@ -11,8 +11,8 @@
 
 __version__ = '3.0.1'
 
-_setup_done = False # pylint: disable=invalid-name
-framework = None # pylint: disable=invalid-name
+_setup_done = False  # pylint: disable=invalid-name
+framework = None  # pylint: disable=invalid-name
 
 
 class CfLogger(logging.Logger):
@@ -24,7 +24,7 @@ class CfLogger(logging.Logger):
     def makeRecord(self, name, level, fn, lno, msg, args, exc_info,
                    func=None, extra=None, *_args, **_kwargs):
         """ Returns SimpleLogMessage or a RequestWebRecord depending on the extra variable """
-        #check what record type this is
+        # check what record type this is
         cls = None
         if extra is not None and REQUEST_KEY in extra and RESPONSE_KEY in extra:
             cls = RequestWebRecord
@@ -39,10 +39,10 @@ def init(cfl_framework=None, level=defaults.DEFAULT_LOGGING_LEVEL):
     """ Initialize function. It sets up the logging library to output JSON
         formatted messages.
 
-        Optional arugments framework to use and logging.level
+        Optional arguments framework to use and logging.level
     """
-    global framework # pylint: disable=global-statement,invalid-name
-    global _setup_done # pylint: disable=global-statement,invalid-name
+    global framework  # pylint: disable=global-statement,invalid-name
+    global _setup_done  # pylint: disable=global-statement,invalid-name
     if _setup_done:
         raise RuntimeError('cf_logging already initialized')
 

sap/cf_logging/core/context.py

@@ -1,10 +1,13 @@
 """ Module Context """
 
+
 class Context(object):
     """ Class for getting and setting context variables """
+
     def set(self, key, value, request):
-        """ Store session varaible """
+        """ Store session variable """
         raise NotImplementedError
+
     def get(self, key, request):
         """ Get session variable """
         raise NotImplementedError

sap/cf_logging/core/framework.py

@@ -7,14 +7,17 @@
 if sys.version_info[0] == 3:
     _STRClass = str
 else:
-    _STRClass = basestring # pylint: disable=undefined-variable,invalid-name
+    _STRClass = basestring  # pylint: disable=undefined-variable,invalid-name
+
 
 def _check_instance(obj, clazz):
     if not isinstance(obj, clazz):
         raise TypeError('Provided object is not valid {}'.format(clazz.__name__))
 
+
 class Framework(object):
     """ Framework class holds Context, RequestReader, ResponseReader """
+
     def __init__(self, name, context, request_reader, response_reader):
         if not name or not isinstance(name, _STRClass):
             raise TypeError('Provided name is not valid string')

sap/cf_logging/core/request_reader.py

@@ -1,14 +1,15 @@
 """ request_reader provides an interface for the RequestReader class """
 import uuid
 
-
 CORRELATION_ID_HEADERS = ['X-Correlation-ID',
                           'X-CorrelationID', 'X-Request-ID', 'X-Vcap-Request-Id']
 
+
 class RequestReader(object):
     """
         Helper class for extracting logging-relevant information from HTTP request object
     """
+
     def get_correlation_id(self, request):
         """
         We assume that the request is a valid request object.
@@ -41,7 +42,6 @@ def get_http_header(self, request, header_name, default=None):
             return request.headers.get(header_name)
         return default
 
-
     def get_remote_user(self, request):
         """
 

sap/cf_logging/core/response_reader.py

@@ -1,4 +1,6 @@
 """ Module for the ResponseReader class """
+
+
 class ResponseReader(object):
     """
         Helper class for extracting logging-relevant information from HTTP response object

sap/cf_logging/flask_logging/__init__.py

@@ -3,7 +3,6 @@
 - Produces info request log entry per request
 """
 import logging
-import sys
 from datetime import datetime
 from functools import wraps
 import flask

sap/cf_logging/flask_logging/response_reader.py

@@ -1,5 +1,5 @@
 """ Flask response reader """
-from  cf_logging.core.response_reader import ResponseReader
+from cf_logging.core.response_reader import ResponseReader
 
 
 class FlaskResponseReader(ResponseReader):

sap/cf_logging/formatters/json_formatter.py

@@ -10,6 +10,7 @@ def _encode(obj):
     def _encode(obj):
         return unicode(json.dumps(obj))  # pylint: disable=undefined-variable
 
+
 class JsonFormatter(logging.Formatter):
     """
     Formatter for non-web application log

sap/cf_logging/record/simple_log_record.py

@@ -5,7 +5,6 @@
 from sap.cf_logging.record import application_info
 from sap.cf_logging.record import util
 
-
 _SKIP_ATTRIBUTES = ["type", "written_at", "written_ts", "correlation_id", "remote_user", "referer",
                     "x_forwarded_for", "protocol", "method", "remote_ip", "request_size_b",
                     "remote_host", "remote_port", "request_received_at", "direction",
@@ -15,6 +14,7 @@
 
 class SimpleLogRecord(logging.LogRecord):
     """ SimpleLogRecord class holds data for user logged messages """
+
     # pylint: disable=too-many-arguments,too-many-locals
 
     def __init__(self, extra, framework, *args, **kwargs):
@@ -32,8 +32,8 @@ def __init__(self, extra, framework, *args, **kwargs):
 
         self.correlation_id = correlation_id or '-'
 
-        self.extra = dict((key, value) for key, value in extra.items() \
-            if key not in _SKIP_ATTRIBUTES) if extra else {}
+        self.extra = dict((key, value) for key, value in extra.items()
+                          if key not in _SKIP_ATTRIBUTES) if extra else {}
         for key, value in self.extra.items():
             setattr(self, key, value)
 

sap/cf_logging/record/util.py

@@ -4,9 +4,9 @@
 
 from sap.cf_logging.defaults import UNIX_EPOCH
 
-
 VCAP_APPLICATION = json.loads(os.getenv('VCAP_APPLICATION', default='{}'))
 
+
 def get_vcap_param(param_name, default=None):
     """
     Returns a parameter from the VCAP_APPLICATION environment variable
@@ -17,28 +17,32 @@ def get_vcap_param(param_name, default=None):
     """
     return VCAP_APPLICATION.get(param_name, default)
 
+
 def epoch_nano_second(datetime_):
     """ Returns the nanoseconds since epoch time """
     return int((datetime_ - UNIX_EPOCH).total_seconds()) * 1000000000 + datetime_.microsecond * 1000
 
+
 def iso_time_format(datetime_):
     """ Returns ISO time formatted string """
     return '%04d-%02d-%02dT%02d:%02d:%02d.%03dZ' % (
         datetime_.year, datetime_.month, datetime_.day, datetime_.hour,
         datetime_.minute, datetime_.second, int(datetime_.microsecond / 1000))
 
+
 def time_delta_ms(start, end):
     """ Returns the delta time between to datetime objects """
     time_delta = end - start
     return int(time_delta.total_seconds()) * 1000 + \
            int(time_delta.microseconds / 1000)
 
+
 def parse_int(_int, default):
     """ Parses an int and returns the result
         A default can be provided in case the parse fails
     """
     try:
         integer = int(_int)
-    except: # pylint: disable-msg=bare-except
+    except:  # pylint: disable-msg=bare-except
         integer = default
     return integer