Source code for flake8.utils

"""Utility methods for flake8."""
from __future__ import annotations

import fnmatch as _fnmatch
import functools
import io
import logging
import os
import platform
import re
import sys
import textwrap
import tokenize
from typing import NamedTuple
from typing import Pattern
from typing import Sequence

from flake8 import exceptions

COMMA_SEPARATED_LIST_RE = re.compile(r"[,\s]")
LOCAL_PLUGIN_LIST_RE = re.compile(r"[,\t\n\r\f\v]")
NORMALIZE_PACKAGE_NAME_RE = re.compile(r"[-_.]+")

[docs]def parse_comma_separated_list( value: str, regexp: Pattern[str] = COMMA_SEPARATED_LIST_RE ) -> list[str]: """Parse a comma-separated list. :param value: String to be parsed and normalized. :param regexp: Compiled regular expression used to split the value when it is a string. :returns: List of values with whitespace stripped. """ assert isinstance(value, str), value separated = regexp.split(value) item_gen = (item.strip() for item in separated) return [item for item in item_gen if item]
class _Token(NamedTuple): tp: str src: str _CODE, _FILE, _COLON, _COMMA, _WS = "code", "file", "colon", "comma", "ws" _EOF = "eof" _FILE_LIST_TOKEN_TYPES = [ (re.compile(r"[A-Z]+[0-9]*(?=$|\s|,)"), _CODE), (re.compile(r"[^\s:,]+"), _FILE), (re.compile(r"\s*:\s*"), _COLON), (re.compile(r"\s*,\s*"), _COMMA), (re.compile(r"\s+"), _WS), ] def _tokenize_files_to_codes_mapping(value: str) -> list[_Token]: tokens = [] i = 0 while i < len(value): for token_re, token_name in _FILE_LIST_TOKEN_TYPES: match = token_re.match(value, i) if match: tokens.append(_Token(token_name, i = match.end() break else: raise AssertionError("unreachable", value, i) tokens.append(_Token(_EOF, "")) return tokens def parse_files_to_codes_mapping( # noqa: C901 value_: Sequence[str] | str, ) -> list[tuple[str, list[str]]]: """Parse a files-to-codes mapping. A files-to-codes mapping a sequence of values specified as `filenames list:codes list ...`. Each of the lists may be separated by either comma or whitespace tokens. :param value: String to be parsed and normalized. """ if not isinstance(value_, str): value = "\n".join(value_) else: value = value_ ret: list[tuple[str, list[str]]] = [] if not value.strip(): return ret class State: seen_sep = True seen_colon = False filenames: list[str] = [] codes: list[str] = [] def _reset() -> None: if for filename in State.filenames: ret.append((filename, State.seen_sep = True State.seen_colon = False State.filenames = [] = [] def _unexpected_token() -> exceptions.ExecutionError: return exceptions.ExecutionError( f"Expected `per-file-ignores` to be a mapping from file exclude " f"patterns to ignore codes.\n\n" f"Configured `per-file-ignores` setting:\n\n" f"{textwrap.indent(value.strip(), ' ')}" ) for token in _tokenize_files_to_codes_mapping(value): # legal in any state: separator sets the sep bit if in {_COMMA, _WS}: State.seen_sep = True # looking for filenames elif not State.seen_colon: if == _COLON: State.seen_colon = True State.seen_sep = True elif State.seen_sep and == _FILE: State.filenames.append(token.src) State.seen_sep = False else: raise _unexpected_token() # looking for codes else: if == _EOF: _reset() elif State.seen_sep and == _CODE: State.seen_sep = False elif State.seen_sep and == _FILE: _reset() State.filenames.append(token.src) State.seen_sep = False else: raise _unexpected_token() return ret
[docs]def normalize_paths( paths: Sequence[str], parent: str = os.curdir ) -> list[str]: """Normalize a list of paths relative to a parent directory. :returns: The normalized paths. """ assert isinstance(paths, list), paths return [normalize_path(p, parent) for p in paths]
[docs]def normalize_path(path: str, parent: str = os.curdir) -> str: """Normalize a single-path. :returns: The normalized path. """ # NOTE(sigmavirus24): Using os.path.sep and os.path.altsep allow for # Windows compatibility with both Windows-style paths (c:\foo\bar) and # Unix style paths (/foo/bar). separator = os.path.sep # NOTE(sigmavirus24): os.path.altsep may be None alternate_separator = os.path.altsep or "" if ( path == "." or separator in path or (alternate_separator and alternate_separator in path) ): path = os.path.abspath(os.path.join(parent, path)) return path.rstrip(separator + alternate_separator)
[docs]@functools.lru_cache(maxsize=1) def stdin_get_value() -> str: """Get and cache it so plugins can use it.""" stdin_value = fd = io.BytesIO(stdin_value) try: coding, _ = tokenize.detect_encoding(fd.readline) return io.TextIOWrapper(fd, coding).read() except (LookupError, SyntaxError, UnicodeError): return stdin_value.decode("utf-8")
def stdin_get_lines() -> list[str]: """Return lines of stdin split according to file splitting.""" return list(io.StringIO(stdin_get_value()))
[docs]def is_using_stdin(paths: list[str]) -> bool: """Determine if we're going to read from stdin. :param paths: The paths that we're going to check. :returns: True if stdin (-) is in the path, otherwise False """ return "-" in paths
[docs]def fnmatch(filename: str, patterns: Sequence[str]) -> bool: """Wrap :func:`fnmatch.fnmatch` to add some functionality. :param filename: Name of the file we're trying to match. :param patterns: Patterns we're using to try to match the filename. :param default: The default value if patterns is empty :returns: True if a pattern matches the filename, False if it doesn't. ``True`` if patterns is empty. """ if not patterns: return True return any(_fnmatch.fnmatch(filename, pattern) for pattern in patterns)
def matches_filename( path: str, patterns: Sequence[str], log_message: str, logger: logging.Logger, ) -> bool: """Use fnmatch to discern if a path exists in patterns. :param path: The path to the file under question :param patterns: The patterns to match the path against. :param log_message: The message used for logging purposes. :returns: True if path matches patterns, False otherwise """ if not patterns: return False basename = os.path.basename(path) if basename not in {".", ".."} and fnmatch(basename, patterns): logger.debug(log_message, {"path": basename, "whether": ""}) return True absolute_path = os.path.abspath(path) match = fnmatch(absolute_path, patterns) logger.debug( log_message, {"path": absolute_path, "whether": "" if match else "not "}, ) return match def get_python_version() -> str: """Find and format the python implementation and version. :returns: Implementation name, version, and platform as a string. """ return "{} {} on {}".format( platform.python_implementation(), platform.python_version(), platform.system(), ) def normalize_pypi_name(s: str) -> str: """Normalize a distribution name according to PEP 503.""" return NORMALIZE_PACKAGE_NAME_RE.sub("-", s).lower()