Commit 51756a40 authored by Mika⠙'s avatar Mika⠙ Committed by Łukasz Langa
Browse files

Added --include and --exclude cli options (#281)

These 2 options allow you to pass in regular expressions that determine
whether files/directories are included or excluded in the recursive file
search.

Fixes #270 
parent 1b189f6c
Loading
Loading
Loading
Loading
+13 −0
Changes for README.md: 13 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -89,6 +89,17 @@ Options:
                              **kwargs.  [default: per-file auto-detection]
  -S, --skip-string-normalization
                              Don't normalize string quotes or prefixes.
  --include TEXT              A regular expression that matches files and
                              directories that should be included on
                              recursive searches. On Windows, use forward
                              slashes for directories.  [default: \.pyi?$]
  --exclude TEXT              A regular expression that matches files and
                              directories that should be excluded on
                              recursive searches. On Windows, use forward
                              slashes for directories.  [default:
                              build/|buck-out/|dist/|_build/|\.git/|\.hg/|
                              \.mypy_cache/|\.tox/|\.venv/]

  --version                   Show the version and exit.
  --help                      Show this message and exit.
```
@@ -698,6 +709,8 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).

### 18.6b0

* added `--include` and `--exclude` (#270)

* added `--skip-string-normalization` (#118)

* fixed stdin handling not working correctly if an old version of Click was
+61 −21
Changes for black.py: 61 added lines, 21 removed lines.
Original line number Diff line number Diff line
@@ -46,6 +46,10 @@

__version__ = "18.5b1"
DEFAULT_LINE_LENGTH = 88
DEFAULT_EXCLUDES = (
    r"build/|buck-out/|dist/|_build/|\.git/|\.hg/|\.mypy_cache/|\.tox/|\.venv/"
)
DEFAULT_INCLUDES = r"\.pyi?$"
CACHE_DIR = Path(user_cache_dir("black", version=__version__))


@@ -189,6 +193,28 @@ class FileMode(Flag):
    is_flag=True,
    help="Don't normalize string quotes or prefixes.",
)
@click.option(
    "--include",
    type=str,
    default=DEFAULT_INCLUDES,
    help=(
        "A regular expression that matches files and directories that should be "
        "included on recursive searches. On Windows, use forward slashes for "
        "directories."
    ),
    show_default=True,
)
@click.option(
    "--exclude",
    type=str,
    default=DEFAULT_EXCLUDES,
    help=(
        "A regular expression that matches files and directories that should be "
        "excluded on recursive searches. On Windows, use forward slashes for "
        "directories."
    ),
    show_default=True,
)
@click.version_option(version=__version__)
@click.argument(
    "src",
@@ -208,14 +234,26 @@ def main(
    py36: bool,
    skip_string_normalization: bool,
    quiet: bool,
    include: str,
    exclude: str,
    src: List[str],
) -> None:
    """The uncompromising code formatter."""
    sources: List[Path] = []
    try:
        include_regex = re.compile(include)
    except re.error:
        err(f"Invalid regular expression for include given: {include!r}")
        ctx.exit(2)
    try:
        exclude_regex = re.compile(exclude)
    except re.error:
        err(f"Invalid regular expression for exclude given: {exclude!r}")
        ctx.exit(2)
    for s in src:
        p = Path(s)
        if p.is_dir():
            sources.extend(gen_python_files_in_dir(p))
            sources.extend(gen_python_files_in_dir(p, include_regex, exclude_regex))
        elif p.is_file():
            # if a file was explicitly given, we don't care about its extension
            sources.append(p)
@@ -2750,32 +2788,34 @@ def get_future_imports(node: Node) -> Set[str]:
    return imports


PYTHON_EXTENSIONS = {".py", ".pyi"}
BLACKLISTED_DIRECTORIES = {
    "build",
    "buck-out",
    "dist",
    "_build",
    ".git",
    ".hg",
    ".mypy_cache",
    ".tox",
    ".venv",
}


def gen_python_files_in_dir(path: Path) -> Iterator[Path]:
    """Generate all files under `path` which aren't under BLACKLISTED_DIRECTORIES
    and have one of the PYTHON_EXTENSIONS.
def gen_python_files_in_dir(
    path: Path, include: Pattern[str], exclude: Pattern[str]
) -> Iterator[Path]:
    """Generate all files under `path` whose paths are not excluded by the
    `exclude` regex, but are included by the `include` regex.
    """

    for child in path.iterdir():
        searchable_path = str(child.as_posix())
        if Path(child.parts[0]).is_dir():
            searchable_path = "/" + searchable_path
        if child.is_dir():
            if child.name in BLACKLISTED_DIRECTORIES:
            searchable_path = searchable_path + "/"
            exclude_match = exclude.search(searchable_path)
            if exclude_match and len(exclude_match.group()) > 0:
                continue

            yield from gen_python_files_in_dir(child)
            yield from gen_python_files_in_dir(child, include, exclude)

        elif child.is_file() and child.suffix in PYTHON_EXTENSIONS:
        else:
            include_match = include.search(searchable_path)
            exclude_match = exclude.search(searchable_path)
            if (
                child.is_file()
                and include_match
                and len(include_match.group()) > 0
                and (not exclude_match or len(exclude_match.group()) == 0)
            ):
                yield child


+0 −0

Empty file added.

+0 −0

Empty file added.

+0 −0

Empty file added.

Loading