wemake-python-styleguide 1.2.0__tar.gz → 1.3.0__tar.gz

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: wemake-python-styleguide
-Version: 1.2.0
+Version: 1.3.0
 Summary: The strictest and most opinionated python linter ever
 License: MIT
 Keywords: flake8,flake8-plugin,flake8-formatter,linter,wemake.services,styleguide,code quality,pycqa

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "poetry-core>=2.0" ]
 
 [project]
 name = "wemake-python-styleguide"
-version = "1.2.0"
+version = "1.3.0"
 description = "The strictest and most opinionated python linter ever"
 
 license = {text = "MIT"}
@@ -180,7 +180,8 @@ ignore = [
 external = [ "WPS" ]
 
 # Plugin configs:
-flake8-import-conventions.banned-from = [ "ast" ]
+flake8-import-conventions.banned-from = [ "ast", "datetime" ]
+flake8-import-conventions.aliases = { datetime = "dt" }
 flake8-quotes.inline-quotes = "single"
 mccabe.max-complexity = 6
 pydocstyle.convention = "google"

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/constants.py

@@ -124,6 +124,7 @@ VARIABLE_NAMES_BLACKLIST: Final = frozenset(
         'param',
         'params',
         'parameters',
+        'arr',
         # Confusables:
         'no',
         'true',
@@ -132,6 +133,10 @@ VARIABLE_NAMES_BLACKLIST: Final = frozenset(
         'foo',
         'bar',
         'baz',
+        'spam',
+        'ham',
+        'tmp',
+        'temp',
     ),
 )
 

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/options/config.py

@@ -152,10 +152,11 @@ You can also show all options that ``flake8`` supports by running:
 - ``max-match-subjects`` - maximum number of subjects in a match statement,
     defaults to
     :str:`wemake_python_styleguide.options.defaults.MAX_MATCH_SUBJECTS`
-- ``max-match-cases`` - maximum number of cases in a match block of code
+- ``max-match-cases`` - maximum number of cases in a match block of code,
     defaults to
     :str:`wemake_python_styleguide.options.defaults.MAX_MATCH_CASES`
-- ``max-lines-in-finally`` - maximum lines in finally block of code
+- ``max-lines-in-finally`` - maximum amount of finally block body length.
+    Lines equal to statements.
     defaults to
     :str:`wemake_python_styleguide.options.defaults.MAX_LINES_IN_FINALLY`
 
@@ -437,7 +438,7 @@ class Configuration:
         _Option(
             '--max-lines-in-finally',
             defaults.MAX_LINES_IN_FINALLY,
-            'Maximum lines of expressions in a finally block.',
+            'Maximum amount of finally block body length.',
         ),
         # Formatter:
         _Option(

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/options/defaults.py

@@ -56,8 +56,8 @@ FORBIDDEN_MODULE_METADATA: Final = ()
 # Complexity:
 # ===========
 
-#: Maximum lines of expressions in a `finally` block.
-MAX_LINES_IN_FINALLY: Final = 2  # guessed
+#: Maximum amount of `finally` block body length.
+MAX_LINES_IN_FINALLY: Final = 2  # best practice
 
 #: Maximum number of `return` statements allowed in a single function.
 MAX_RETURNS: Final = 5  # 7-2

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/presets/topics/complexity.py

@@ -5,7 +5,6 @@ from wemake_python_styleguide.visitors.ast.complexity import (  # noqa: WPS235
     annotations,
     calls,
     classes,
-    complex_finally,
     counts,
     function,
     imports,
@@ -40,5 +39,4 @@ PRESET: Final = (
     annotations.AnnotationComplexityVisitor,
     pm.MatchSubjectsVisitor,
     pm.MatchCasesVisitor,
-    complex_finally.ComplexFinallyBlocksVisitor,
 )

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/violations/complexity.py

@@ -63,7 +63,7 @@ Summary
    TooManyTypeParamsViolation
    TooManyMatchSubjectsViolation
    TooManyMatchCaseViolation
-   ComplexFinallyViolation
+   TooLongFinallyBodyViolation
 
 Module complexity
 -----------------
@@ -110,7 +110,7 @@ Structure complexity
 .. autoclass:: TooManyTypeParamsViolation
 .. autoclass:: TooManyMatchSubjectsViolation
 .. autoclass:: TooManyMatchCaseViolation
-.. autoclass:: ComplexFinallyViolation
+.. autoclass:: TooLongFinallyBodyViolation
 
 """
 
@@ -1402,9 +1402,9 @@ class TooManyMatchCaseViolation(ASTViolation):
 
 
 @final
-class ComplexFinallyViolation(ASTViolation):
+class TooLongFinallyBodyViolation(ASTViolation):
     """
-    Forbids complex ``finally`` block.
+    Forbid ``finally`` blocks with bodies that are too long.
 
     Reasoning:
         ``finally`` is very special. It executes code in all
@@ -1412,10 +1412,14 @@ class ComplexFinallyViolation(ASTViolation):
         it indicates a larger problem: brittle and complex cleanups.
 
     Solution:
-        Simplify the ``finally`` block. Use context managers, use ``ExitStack``.
+        Move things out of the ``finally`` block or create new functions.
+        The fewer lines you have in your ``finally`` block -
+        the safer you are from accidental errors.
+        Use context managers, use ``ExitStack``.
 
     Configuration:
         This rule is configurable with ``--max-lines-in-finally``.
+        Lines equal to statements.
         Default:
         :str:`wemake_python_styleguide.options.defaults.MAX_LINES_IN_FINALLY`
 
@@ -1423,8 +1427,10 @@ class ComplexFinallyViolation(ASTViolation):
         https://peps.python.org/pep-0765
 
     .. versionadded:: 1.2.0
+    .. versionchanged:: 1.3.0
+        Now we count statements in ``finally``, not physical lines.
 
     """
 
-    error_template = 'Found too many lines in `finally` block: {0}'
+    error_template = 'Found too long `finally` block: {0}'
     code = 243

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/violations/naming.py

@@ -327,6 +327,8 @@ class WrongVariableNameViolation(ASTViolation):
         :py:data:`~wemake_python_styleguide.constants.VARIABLE_NAMES_BLACKLIST`.
 
     .. versionadded:: 0.1.0
+    .. versionchanged:: 1.3.0
+        Added more names: ``spam``, ``ham``, ``tmp``, ``temp``, ``arr``
 
     """
 

{wemake_python_styleguide-1.2.0 → wemake_python_styleguide-1.3.0}/wemake_python_styleguide/visitors/ast/complexity/counts.py

@@ -191,6 +191,7 @@ class TryExceptVisitor(BaseNodeVisitor):
         """Ensures that try/except is correct."""
         self._check_except_count(node)
         self._check_try_body_length(node)
+        self._check_finally_body_length(node)
         self._check_exceptions_count(node)
         self.generic_visit(node)
 
@@ -214,6 +215,16 @@ class TryExceptVisitor(BaseNodeVisitor):
                 ),
             )
 
+    def _check_finally_body_length(self, node: AnyTry) -> None:
+        if len(node.finalbody) > self.options.max_lines_in_finally:
+            self.add_violation(
+                complexity.TooLongFinallyBodyViolation(
+                    node,
+                    text=str(len(node.finalbody)),
+                    baseline=self.options.max_lines_in_finally,
+                ),
+            )
+
     def _check_exceptions_count(self, node: AnyTry) -> None:
         for except_handler in node.handlers:
             exc_type = except_handler.type

wemake_python_styleguide-1.2.0/wemake_python_styleguide/visitors/ast/complexity/complex_finally.py

@@ -1,34 +0,0 @@
-import ast
-from typing import final
-
-from wemake_python_styleguide.violations import complexity
-from wemake_python_styleguide.visitors.base import BaseNodeVisitor
-
-
-@final
-class ComplexFinallyBlocksVisitor(BaseNodeVisitor):
-    """Ensures there are no complex ``finally`` blocks."""
-
-    def visit_Try(self, node: ast.Try) -> None:
-        """Visits all finally nodes in the tree."""
-        self._check_complex_finally(node)
-        self.generic_visit(node)
-
-    def _check_complex_finally(self, node: ast.Try) -> None:
-        """Checks complexity of finally blocks."""
-        if not node.finalbody:
-            return
-
-        first_line = node.finalbody[0].lineno
-        # `end_lineno` was added in 3.8, but typing is not really correct,
-        # we are pretty sure that it always exist in modern python versions.
-        last_line = getattr(node.finalbody[-1], 'end_lineno', 0) or 0
-        total_lines = last_line - first_line + 1
-        if total_lines > self.options.max_lines_in_finally:
-            self.add_violation(
-                complexity.ComplexFinallyViolation(
-                    node,
-                    text=str(total_lines),
-                    baseline=self.options.max_lines_in_finally,
-                ),
-            )