Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
wemake-python-styleguide
Artifacts are distributable versions of a package. It typically includes the source code and metadata
Advanced tools
wemake-python-styleguide - npm Package Compare versions
| import math | ||
| import tokenize | ||
| from typing import Iterable, List, Optional, Tuple | ||
| from typing_extensions import final | ||
| from wemake_python_styleguide.violations import best_practices | ||
| from wemake_python_styleguide.visitors import base | ||
| @final | ||
| class _Function: | ||
| def __init__(self, file_tokens: List[tokenize.TokenInfo]) -> None: | ||
| self._tokens = file_tokens | ||
| def name_token(self) -> tokenize.TokenInfo: | ||
| return self._tokens[1] | ||
| def body(self) -> str: | ||
| target_tokens = [] | ||
| for token in self._tokens: | ||
| if self._is_target_line(token): | ||
| continue | ||
| target_tokens.append(token) | ||
| return ''.join([target_token.string for target_token in target_tokens]) | ||
| def _is_target_line(self, token: tokenize.TokenInfo) -> bool: | ||
| stripped_token_line = token.line.strip() | ||
| is_comment = False | ||
| if stripped_token_line: | ||
| is_comment = stripped_token_line.startswith('#') | ||
| is_multistring_end = '"""' in token.line | ||
| return is_comment or is_multistring_end | ||
| @final | ||
| class _FileFunctions: | ||
| def __init__(self, file_tokens: List[tokenize.TokenInfo]) -> None: | ||
| self._file_tokens = file_tokens | ||
| def search_functions(self) -> Iterable[_Function]: # noqa: WPS210 | ||
| function_tokens: List[tokenize.TokenInfo] = [] | ||
| in_function = False | ||
| function_start_token = (0, 0) | ||
| for token_index, token in enumerate(self._file_tokens): | ||
| function_ended = self._is_function_end( | ||
| token, | ||
| token_index, | ||
| function_start_token, | ||
| function_tokens_exists=bool(function_tokens), | ||
| ) | ||
| if not in_function and self._is_function_start(token): | ||
| in_function = True | ||
| function_start_token = token.start | ||
| elif function_ended: | ||
| in_function = False | ||
| function_start_token = (function_start_token[0], 0) | ||
| yield _Function(function_tokens) | ||
| function_tokens = [] | ||
| if in_function: | ||
| function_tokens.append(token) | ||
| def _is_function_start(self, token: tokenize.TokenInfo) -> bool: | ||
| return token.type == tokenize.NAME and token.string in {'def', 'async'} | ||
| def _is_function_end( | ||
| self, | ||
| token: tokenize.TokenInfo, | ||
| token_index: int, | ||
| function_start: Tuple[int, int], | ||
| *, | ||
| function_tokens_exists: bool, | ||
| ) -> bool: | ||
| next_token = self._next_token(token_index) | ||
| is_elipsis_end = ( | ||
| next_token and | ||
| next_token.exact_type == tokenize.NEWLINE and | ||
| token.string == '...' and | ||
| token.start[0] == function_start[0] | ||
| ) | ||
| if is_elipsis_end: | ||
| return True | ||
| column_valid = token.start[1] in {0, function_start[1]} | ||
| is_dedent_token = token.type == tokenize.DEDENT | ||
| return is_dedent_token and function_tokens_exists and column_valid | ||
| def _next_token( | ||
| self, | ||
| token_index: int, | ||
| ) -> Optional[tokenize.TokenInfo]: | ||
| try: | ||
| return self._file_tokens[token_index + 1] | ||
| except IndexError: | ||
| return None | ||
| @final | ||
| class _FileTokens: | ||
| def __init__( | ||
| self, | ||
| file_functions: _FileFunctions, | ||
| exps_for_one_empty_line: int, | ||
| ) -> None: | ||
| self._file_functions = file_functions | ||
| self._exps_for_one_empty_line = exps_for_one_empty_line | ||
| def analyze(self) -> Iterable[best_practices.WrongEmptyLinesCountViolation]: | ||
| for function in self._file_functions.search_functions(): | ||
| splitted_function_body = function.body().strip().split('\n') | ||
| empty_lines_count = len([ | ||
| line | ||
| for line in splitted_function_body | ||
| if line == '' | ||
| ]) | ||
| if not empty_lines_count: | ||
| continue | ||
| available_empty_lines = self._available_empty_lines( | ||
| len(splitted_function_body), empty_lines_count, | ||
| ) | ||
| if empty_lines_count > available_empty_lines: | ||
| yield best_practices.WrongEmptyLinesCountViolation( | ||
| function.name_token(), | ||
| text=str(empty_lines_count), | ||
| baseline=available_empty_lines, | ||
| ) | ||
| def _available_empty_lines( | ||
| self, | ||
| function_len: int, | ||
| empty_lines: int, | ||
| ) -> int: | ||
| option = self._exps_for_one_empty_line | ||
| if option == 0: | ||
| return 0 | ||
| lines_with_expressions = function_len - empty_lines | ||
| return math.floor(lines_with_expressions / option) | ||
| @final | ||
| class WrongEmptyLinesCountVisitor(base.BaseTokenVisitor): | ||
| """Restricts empty lines in function or method body.""" | ||
| def __init__(self, *args, **kwargs) -> None: | ||
| """Initializes a counter.""" | ||
| super().__init__(*args, **kwargs) | ||
| self._file_tokens: List[tokenize.TokenInfo] = [] | ||
| def visit(self, token: tokenize.TokenInfo) -> None: | ||
| """Find empty lines count.""" | ||
| self._file_tokens.append(token) | ||
| if token.type != tokenize.ENDMARKER: | ||
| return | ||
| violations = _FileTokens( | ||
| _FileFunctions(self._file_tokens), | ||
| self.options.exps_for_one_empty_line, | ||
| ).analyze() | ||
| for violation in violations: | ||
| self.add_violation(violation) |
+1
-1
| Metadata-Version: 2.1 | ||
| Name: wemake-python-styleguide | ||
| Version: 0.19.1 | ||
| Version: 0.19.2 | ||
| Summary: The strictest and most opinionated python linter ever | ||
@@ -5,0 +5,0 @@ Home-page: https://wemake-python-styleguide.rtfd.io |
+1
-1
| [tool.poetry] | ||
| name = "wemake-python-styleguide" | ||
| version = "0.19.1" | ||
| version = "0.19.2" | ||
| description = "The strictest and most opinionated python linter ever" | ||
@@ -5,0 +5,0 @@ |
@@ -14,3 +14,2 @@ from typing_extensions import Final | ||
| exceptions, | ||
| function_empty_lines, | ||
| functions, | ||
@@ -27,2 +26,5 @@ imports, | ||
| ) | ||
| from wemake_python_styleguide.visitors.tokenize import ( | ||
| functions as tokenize_functions, | ||
| ) | ||
@@ -62,2 +64,3 @@ #: Used to store all general visitors to be later passed to checker: | ||
| functions.FloatingNanCallVisitor, | ||
| tokenize_functions.WrongEmptyLinesCountVisitor, | ||
@@ -116,4 +119,2 @@ exceptions.WrongTryExceptVisitor, | ||
| function_empty_lines.WrongEmptyLinesCountVisitor, | ||
| # Modules: | ||
@@ -120,0 +121,0 @@ modules.EmptyModuleContentsVisitor, |
| import math | ||
| import tokenize | ||
| from typing import Iterator, List | ||
| from typing_extensions import final | ||
| from wemake_python_styleguide.violations import best_practices | ||
| from wemake_python_styleguide.visitors import base | ||
| @final | ||
| class _Function: | ||
| def __init__(self, file_tokens: List[tokenize.TokenInfo]) -> None: | ||
| self._tokens = file_tokens | ||
| def name_token(self) -> tokenize.TokenInfo: | ||
| return self._tokens[1] | ||
| def body(self) -> str: | ||
| target_tokens = [] | ||
| for token in self._tokens: | ||
| if self._is_target_line(token): | ||
| continue | ||
| target_tokens.append(token) | ||
| return ''.join([target_token.string for target_token in target_tokens]) | ||
| def _is_target_line(self, token: tokenize.TokenInfo) -> bool: | ||
| stripped_token_line = token.line.strip() | ||
| is_comment = False | ||
| if stripped_token_line: | ||
| is_comment = stripped_token_line.startswith('#') | ||
| is_multistring_end = '"""' in token.line | ||
| return is_comment or is_multistring_end | ||
| @final | ||
| class _FileFunctions: | ||
| def __init__(self, file_tokens: List[tokenize.TokenInfo]) -> None: | ||
| self._file_tokens = file_tokens | ||
| def as_list(self) -> List[_Function]: | ||
| return list(self._search_functions()) | ||
| def _search_functions(self) -> Iterator[_Function]: | ||
| function_tokens: List[tokenize.TokenInfo] = [] | ||
| in_function = False | ||
| function_start_token = (0, 0) | ||
| for token in self._file_tokens: | ||
| function_ended = self._is_function_end( | ||
| token, | ||
| bool(function_tokens), | ||
| function_start_token[1], | ||
| function_start_token[0], | ||
| ) | ||
| if not in_function and self._is_function_start(token): | ||
| in_function = True | ||
| function_start_token = token.start | ||
| elif function_ended: | ||
| in_function = False | ||
| function_start_token = (function_start_token[0], 0) | ||
| yield _Function(function_tokens) | ||
| function_tokens = [] | ||
| if in_function: | ||
| function_tokens.append(token) | ||
| def _is_function_start(self, token: tokenize.TokenInfo) -> bool: | ||
| return token.type == tokenize.NAME and token.string in {'def', 'async'} | ||
| def _is_function_end( | ||
| self, | ||
| token: tokenize.TokenInfo, | ||
| function_tokens_exists: bool, | ||
| function_start_column: int, | ||
| function_start_line: int, | ||
| ) -> bool: | ||
| is_elipsis = token.string == '...' | ||
| is_elipsis_end = is_elipsis and token.start[0] == function_start_line | ||
| if is_elipsis_end: | ||
| return True | ||
| column_valid = token.start[1] in {0, function_start_column} | ||
| is_dedent_token = token.type == tokenize.DEDENT | ||
| return is_dedent_token and function_tokens_exists and column_valid | ||
| @final | ||
| class _FileTokens: | ||
| def __init__( | ||
| self, | ||
| file_functions: _FileFunctions, | ||
| exps_for_one_empty_line: int, | ||
| ) -> None: | ||
| self._file_functions = file_functions | ||
| self._exps_for_one_empty_line = exps_for_one_empty_line | ||
| def analyze(self) -> List[best_practices.WrongEmptyLinesCountViolation]: | ||
| violations = [] | ||
| for function in self._file_functions.as_list(): | ||
| splitted_function_body = function.body().strip().split('\n') | ||
| empty_lines_count = len([ | ||
| line for line in splitted_function_body if line == '' | ||
| ]) | ||
| if not empty_lines_count: | ||
| continue | ||
| available_empty_lines = self._available_empty_lines( | ||
| len(splitted_function_body), empty_lines_count, | ||
| ) | ||
| if empty_lines_count > available_empty_lines: | ||
| violations.append( | ||
| best_practices.WrongEmptyLinesCountViolation( | ||
| function.name_token(), | ||
| text=str(empty_lines_count), | ||
| baseline=available_empty_lines, | ||
| ), | ||
| ) | ||
| return violations | ||
| def _available_empty_lines( | ||
| self, | ||
| function_len: int, | ||
| empty_lines: int, | ||
| ) -> int: | ||
| option = self._exps_for_one_empty_line | ||
| if option == 0: | ||
| return 0 | ||
| lines_with_expressions = function_len - empty_lines | ||
| return math.floor(lines_with_expressions / option) | ||
| @final | ||
| class WrongEmptyLinesCountVisitor(base.BaseTokenVisitor): | ||
| """Restricts empty lines in function or method body.""" | ||
| def __init__(self, *args, **kwargs) -> None: | ||
| """Initializes a counter.""" | ||
| super().__init__(*args, **kwargs) | ||
| self._file_tokens: List[tokenize.TokenInfo] = [] | ||
| def visit(self, token: tokenize.TokenInfo) -> None: | ||
| """Find empty lines count.""" | ||
| self._file_tokens.append(token) | ||
| if token.type != tokenize.ENDMARKER: | ||
| return | ||
| violations = _FileTokens( | ||
| _FileFunctions(self._file_tokens), | ||
| self.options.exps_for_one_empty_line, | ||
| ).analyze() | ||
| for violation in violations: | ||
| self.add_violation(violation) |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
Improved metrics
- Total package byte prevSize
711621
0.05%- Lines of code
18552
0.06%