Add pylint and black

Author: roelbondoc

.github/workflows/check-pr-title.yml

@@ -0,0 +1,27 @@
+name: Check PR Title
+
+on:
+  pull_request:
+    branches: [ master ]
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  commitlint:
+    name: Check PR title
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18.x'
+
+      - name: Setup
+        run: |
+          npm install -g @commitlint/cli @commitlint/config-conventional
+          echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
+
+      - name: Verify PR title is in the correct format
+        env:
+            TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          echo $TITLE | npx commitlint -V

.github/workflows/pylint.yml

@@ -0,0 +1,27 @@
+name: Pylint
+
+on:
+  pull_request:
+    branches: [ master ]
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  pylint:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out ${{ github.ref }}
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+
+      - name: Run Pylint
+        run: |
+          pylint -E ./honeybager

dev-requirements.txt

@@ -1,5 +1,6 @@
 aiounittest
 async-asgi-testclient
+black
 blinker
 celery
 django
@@ -11,6 +12,7 @@ jinja2
 markupsafe
 mock
 psutil
+pylint
 pytest
 pytest-cov
 six

honeybadger/__init__.py

@@ -11,7 +11,7 @@
 from .core import Honeybadger
 from .version import __version__
 
-__all__ = ['honeybadger', '__version__']
+__all__ = ["honeybadger", "__version__"]
 
 honeybadger = Honeybadger()
 honeybadger.wrap_excepthook(sys.excepthook)

honeybadger/config.py

@@ -5,28 +5,33 @@
 
 
 class Configuration(object):
-    DEVELOPMENT_ENVIRONMENTS = ['development', 'dev', 'test']
+    DEVELOPMENT_ENVIRONMENTS = ["development", "dev", "test"]
 
     OPTIONS = (
-        ('api_key', str),
-        ('project_root', str),
-        ('environment', str),
-        ('hostname', str),
-        ('endpoint', str),
-        ('params_filters', list),
-        ('force_report_data', bool),
-        ('force_sync', bool),
-        ('excluded_exceptions', list),
-        ('report_local_variables', bool)
+        ("api_key", str),
+        ("project_root", str),
+        ("environment", str),
+        ("hostname", str),
+        ("endpoint", str),
+        ("params_filters", list),
+        ("force_report_data", bool),
+        ("force_sync", bool),
+        ("excluded_exceptions", list),
+        ("report_local_variables", bool),
     )
 
     def __init__(self, *args, **kwargs):
-        self.api_key = ''
+        self.api_key = ""
         self.project_root = os.getcwd()
-        self.environment = 'production'
+        self.environment = "production"
         self.hostname = socket.gethostname()
-        self.endpoint = 'https://api.honeybadger.io'
-        self.params_filters = ['password', 'password_confirmation', 'credit_card', 'CSRF_COOKIE']
+        self.endpoint = "https://api.honeybadger.io"
+        self.params_filters = [
+            "password",
+            "password_confirmation",
+            "credit_card",
+            "CSRF_COOKIE",
+        ]
         self.force_report_data = False
         self.force_sync = self.is_aws_lambda_environment
         self.excluded_exceptions = []
@@ -37,12 +42,14 @@ def __init__(self, *args, **kwargs):
 
     def set_12factor_config(self):
         for option in list(zip(*self.OPTIONS))[0]:
-            val = os.environ.get('HONEYBADGER_{}'.format(option.upper()), getattr(self, option))
+            val = os.environ.get(
+                "HONEYBADGER_{}".format(option.upper()), getattr(self, option)
+            )
             option_types = dict(self.OPTIONS)
 
             try:
                 if option_types[option] is list:
-                    val = val.split(',')
+                    val = val.split(",")
                 elif option_types[option] is int:
                     val = int(val)
                 elif option_types[option] is bool:
@@ -53,7 +60,7 @@ def set_12factor_config(self):
             setattr(self, option, val)
 
     def set_config_from_dict(self, config):
-        for (key, value) in iteritems(config):
+        for key, value in iteritems(config):
             if key in list(zip(*self.OPTIONS))[0]:
                 setattr(self, key, value)
 

