correct coding convention

bobbui · Dec 24, 2017 · 44fde00 · 44fde00
1 parent b7511be
commit 44fde00
Show file tree

Hide file tree

Showing 14 changed files with 126 additions and 218 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,157 +1,43 @@
 # Created by .ignore support plugin (hsz.mobi)
 ### Python template
 # Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
 # C extensions
-*.so
-
 # Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
 # Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
 # Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-
 # Translations
-*.mo
-*.pot
-
 # Django stuff:
-*.log
-.static_storage/
-.media/
-local_settings.py
-
 # Flask stuff:
-instance/
-.webassets-cache
-
 # Scrapy stuff:
-.scrapy
-
 # Sphinx documentation
-docs/_build/
-
 # PyBuilder
-target/
-
 # Jupyter Notebook
-.ipynb_checkpoints
-
 # pyenv
-.python-version
-
 # celery beat schedule file
-celerybeat-schedule
-
 # SageMath parsed files
-*.sage.py
-
 # Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
 # Spyder project settings
-.spyderproject
-.spyproject
-
 # Rope project settings
-.ropeproject
-
 # mkdocs documentation
-/site
-
 # mypy
-.mypy_cache/
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff:
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/dictionaries
-
 # Sensitive or high-churn files:
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.xml
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-
 # Gradle:
-.idea/**/gradle.xml
-.idea/**/libraries
-
 # CMake
-cmake-build-debug/
-
 # Mongo Explorer plugin:
-.idea/**/mongoSettings.xml
-
 ## File-based project format:
-*.iws
-
 ## Plugin-specific files:
 
 # IntelliJ
-out/
-
 # mpeltonen/sbt-idea plugin
-.idea_modules/
-
 # JIRA plugin
-atlassian-ide-plugin.xml
-
 # Cursive Clojure plugin
-.idea/replstate.xml
-
 # Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
 .idea/
diff --git a/README.md b/README.md
@@ -175,7 +175,7 @@ pip3 install .
 ```
 # 7. References
 ## [0] Full logging format references
-2 types of logging statement will be emmited by this library:
+2 types of logging statement will be emitted by this library:
 - Application log: normal logging statement
 e.g.:
 ```
@@ -301,7 +301,7 @@ pip3 install json_logging --index-url https://test.pypi.org/simple/
 pypi
 ```
 python setup.py sdist upload -r pypi
-python setup.py bdist_wheel --universal upload -r pypi
+python3 setup.py bdist_wheel --universal upload -r pypi
 pip3 install json_logging
 ```
 bdist_wheel --universal
diff --git a/README.rst b/README.rst
@@ -317,7 +317,7 @@ you can install Sanic on windows by running these commands:
 [0] Full logging format references
 ----------------------------------
 
-2 types of logging statement will be emmited by this library: 
+2 types of logging statement will be emitted by this library: 
 - Application log: normal logging statement e.g.:
 
 ::
@@ -372,52 +372,52 @@ See following tables for detail format explanation:
 
  - Common field
 
-+-----------------+-----------------+-----------------+-----------------+
-| Field           | Description     | Format          | Example         |
-+=================+=================+=================+=================+
-| written_at      | The date when   | ISO 8601        | 2017-12-23T15:1 |
-|                 | this log        | YYYY-MM-DDTHH:M | 4:02.208Z       |
-|                 | message was     | M:SS.milliZ     |                 |
-|                 | written.        |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
-| written_ts      | The timestamp   | long number     | 145682055381684 |
-|                 | in nano-second  |                 | 9408            |
-|                 | precision when  |                 |                 |
-|                 | this request    |                 |                 |
-|                 | metric message  |                 |                 |
-|                 | was written.    |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
-| correlation_id  | The timestamp   | string          | db2d002e-2702-4 |
-|                 | in nano-second  |                 | 1ec-66f5-c002a8 |
-|                 | precision when  |                 | 0a3d3f          |
-|                 | this request    |                 |                 |
-|                 | metric message  |                 |                 |
-|                 | was written.    |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
-| type            | Type of         | string          |                 |
-|                 | logging. “logs” |                 |                 |
-|                 | or “request”    |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
-| component_id    | Uniquely        | string          | 9e6f3ecf-def0-4 |
-|                 | identifies the  |                 | baf-8fac-9339e6 |
-|                 | software        |                 | 1d5645          |
-|                 | component that  |                 |                 |
-|                 | has processed   |                 |                 |
-|                 | the current     |                 |                 |
-|                 | request         |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
-| component_name  | A               | string          | my-fancy-compon |
-|                 | human-friendly  |                 | ent             |
-|                 | name            |                 |                 |
-|                 | representing    |                 |                 |
-|                 | the software    |                 |                 |
-|                 | component       |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
-| component_insta | Instance’s      | string          | 0               |
-| nce             | index of        |                 |                 |
-|                 | horizontally    |                 |                 |
-|                 | scaled service  |                 |                 |
-+-----------------+-----------------+-----------------+-----------------+
++-------------------+-----------------+-----------------+-----------------+
+| Field             | Description     | Format          | Example         |
++===================+=================+=================+=================+
+| written_at        | The date when   | ISO 8601        | 2017-12-23T15:1 |
+|                   | this log        | YYYY-MM-DDTHH:M | 4:02.208Z       |
+|                   | message was     | M:SS.milliZ     |                 |
+|                   | written.        |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
+| written_ts        | The timestamp   | long number     | 145682055381684 |
+|                   | in nano-second  |                 | 9408            |
+|                   | precision when  |                 |                 |
+|                   | this request    |                 |                 |
+|                   | metric message  |                 |                 |
+|                   | was written.    |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
+| correlation_id    | The timestamp   | string          | db2d002e-2702-4 |
+|                   | in nano-second  |                 | 1ec-66f5-c002a8 |
+|                   | precision when  |                 | 0a3d3f          |
+|                   | this request    |                 |                 |
+|                   | metric message  |                 |                 |
+|                   | was written.    |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
+| type              | Type of         | string          |                 |
+|                   | logging. “logs” |                 |                 |
+|                   | or “request”    |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
+| component_id      | Uniquely        | string          | 9e6f3ecf-def0-4 |
+|                   | identifies the  |                 | baf-8fac-9339e6 |
+|                   | software        |                 | 1d5645          |
+|                   | component that  |                 |                 |
+|                   | has processed   |                 |                 |
+|                   | the current     |                 |                 |
+|                   | request         |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
+| component_name    | A               | string          | my-component    |
+|                   | human-friendly  |                 |                 |
+|                   | name            |                 |                 |
+|                   | representing    |                 |                 |
+|                   | the software    |                 |                 |
+|                   | component       |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
+| component_instance| Instance’s      | string          | 0               |
+|                   | index of        |                 |                 |
+|                   | horizontally    |                 |                 |
+|                   | scaled service  |                 |                 |
++-------------------+-----------------+-----------------+-----------------+
 
  -  application logs
 
