winipedia-utils 0.1.63__py3-none-any.whl → 0.2.0__py3-none-any.whl

winipedia_utils/git/gitignore/gitignore.py

@@ -1,136 +1,136 @@
-"""Git utilities for file and directory operations.
-
-This module provides utility functions for working with Git repositories,
-including checking if paths are in .gitignore and walking directories
-while respecting gitignore patterns. These utilities help with file operations
-that need to respect Git's ignore rules.
-"""
-
-import os
-from collections.abc import Generator
-from pathlib import Path
-
-import pathspec
-
-from winipedia_utils.logging.logger import get_logger
-
-logger = get_logger(__name__)
-
-
-def path_is_in_gitignore(relative_path: str | Path) -> bool:
-    """Check if a path matches any pattern in the .gitignore file.
-
-    Args:
-        relative_path: The path to check, relative to the repository root
-
-    Returns:
-        True if the path matches any pattern in .gitignore, False otherwise
-
-    """
-    as_path = Path(relative_path)
-    is_dir = (
-        bool(as_path.suffix == "") or as_path.is_dir() or str(as_path).endswith(os.sep)
-    )
-    is_dir = is_dir and not as_path.is_file()
-
-    as_posix = as_path.as_posix()
-    if is_dir and not as_posix.endswith("/"):
-        as_posix += "/"
-
-    spec = pathspec.PathSpec.from_lines("gitwildmatch", load_gitignore())
-
-    return spec.match_file(as_posix)
-
-
-def walk_os_skipping_gitignore_patterns(
-    folder: str | Path = ".",
-) -> Generator[tuple[Path, list[str], list[str]], None, None]:
-    """Walk a directory tree while skipping paths that match gitignore patterns.
-
-    Similar to os.walk, but skips directories and files that match patterns
-    in the .gitignore file.
-
-    Args:
-        folder: The root directory to start walking from
-
-    Yields:
-        Tuples of (current_path, directories, files) for each directory visited
-
-    """
-    folder = Path(folder)
-    for root, dirs, files in os.walk(folder):
-        rel_root = Path(root).relative_to(".")
-
-        # skip all in patterns in .gitignore
-        if path_is_in_gitignore(rel_root):
-            logger.info("Skipping %s because it is in .gitignore", rel_root)
-            dirs.clear()
-            continue
-
-        # remove all files that match patterns in .gitignore
-        valid_files = [f for f in files if not path_is_in_gitignore(rel_root / f)]
-        valid_dirs = [d for d in dirs if not path_is_in_gitignore(rel_root / d)]
-
-        yield rel_root, valid_dirs, valid_files
-
-
-def load_gitignore() -> list[str]:
-    """Load the .gitignore file."""
-    gitignore_path = Path(".gitignore")
-    if not gitignore_path.exists():
-        gitignore_path.touch()
-    return gitignore_path.read_text().splitlines()
-
-
-def dump_gitignore(patterns: list[str]) -> None:
-    """Dump the given patterns to a .gitignore file (overwrites it)."""
-    gitignore_path = Path(".gitignore")
-    gitignore_path.write_text("\n".join(patterns))
-
-
-def add_patterns_to_gitignore(patterns: list[str]) -> None:
-    """Add the given patterns to the .gitignore file."""
-    existing_patterns = load_gitignore()
-    new_patterns = [p for p in patterns if p not in existing_patterns]
-    if new_patterns:
-        logger.info("Adding patterns to .gitignore: %s", new_patterns)
-        dump_gitignore(existing_patterns + new_patterns)
-
-
-def _get_gitignore_patterns() -> list[str]:
-    """Get the patterns that should be in the .gitignore file.
-
-    Those are the patterns that should be in there when using winipedia_utils.
-    """
-    return [
-        "__pycache__/",
-        ".idea/",
-        ".mypy_cache/",
-        ".pytest_cache/",
-        ".ruff_cache/",
-        ".vscode/",
-        "dist/",
-        "test.py",  # I use this for testing code
-        ".git/",  # ignore the .git folder for walk_os_skipping_gitignore_patterns func
-    ]
-
-
-def _get_missing_patterns() -> list[str]:
-    """Get the patterns that are in the .gitignore file but shouldn't be."""
-    needed_patterns = _get_gitignore_patterns()
-    existing_patterns = load_gitignore()
-    return [p for p in needed_patterns if p not in existing_patterns]
-
-
-def _gitignore_is_correct() -> bool:
-    """Check if the .gitignore file contains all the patterns it should."""
-    missing_patterns = _get_missing_patterns()
-    return not missing_patterns
-
-
-def _add_package_patterns_to_gitignore() -> None:
-    """Add any missing patterns to the .gitignore file."""
-    if _gitignore_is_correct():
-        return
-    missing_patterns = _get_missing_patterns()
-    add_patterns_to_gitignore(missing_patterns)
+"""Git utilities for file and directory operations.
+
+This module provides utility functions for working with Git repositories,
+including checking if paths are in .gitignore and walking directories
+while respecting gitignore patterns. These utilities help with file operations
+that need to respect Git's ignore rules.
+"""
+
+import os
+from collections.abc import Generator
+from pathlib import Path
+
+import pathspec
+
+from winipedia_utils.logging.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def path_is_in_gitignore(relative_path: str | Path) -> bool:
+    """Check if a path matches any pattern in the .gitignore file.
+
+    Args:
+        relative_path: The path to check, relative to the repository root
+
+    Returns:
+        True if the path matches any pattern in .gitignore, False otherwise
+
+    """
+    as_path = Path(relative_path)
+    is_dir = (
+        bool(as_path.suffix == "") or as_path.is_dir() or str(as_path).endswith(os.sep)
+    )
+    is_dir = is_dir and not as_path.is_file()
+
+    as_posix = as_path.as_posix()
+    if is_dir and not as_posix.endswith("/"):
+        as_posix += "/"
+
+    spec = pathspec.PathSpec.from_lines("gitwildmatch", load_gitignore())
+
+    return spec.match_file(as_posix)
+
+
+def walk_os_skipping_gitignore_patterns(
+    folder: str | Path = ".",
+) -> Generator[tuple[Path, list[str], list[str]], None, None]:
+    """Walk a directory tree while skipping paths that match gitignore patterns.
+
+    Similar to os.walk, but skips directories and files that match patterns
+    in the .gitignore file.
+
+    Args:
+        folder: The root directory to start walking from
+
+    Yields:
+        Tuples of (current_path, directories, files) for each directory visited
+
+    """
+    folder = Path(folder)
+    for root, dirs, files in os.walk(folder):
+        rel_root = Path(root).relative_to(".")
+
+        # skip all in patterns in .gitignore
+        if path_is_in_gitignore(rel_root):
+            logger.info("Skipping %s because it is in .gitignore", rel_root)
+            dirs.clear()
+            continue
+
+        # remove all files that match patterns in .gitignore
+        valid_files = [f for f in files if not path_is_in_gitignore(rel_root / f)]
+        valid_dirs = [d for d in dirs if not path_is_in_gitignore(rel_root / d)]
+
+        yield rel_root, valid_dirs, valid_files
+
+
+def load_gitignore() -> list[str]:
+    """Load the .gitignore file."""
+    gitignore_path = Path(".gitignore")
+    if not gitignore_path.exists():
+        gitignore_path.touch()
+    return gitignore_path.read_text().splitlines()
+
+
+def dump_gitignore(patterns: list[str]) -> None:
+    """Dump the given patterns to a .gitignore file (overwrites it)."""
+    gitignore_path = Path(".gitignore")
+    gitignore_path.write_text("\n".join(patterns))
+
+
+def add_patterns_to_gitignore(patterns: list[str]) -> None:
+    """Add the given patterns to the .gitignore file."""
+    existing_patterns = load_gitignore()
+    new_patterns = [p for p in patterns if p not in existing_patterns]
+    if new_patterns:
+        logger.info("Adding patterns to .gitignore: %s", new_patterns)
+        dump_gitignore(existing_patterns + new_patterns)
+
+
+def _get_gitignore_patterns() -> list[str]:
+    """Get the patterns that should be in the .gitignore file.
+
+    Those are the patterns that should be in there when using winipedia_utils.
+    """
+    return [
+        "__pycache__/",
+        ".idea/",
+        ".mypy_cache/",
+        ".pytest_cache/",
+        ".ruff_cache/",
+        ".vscode/",
+        "dist/",
+        "test.py",  # I use this for testing code
+        ".git/",  # ignore the .git folder for walk_os_skipping_gitignore_patterns func
+    ]
+
+
+def _get_missing_patterns() -> list[str]:
+    """Get the patterns that are in the .gitignore file but shouldn't be."""
+    needed_patterns = _get_gitignore_patterns()
+    existing_patterns = load_gitignore()
+    return [p for p in needed_patterns if p not in existing_patterns]
+
+
+def _gitignore_is_correct() -> bool:
+    """Check if the .gitignore file contains all the patterns it should."""
+    missing_patterns = _get_missing_patterns()
+    return not missing_patterns
+
+
+def _add_package_patterns_to_gitignore() -> None:
+    """Add any missing patterns to the .gitignore file."""
+    if _gitignore_is_correct():
+        return
+    missing_patterns = _get_missing_patterns()
+    add_patterns_to_gitignore(missing_patterns)