honeybadger/connection.py

@@ -9,24 +9,31 @@
 
 logger = logging.getLogger(__name__)
 
+
 def _make_http_request(path, config, payload):
 
     if not config.api_key:
-        logger.error("Honeybadger API key missing from configuration: cannot report errors.")
+        logger.error(
+            "Honeybadger API key missing from configuration: cannot report errors."
+        )
         return
-    
-    request_object = request.Request(url=config.endpoint + path,
-                                     data=b(json.dumps(payload, cls=StringReprJSONEncoder)))
-    request_object.add_header('X-Api-Key', config.api_key)
-    request_object.add_header('Content-Type', 'application/json')
-    request_object.add_header('Accept', 'application/json')
+
+    request_object = request.Request(
+        url=config.endpoint + path,
+        data=b(json.dumps(payload, cls=StringReprJSONEncoder)),
+    )
+    request_object.add_header("X-Api-Key", config.api_key)
+    request_object.add_header("Content-Type", "application/json")
+    request_object.add_header("Accept", "application/json")
 
     def send_request():
         response = request.urlopen(request_object)
 
         status = response.getcode()
         if status != 201:
-            logger.error("Received error response [{}] from Honeybadger API.".format(status))
+            logger.error(
+                "Received error response [{}] from Honeybadger API.".format(status)
+            )
 
     if config.force_sync:
         send_request()
@@ -37,11 +44,11 @@ def send_request():
 
 def send_notice(config, payload):
     notice_id = payload.get("error", {}).get("token", None)
-    path = '/v1/notices/'
+    path = "/v1/notices/"
     _make_http_request(path, config, payload)
     return notice_id
 
 
 def send_event(config, payload):
-    path = '/v1/events/'
+    path = "/v1/events/"
     return _make_http_request(path, config, payload)

honeybadger/contrib/__init__.py

@@ -6,10 +6,10 @@
 from honeybadger.contrib.celery import CeleryHoneybadger
 
 __all__ = [
-    'FlaskHoneybadger',
-    'DjangoHoneybadgerMiddleware',
-    'AWSLambdaPlugin',
-    'HoneybadgerHandler'
-    'ASGIHoneybadger',
-    'CeleryHoneybadger',
+    "FlaskHoneybadger",
+    "DjangoHoneybadgerMiddleware",
+    "AWSLambdaPlugin",
+    "HoneybadgerHandler",
+    "ASGIHoneybadger",
+    "CeleryHoneybadger",
 ]

honeybadger/contrib/asgi.py

@@ -103,6 +103,7 @@ def __init__(self, app, **kwargs):
     def _run_asgi2(self, scope):
         async def inner(receive, send):
             return await self._run_app(scope, lambda: self.app(scope)(receive, send))
+
         return inner
 
     async def _run_asgi3(self, scope, receive, send):

honeybadger/contrib/aws_lambda.py

@@ -13,7 +13,7 @@
 
 
 _thread_locals = local()
-REQUEST_LOCAL_KEY = '__awslambda_current_request'
+REQUEST_LOCAL_KEY = "__awslambda_current_request"
 
 
 def current_event():
@@ -63,7 +63,9 @@ def get_lambda_bootstrap():
         return sys.modules["bootstrap"]
     elif "__main__" in sys.modules:
         module = sys.modules["__main__"]
-        if hasattr(module, "awslambdaricmain") and hasattr(module.awslambdaricmain, "bootstrap"):
+        if hasattr(module, "awslambdaricmain") and hasattr(
+            module.awslambdaricmain, "bootstrap"
+        ):
             return module.awslambdaricmain.bootstrap
         elif hasattr(module, "bootstrap"):
             return module.bootstrap
@@ -96,10 +98,12 @@ def wrapped_handler(aws_event, aws_context, *args, **kwargs):
 class AWSLambdaPlugin(Plugin):
 
     def __init__(self):
-        super(AWSLambdaPlugin, self).__init__('AWSLambda')
+        super(AWSLambdaPlugin, self).__init__("AWSLambda")
         lambda_bootstrap = get_lambda_bootstrap()
         if not lambda_bootstrap:
