ref: Introduce linter for proper naming conventions (#636)

* ref: Introduce linter for proper naming conventions

* ref: Document reasons for ignoring lints

Author: untitaker

.flake8

@@ -1,8 +1,18 @@
 [flake8]
 ignore = 
-  E203, E266, E501, W503, E402, E731, C901, B950, B011,
-  B014  // does not apply to Python 2
+  E203,  // Handled by black (Whitespace before ':' -- handled by black)
+  E266,  // Handled by black (Too many leading '#' for block comment)
+  E501,  // Handled by black (Line too long)
+  W503,  // Handled by black (Line break occured before a binary operator)
+  E402,  // Sometimes not possible due to execution order (Module level import is not at top of file)
+  E731,  // I don't care (Do not assign a lambda expression, use a def)
+  C901,  // I don't care (Function is too complex)
+  B950,  // Handled by black (Line too long by flake8-bugbear)
+  B011,  // I don't care (Do not call assert False)
+  B014,  // does not apply to Python 2 (redundant exception types by flake8-bugbear)
+  N812,  // I don't care (Lowercase imported as non-lowercase by pep8-naming)
+  N804   // is a worse version of and conflicts with B902 (first argument of a classmethod should be named cls)
 max-line-length = 80
 max-complexity = 18
-select = B,C,E,F,W,T4,B9
+select = N,B,C,E,F,W,T4,B9
 exclude=checkouts,lol*,.tox

linter-requirements.txt

@@ -3,3 +3,4 @@ flake8
 flake8-import-order
 mypy==0.761
 flake8-bugbear>=19.8.0
+pep8-naming

sentry_sdk/_compat.py

@@ -59,12 +59,12 @@ def reraise(tp, value, tb=None):
 
 def with_metaclass(meta, *bases):
     # type: (Any, *Any) -> Any
-    class metaclass(type):
+    class MetaClass(type):
         def __new__(metacls, name, this_bases, d):
             # type: (Any, Any, Any, Any) -> Any
             return meta(name, bases, d)
 
-    return type.__new__(metaclass, "temporary_class", (), {})
+    return type.__new__(MetaClass, "temporary_class", (), {})
 
 
 def check_thread_support():

sentry_sdk/client.py

@@ -389,7 +389,7 @@ def __exit__(self, exc_type, exc_value, tb):
     # Use `ClientConstructor` to define the argument types of `init` and
     # `Dict[str, Any]` to tell static analyzers about the return type.
 
-    class get_options(ClientConstructor, Dict[str, Any]):
+    class get_options(ClientConstructor, Dict[str, Any]):  # noqa: N801
         pass
 
     class Client(ClientConstructor, _Client):

sentry_sdk/hub.py

@@ -118,7 +118,7 @@ def _init(*args, **kwargs):
     # Use `ClientConstructor` to define the argument types of `init` and
     # `ContextManager[Any]` to tell static analyzers about the return type.
 
-    class init(ClientConstructor, ContextManager[Any]):
+    class init(ClientConstructor, ContextManager[Any]):  # noqa: N801
         pass
 
 

sentry_sdk/integrations/bottle.py

@@ -34,6 +34,9 @@
     raise DidNotEnable("Bottle not installed")
 
 
+TRANSACTION_STYLE_VALUES = ("endpoint", "url")
+
+
 class BottleIntegration(Integration):
     identifier = "bottle"
 
@@ -42,7 +45,6 @@ class BottleIntegration(Integration):
     def __init__(self, transaction_style="endpoint"):
         # type: (str) -> None
 
-        TRANSACTION_STYLE_VALUES = ("endpoint", "url")
         if transaction_style not in TRANSACTION_STYLE_VALUES:
             raise ValueError(
                 "Invalid value for transaction_style: %s (must be in %s)"

sentry_sdk/integrations/django/__init__.py

@@ -71,6 +71,9 @@ def is_authenticated(request_user):
         return request_user.is_authenticated
 
 
+TRANSACTION_STYLE_VALUES = ("function_name", "url")
+
+
 class DjangoIntegration(Integration):
     identifier = "django"
 
@@ -79,7 +82,6 @@ class DjangoIntegration(Integration):
 
     def __init__(self, transaction_style="url", middleware_spans=True):
         # type: (str, bool) -> None
-        TRANSACTION_STYLE_VALUES = ("function_name", "url")
         if transaction_style not in TRANSACTION_STYLE_VALUES:
             raise ValueError(
                 "Invalid value for transaction_style: %s (must be in %s)"

sentry_sdk/integrations/falcon.py

@@ -81,14 +81,16 @@ def process_request(self, req, resp, *args, **kwargs):
             scope.add_event_processor(_make_request_event_processor(req, integration))
 
 
+TRANSACTION_STYLE_VALUES = ("uri_template", "path")
+
+
 class FalconIntegration(Integration):
     identifier = "falcon"
 
     transaction_style = None
 
     def __init__(self, transaction_style="uri_template"):
         # type: (str) -> None
-        TRANSACTION_STYLE_VALUES = ("uri_template", "path")
         if transaction_style not in TRANSACTION_STYLE_VALUES:
             raise ValueError(
                 "Invalid value for transaction_style: %s (must be in %s)"

sentry_sdk/integrations/flask.py

@@ -46,14 +46,16 @@
     raise DidNotEnable("Flask is not installed")
 
 
+TRANSACTION_STYLE_VALUES = ("endpoint", "url")
+
+
 class FlaskIntegration(Integration):
     identifier = "flask"
 
     transaction_style = None
 
     def __init__(self, transaction_style="endpoint"):
         # type: (str) -> None
-        TRANSACTION_STYLE_VALUES = ("endpoint", "url")
         if transaction_style not in TRANSACTION_STYLE_VALUES:
             raise ValueError(
                 "Invalid value for transaction_style: %s (must be in %s)"

sentry_sdk/integrations/pyramid.py

@@ -43,14 +43,16 @@ def authenticated_userid(request):
     from pyramid.security import authenticated_userid  # type: ignore
 
 
+TRANSACTION_STYLE_VALUES = ("route_name", "route_pattern")
+
+
 class PyramidIntegration(Integration):
     identifier = "pyramid"
 
     transaction_style = None
 
     def __init__(self, transaction_style="route_name"):
         # type: (str) -> None
-        TRANSACTION_STYLE_VALUES = ("route_name", "route_pattern")
         if transaction_style not in TRANSACTION_STYLE_VALUES:
             raise ValueError(
                 "Invalid value for transaction_style: %s (must be in %s)"