winipedia_utils/git/pre_commit/__init__.py

@@ -1 +1 @@
-"""__init__ module for winipedia_utils.git.pre_commit."""
+"""__init__ module for winipedia_utils.git.pre_commit."""

winipedia_utils/git/pre_commit/config.py

@@ -1,70 +1,70 @@
-"""Has config utilities for pre-commit."""
-
-from pathlib import Path
-from typing import Any
-
-import yaml
-
-from winipedia_utils.logging.logger import get_logger
-from winipedia_utils.os.os import run_subprocess
-from winipedia_utils.projects.poetry.poetry import POETRY_RUN_ARGS
-
-logger = get_logger(__name__)
-
-
-def load_pre_commit_config() -> dict[str, Any]:
-    """Load the pre-commit config."""
-    path = Path(".pre-commit-config.yaml")
-    if not path.exists():
-        path.touch()
-    return yaml.safe_load(path.read_text()) or {}
-
-
-def dump_pre_commit_config(config: dict[str, Any]) -> None:
-    """Dump the pre-commit config."""
-    path = Path(".pre-commit-config.yaml")
-    with path.open("w") as f:
-        yaml.safe_dump(config, f, sort_keys=False)
-
-
-def _get_pre_commit_config_dict() -> dict[str, Any]:
-    """Get the content for a pre-commit config file as a dictionary."""
-    return {
-        "repo": "local",
-        "hooks": [
-            {
-                "id": "winipedia-utils",
-                "name": "winipedia-utils",
-                "entry": "python -m winipedia_utils.git.pre_commit.run_hooks",
-                "language": "system",
-                "always_run": True,
-                "pass_filenames": False,
-            }
-        ],
-    }
-
-
-def _pre_commit_config_is_correct() -> bool:
-    """Check if the pre-commit config is correct."""
-    config = load_pre_commit_config()
-    package_hook_config = _get_pre_commit_config_dict().get("hooks", [{}])[0]
-    return bool(
-        config.get("repos", [{}])[0].get("hooks", [{}])[0] == package_hook_config
-    )
-
-
-def _add_package_hook_to_pre_commit_config() -> None:
-    """Add the winipedia-utils hook to the pre-commit config."""
-    config = load_pre_commit_config()
-    package_hook_config = _get_pre_commit_config_dict()
-    # insert at the beginning of the list
-    if not _pre_commit_config_is_correct():
-        logger.info("Adding winipedia-utils hook to pre-commit config")
-        config["repos"] = [package_hook_config, *config.get("repos", [])]
-        dump_pre_commit_config(config)
-
-
-def _pre_commit_install() -> None:
-    """Install pre-commit."""
-    logger.info("Running pre-commit install")
-    run_subprocess([*POETRY_RUN_ARGS, "pre-commit", "install"], check=True)
+"""Has config utilities for pre-commit."""
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+from winipedia_utils.logging.logger import get_logger
+from winipedia_utils.os.os import run_subprocess
+from winipedia_utils.projects.poetry.poetry import POETRY_RUN_ARGS
+
+logger = get_logger(__name__)
+
+
+def load_pre_commit_config() -> dict[str, Any]:
+    """Load the pre-commit config."""
+    path = Path(".pre-commit-config.yaml")
+    if not path.exists():
+        path.touch()
+    return yaml.safe_load(path.read_text()) or {}
+
+
+def dump_pre_commit_config(config: dict[str, Any]) -> None:
+    """Dump the pre-commit config."""
+    path = Path(".pre-commit-config.yaml")
+    with path.open("w") as f:
+        yaml.safe_dump(config, f, sort_keys=False)
+
+
+def _get_pre_commit_config_dict() -> dict[str, Any]:
+    """Get the content for a pre-commit config file as a dictionary."""
+    return {
+        "repo": "local",
+        "hooks": [
+            {
+                "id": "winipedia-utils",
+                "name": "winipedia-utils",
+                "entry": "python -m winipedia_utils.git.pre_commit.run_hooks",
+                "language": "system",
+                "always_run": True,
+                "pass_filenames": False,
+            }
+        ],
+    }
+
+
+def _pre_commit_config_is_correct() -> bool:
+    """Check if the pre-commit config is correct."""
+    config = load_pre_commit_config()
+    package_hook_config = _get_pre_commit_config_dict().get("hooks", [{}])[0]
+    return bool(
+        config.get("repos", [{}])[0].get("hooks", [{}])[0] == package_hook_config
+    )
+
+
+def _add_package_hook_to_pre_commit_config() -> None:
+    """Add the winipedia-utils hook to the pre-commit config."""
+    config = load_pre_commit_config()
+    package_hook_config = _get_pre_commit_config_dict()
+    # insert at the beginning of the list
+    if not _pre_commit_config_is_correct():
+        logger.info("Adding winipedia-utils hook to pre-commit config")
+        config["repos"] = [package_hook_config, *config.get("repos", [])]
+        dump_pre_commit_config(config)
+
+
+def _pre_commit_install() -> None:
+    """Install pre-commit."""
+    logger.info("Running pre-commit install")
+    run_subprocess([*POETRY_RUN_ARGS, "pre-commit", "install"], check=True)