@@ -549,8 +549,8 @@ See following tables for detail format explanation:
 | t_type          | associated with |                 | n               |
 |                 | the entity of   |                 |                 |
 |                 | the response if |                 |                 |
-|                 | available/speci |                 |                 |
-|                 | fied            |                 |                 |
+|                 | available or    |                 |                 |
+|                 | specified       |                 |                 |
 +-----------------+-----------------+-----------------+-----------------+
 | referer         | For HTTP        | string          | /index.html     |
 |                 | requests,       |                 |                 |

diff --git a/example/non_web.py b/example/non_web.py
@@ -1,4 +1,7 @@
-import json_logging, logging, sys
+import logging
+import sys
+
+import json_logging
 
 # log is initialized without a web framework name
 json_logging.ENABLE_JSON_LOGGING = True

diff --git a/example/sanic_sample_app.py b/example/sanic_sample_app.py
@@ -1,5 +1,6 @@
 import json_logging
 import logging
+# noinspection PyPackageRequirements
 import sanic
 import sys
 
@@ -14,10 +15,12 @@
 logger.addHandler(logging.StreamHandler(sys.stdout))
 
 
+# noinspection PyUnusedLocal
 @app.route("/")
 async def test(request):
     logger.info("test log statement")
     logger.info("test log statement", extra={'props': {"extra_property": 'extra_value'}})
+    # noinspection PyUnresolvedReferences
     return sanic.response.text("hello world")
 
 

diff --git a/json_logging/__init__.py b/json_logging/__init__.py
@@ -31,8 +31,8 @@
 
 def get_correlation_id():
     """
-    Get current request correlation-id.
-    In request context, if one is not present, a new one might be generated depends on CREATE_CORRELATION_ID_IF_NOT_EXISTS setting value.
+    Get current request correlation-id. If one is not present, a new one might be generated
+    depends on CREATE_CORRELATION_ID_IF_NOT_EXISTS setting value.
 
     :return: correlation-id string
     """
@@ -140,7 +140,7 @@ def init(framework_name=None):
 
 def init_request_instrument(app=None):
     """
-    Sets up the current web application instance' request instrumentation logging configuration. Must be called after init method
+    Configure the request instrumentation logging configuration for given web app. Must be called after init method
 
     :param app: current web application instance
     """
@@ -166,6 +166,7 @@ def __init__(self, request, **kwargs):
         self.request = request
         self.request_received_at = util.iso_time_format(utcnow)
 
+    # noinspection PyAttributeOutsideInit
     def update_response_status(self, response):
         """
         update response information into this object, must be called before invoke request logging statement
@@ -279,6 +280,7 @@ def format(self, record):
                            flask_support.FlaskResponseAdapter)
 
 # register flask support
+# noinspection PyPep8
 from json_logging.framework.sanic import SanicAppConfigurator, SanicAppRequestInstrumentationConfigurator, \
     SanicRequestAdapter, SanicResponseAdapter
 

diff --git a/json_logging/framework/flask/__init__.py b/json_logging/framework/flask/__init__.py
@@ -9,6 +9,7 @@
 
 
 def is_flask_present():
+    # noinspection PyPep8,PyBroadException
     try:
         import flask
         return True
@@ -37,6 +38,7 @@ def config(self, app):
 
         json_logging.util.use_cf_logging_formatter([logging.getLogger('werkzeug')], JSONLogWebFormatter)
 
+        # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('flask-request-logger')
         self.request_logger.setLevel(logging.DEBUG)
         self.request_logger.addHandler(logging.StreamHandler(sys.stdout))

diff --git a/json_logging/framework/sanic/__init__.py b/json_logging/framework/sanic/__init__.py
@@ -9,6 +9,7 @@
 
 
 def is_sanic_present():
+    # noinspection PyBroadException
     try:
         # noinspection PyPackageRequirements
         from sanic import Sanic
@@ -44,6 +45,7 @@ def config(self, app):
         if not isinstance(app, Sanic):
             raise RuntimeError("app is not a valid Sanic.app.Sanic app instance")
 
+        # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('sanic-request')
         self.request_logger.setLevel(logging.DEBUG)
         self.request_logger.addHandler(logging.StreamHandler(sys.stdout))