Quelle init.py Sprache: Python

import os
import re
from functools import lru_cache
from typing import Callable, Iterable, List, Optional, TextIO, Tuple, Union

__version__ = "0.3.1"

__all__ = [
    "Rule",
    "check_match",
    "check_path_match",
    "parse_gitignore_file",
    "try_parse_rule",
]

# TODO: this may not correctly support \] within ]
specials_re = re.compile(r"(\*+|\[|]|\?)")

@lru_cache(maxsize=512)
def compile_pattern(pat: str) -> "re.Pattern":  # type: ignore[type-arg]
    # Start the pattern with "either the start of the string or a directory separator".
    # Whether or not we were anchored to the start of the path is checked within
    # `matches`.
    re_bits = ["(?:^|/)"]

    bits = specials_re.split(pat)
    while bits:
        bit = bits.pop(0)
        if not bit:
            continue

        if bit == "?":
            re_bits.append(r"[^/]")
            continue

        if bit.startswith("*"):
            if len(bit) > 1:
                re_bits.append(".*")
            else:
                re_bits.append(r"[^/]*")
            continue

        if bit.startswith("["):
            alternation_contents = []
            while True:
                try:
                    bit = bits.pop(0)
                except IndexError:
                    # Instead of failing to parse,
                    # we just assume an unterminated [] seq is to the end of string
                    break
                if bit == "]":
                    break
                # Unescape everything but the dash – this may not be 100% correct.
                esc_bit = re.escape(bit).replace("\\-", "-")
                alternation_contents.append(esc_bit)
            re_bits.append("[%s]" % "".join(alternation_contents))
            continue

        if re_bits and re_bits[-1] == ".*":
            # If the last bit was a double star, we'll need to fix up any
            # leading slashes from this bit (since the double star would consume them).
            bit = bit.lstrip("/")

        re_bits.append(re.escape(bit))

    re_bits.append("$")
    re_content = "".join(re_bits)
    return re.compile(re_content)

class Rule:
    def __init__(self, *, negative: bool, content: str) -> None:
        self.negative = bool(negative)
        self.content = str(content)

    def __repr__(self) -> str:
        return f''

    def matches(self, path: str, is_dir: bool = False) -> bool:
        pat = self.content
        if pat.endswith("/"):
            if not is_dir:
                #   * If there is a separator at the end of the pattern then the pattern
                #     will only match directories, otherwise the pattern can match both
                #     files and directories.
                return False
            pat = pat.rstrip("/")
        if pat.startswith("/"):
            anchor = True
            pat = pat[1:]
        elif is_dir and "/" in pat:
            anchor = True
        else:
            anchor = False
        re_pat = compile_pattern(pat)
        res = re_pat.search(path)
        # This commented-out print() is useful for debugging.
        # print(self.content, "->", re_pat, "?", path, is_dir, ":", res)
        if anchor:
            # If the match was supposed to be anchored, verify that.
            return bool(res and res.start() == 0)
        return bool(res)

def try_parse_rule(line: str) -> Optional["Rule"]:
    line = line.rstrip()  # Remove all trailing spaces
    if line.endswith("\\"):
        # "Trailing spaces are ignored unless they are quoted with backslash ("\")."

        # That is, now that we only have a slash left at the end of the path,
        # it must have been escaping a space.
        line = line[:-1] + " "
    if not line:
        # "A blank line matches no files, so it can serve as a separator
        #  for readability."
        return None
    if line.startswith("#"):
        # "A line starting with # serves as a comment."
        return None
    negative = False
    if line.startswith("!"):
        # "An optional prefix "!" which negates the pattern; any matching file
        #  excluded by a previous pattern will become included again. It is not
        #  possible to re-include a file if a parent directory of that file is
        #  excluded. Git doesn’t list excluded directories for performance
        #  reasons, so any patterns on contained files have no effect, no matter
        #  where they are defined."
        negative = True
        line = line[1:]
    elif line.startswith("\\!"):
        # "Put a backslash ("\") in front of the
        #  first "!" for patterns that begin with a literal "!", for
        #  example, "\!important!.txt"."
        line = line[1:]
    return Rule(negative=negative, content=line)

def _find_match(rules: List[Rule], path: str, is_dir: bool = False) -> Optional[bool]:
    """
    Internal helper function for check_match() and check_path_match().

    Returns True or False if the path matches any of the rules
    (where True is returned for positive rules and False for negative rules).

    Returns None if the path matches no rules.
    """

    # Algorithm: Find the last matching rule in the list and
    #            figure out whether it was not negative.
    for rule in reversed(rules):
        if rule.matches(path, is_dir):
            return not rule.negative
    return None

def check_match(rules: List[Rule], path: str, is_dir: bool = False) -> bool:
    """
    Check whether the given string (likely a path) matches any of the given rules,
    but without any splitting of the path into components.

    See check_path_match() for a version that splits the path into components.
    """
    return bool(_find_match(rules, path, is_dir))

def check_path_match(
    rules: List[Rule],
    path: str,
    split_path: Callable[[str], Tuple[str, str]] = os.path.split,
) -> bool:
    """
    Check whether the given path or its parent directories match any of the rules.

    In other words,

    * Split the path into directory and the filename (using `split_path`)
    * Split the directory into directory parts (using `os.sep`)
    * For each directory part from left to right, merge it with all previous directory
      parts and check that against all rules with `is_dir=True`
        * If a positive match is found, return `True` immediately
        * If no match or a negative match, keep iterating for a possible positive match
          deeper in the path
    * If loop finishes, finally check exact path match with `is_dir=False`.
      If no match, return `False`.
    """

    dirname, _ = split_path(path)
    dir_parts = dirname.split(os.sep)
    path_to_match = ""

    for part in dir_parts:
        path_to_match = os.path.join(path_to_match, part)
        match = _find_match(rules, path_to_match, is_dir=True)
        if match:
            # This directory is ignored, so everything inside it is also ignored
            return True

    return check_match(rules, path, is_dir=False)

def parse_gitignore_file(f: Union[TextIO, Iterable[str]]) -> Iterable[Rule]:
    for line in f:
        rule = try_parse_rule(line)
        if rule is not None:
            yield rule

quality95%

¤ Dauer der Verarbeitung: 0.7 Sekunden ¤

Wurzel

Suchen

Beweissystem der NASA

Beweissystem Isabelle

NIST Cobol Testsuite

Cephes Mathematical Library

Wiener Entwicklungsmethode

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung ist noch experimentell.

Quelle __init__.py Sprache: Python

¤ Dauer der Verarbeitung: 0.7 Sekunden ¤

Haftungshinweis

Bemerkung:

Quelle init.py Sprache: Python