winipedia_utils/git/pre_commit/hooks.py

@@ -1,109 +1,109 @@
-"""module contains functions that return the input for subprocess.run().
-
-Each function is named after the hook it represents. The docstring of each function
-describes the hook it represents. The function returns a list of strings that
-represent the command to run. The first string is the command, and the following
-strings are the arguments to the command. These funcs will be called by
-run_hooks.py, which will pass the returned list to subprocess.run().
-"""
-
-from pathlib import Path
-
-from winipedia_utils.projects.poetry.poetry import (
-    POETRY_PATH,
-    POETRY_RUN_ARGS,
-    POETRY_RUN_PYTHON_ARGS,
-    POETRY_RUN_RUFF_ARGS,
-)
-
-
-def _update_package_manager() -> list[str | Path]:
-    """Update the package manager.
-
-    This function returns the input for subprocess.run() to update the package
-    manager.
-    """
-    return [POETRY_PATH, "self", "update"]
-
-
-def _install_packages() -> list[str | Path]:
-    """Install all dependencies.
-
-    This function returns the input for subprocess.run() to install all dependencies.
-    """
-    return [POETRY_PATH, "install"]
-
-
-def _update_packages() -> list[str | Path]:
-    """Update all dependencies.
-
-    This function returns the input for subprocess.run() to update all dependencies.
-    """
-    return [POETRY_PATH, "update"]
-
-
-def _lock_dependencies() -> list[str | Path]:
-    """Lock the dependencies.
-
-    This function returns the input for subprocess.run() to lock the dependencies.
-    """
-    return [POETRY_PATH, "lock"]
-
-
-def _check_configurations() -> list[str | Path]:
-    """Check that poetry.lock and pyproject.toml is up to date.
-
-    This function returns the input for subprocess.run() to check that poetry.lock
-    is up to date.
-    """
-    return [POETRY_PATH, "check", "--strict"]
-
-
-def _creating_tests() -> list[str | Path]:
-    """Create all tests for the project.
-
-    This function returns the input for subprocess.run() to create all tests.
-    """
-    return [*POETRY_RUN_PYTHON_ARGS, "-m", "winipedia_utils.testing.create_tests"]
-
-
-def _linting() -> list[str | Path]:
-    """Check the code.
-
-    This function returns the input for subprocess.run() to lint the code.
-    It autofixes all errors that can be autofixed with --fix.
-    """
-    return [*POETRY_RUN_RUFF_ARGS, "check", "--fix"]
-
-
-def _formating() -> list[str | Path]:
-    """Format the code.
-
-    This function calls ruff format to format the code.
-    """
-    return [*POETRY_RUN_RUFF_ARGS, "format"]
-
-
-def _type_checking() -> list[str | Path]:
-    """Check the types.
-
-    This function returns the input for subprocess.run() to check the static types.
-    """
-    return [*POETRY_RUN_ARGS, "mypy"]
-
-
-def _security_checking() -> list[str | Path]:
-    """Check the security of the code.
-
-    This function returns the input for subprocess.run() to check the security of
-    the code.
-    """
-    return [*POETRY_RUN_ARGS, "bandit", "-c", "pyproject.toml", "-r", "."]
-
-
-def _testing() -> list[str | Path]:
-    """Run the tests.
-
-    This function returns the input for subprocess.run() to run all tests.
-    """
-    return [*POETRY_RUN_ARGS, "pytest"]
+"""module contains functions that return the input for subprocess.run().
+
+Each function is named after the hook it represents. The docstring of each function
+describes the hook it represents. The function returns a list of strings that
+represent the command to run. The first string is the command, and the following
+strings are the arguments to the command. These funcs will be called by
+run_hooks.py, which will pass the returned list to subprocess.run().
+"""
+
+from pathlib import Path
+
+from winipedia_utils.projects.poetry.poetry import (
+    POETRY_PATH,
+    POETRY_RUN_ARGS,
+    POETRY_RUN_PYTHON_ARGS,
+    POETRY_RUN_RUFF_ARGS,
+)
+
+
+def _update_package_manager() -> list[str | Path]:
+    """Update the package manager.
+
+    This function returns the input for subprocess.run() to update the package
+    manager.
+    """
+    return [POETRY_PATH, "self", "update"]
+
+
+def _install_packages() -> list[str | Path]:
+    """Install all dependencies.
+
+    This function returns the input for subprocess.run() to install all dependencies.
+    """
+    return [POETRY_PATH, "install"]
+
+
+def _update_packages() -> list[str | Path]:
+    """Update all dependencies.
+
+    This function returns the input for subprocess.run() to update all dependencies.
+    """
+    return [POETRY_PATH, "update"]
+
+
+def _lock_dependencies() -> list[str | Path]:
+    """Lock the dependencies.
+
+    This function returns the input for subprocess.run() to lock the dependencies.
+    """
+    return [POETRY_PATH, "lock"]
+
+
+def _check_configurations() -> list[str | Path]:
+    """Check that poetry.lock and pyproject.toml is up to date.
+
+    This function returns the input for subprocess.run() to check that poetry.lock
+    is up to date.
+    """
+    return [POETRY_PATH, "check", "--strict"]
+
+
+def _creating_tests() -> list[str | Path]:
+    """Create all tests for the project.
+
+    This function returns the input for subprocess.run() to create all tests.
+    """
+    return [*POETRY_RUN_PYTHON_ARGS, "-m", "winipedia_utils.testing.create_tests"]
+
+
+def _linting() -> list[str | Path]:
+    """Check the code.
+
+    This function returns the input for subprocess.run() to lint the code.
+    It autofixes all errors that can be autofixed with --fix.
+    """
+    return [*POETRY_RUN_RUFF_ARGS, "check", "--fix"]
+
+
+def _formating() -> list[str | Path]:
+    """Format the code.
+
+    This function calls ruff format to format the code.
+    """
+    return [*POETRY_RUN_RUFF_ARGS, "format"]
+
+
+def _type_checking() -> list[str | Path]:
+    """Check the types.
+
+    This function returns the input for subprocess.run() to check the static types.
+    """
+    return [*POETRY_RUN_ARGS, "mypy"]
+
+
+def _security_checking() -> list[str | Path]:
+    """Check the security of the code.
+
+    This function returns the input for subprocess.run() to check the security of
+    the code.
+    """
+    return [*POETRY_RUN_ARGS, "bandit", "-c", "pyproject.toml", "-r", "."]
+
+
+def _testing() -> list[str | Path]:
+    """Run the tests.
+
+    This function returns the input for subprocess.run() to run all tests.
+    """
+    return [*POETRY_RUN_ARGS, "pytest"]