-            logger.warning('Lambda function not wrapped by honeybadger: Unable to locate bootstrap module.')
+            logger.warning(
+                "Lambda function not wrapped by honeybadger: Unable to locate bootstrap module."
+            )
         self.initialize_request_handler(lambda_bootstrap)
 
     def supports(self, config, context):
@@ -110,13 +114,10 @@ def generate_payload(self, default_payload, config, context):
         Generate payload by checking the lambda's
         request event
         """
-        request_payload = {
-            "params": {
-                "event": current_event()
-            },
-            "context": context
-        }
-        default_payload["request"].update(filter_dict(request_payload, config.params_filters))
+        request_payload = {"params": {"event": current_event()}, "context": context}
+        default_payload["request"].update(
+            filter_dict(request_payload, config.params_filters)
+        )
 
         AWS_ENV_MAP = (
             ("_HANDLER", "handler"),
@@ -126,10 +127,12 @@ def generate_payload(self, default_payload, config, context):
             ("AWS_LAMBDA_FUNCTION_MEMORY_SIZE", "memory"),
             ("AWS_LAMBDA_FUNCTION_VERSION", "version"),
             ("AWS_LAMBDA_LOG_GROUP_NAME", "log_group"),
-            ("AWS_LAMBDA_LOG_STREAM_NAME", "log_name")
+            ("AWS_LAMBDA_LOG_STREAM_NAME", "log_name"),
         )
 
-        lambda_details = {detail[1]: os.environ.get(detail[0], None) for detail in AWS_ENV_MAP}
+        lambda_details = {
+            detail[1]: os.environ.get(detail[0], None) for detail in AWS_ENV_MAP
+        }
         default_payload["details"] = {}
         default_payload["details"]["Lambda Details"] = lambda_details
         default_payload["request"]["component"] = lambda_details["function"]
@@ -146,6 +149,7 @@ def initialize_request_handler(self, lambda_bootstrap):
         and override it with a wrapped version
         """
         if hasattr(lambda_bootstrap, "handle_http_request"):  # pre python3.7
+
             def event_handler(request_handler, *args, **kwargs):
                 request_handler = _wrap_lambda_handler(request_handler)
                 return original_event_handler(request_handler, *args, **kwargs)
@@ -161,13 +165,18 @@ def http_handler(request_handler, *args, **kwargs):
                 lambda_bootstrap.handle_event_request = event_handler
                 lambda_bootstrap.handle_http_request = http_handler
 
-            except AttributeError as e:  # Fail safely if we can't monkeypatch lambda handler
-                logger.warning('Lambda function not wrapped by honeybadger: %s' % e)
+            except (
+                AttributeError
+            ) as e:  # Fail safely if we can't monkeypatch lambda handler
+                logger.warning("Lambda function not wrapped by honeybadger: %s" % e)
 
         else:
+
             def event_handler(lambda_runtime_client, request_handler, *args, **kwargs):
                 request_handler = _wrap_lambda_handler(request_handler)
-                return original_event_handler(lambda_runtime_client, request_handler, *args, **kwargs)
+                return original_event_handler(
+                    lambda_runtime_client, request_handler, *args, **kwargs
+                )
 
             try:
                 original_event_handler = lambda_bootstrap.handle_event_request
@@ -178,4 +187,4 @@ def event_handler(lambda_runtime_client, request_handler, *args, **kwargs):
             # either of these will raise an Attribute error as "handle_event_request" or "handle_event_request"
             # may not be found.
             except AttributeError as e:
-                logger.warning('Lambda function not wrapped by honeybadger: %s' % e)
+                logger.warning("Lambda function not wrapped by honeybadger: %s" % e)

honeybadger/contrib/celery.py

@@ -28,7 +28,7 @@ def generate_payload(self, default_payload, config, context):
 
         # Ensure we have a mutable context dictionary
         context = dict(context or {})
-        
+
         # Add Celery task information to context
         context.update(
             task_id=current_task.request.id,