winipedia-utils 0.1.0__tar.gz → 0.1.2__tar.gz

{winipedia_utils-0.1.0 → winipedia_utils-0.1.2}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.3
 Name: winipedia-utils
-Version: 0.1.0
+Version: 0.1.2
 Summary: A package with many utility functions
 License: MIT
 Author: Winipedia
+Author-email: win.steveker@gmx.de
 Requires-Python: >=3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
@@ -12,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
 Requires-Dist: django (>=5.2.1,<6.0.0)
 Requires-Dist: pathspec (>=0.12.1,<0.13.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: setuptools (>=80.3.1,<81.0.0)
 Requires-Dist: tomlkit (>=0.13.2,<0.14.0)
 Requires-Dist: tqdm (>=4.67.1,<5.0.0)

{winipedia_utils-0.1.0 → winipedia_utils-0.1.2}/pyproject.toml

@@ -1,16 +1,15 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.1.0"
+version = "0.1.2"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"
 dynamic = [ "dependencies",]
-[[project.authors]]
-name = "Winipedia"
-
-[project.license]
-text = "MIT"
+authors = [
+    { name = "Winipedia", email = "win.steveker@gmx.de"}
+]
+license = { text = "MIT" }
 
 # Build system section
 [build-system]
@@ -18,7 +17,6 @@ requires = [ "poetry-core>=2.0.0,<3.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 # Poetry section
-[tool.poetry]
 [[tool.poetry.packages]]
 include = "winipedia_utils"
 
@@ -29,6 +27,7 @@ defusedxml = "^0.7.1"
 tomlkit = "^0.13.2"
 pathspec = "^0.12.1"
 django = "^5.2.1"
+pyyaml = "^6.0.2"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "^0.11.7"

winipedia_utils-0.1.2/winipedia_utils/git/gitignore/__init__.py

@@ -0,0 +1 @@
+"""__init__ module for winipedia_utils.git.gitignore."""

{winipedia_utils-0.1.0/winipedia_utils/git → winipedia_utils-0.1.2/winipedia_utils/git/gitignore}/gitignore.py

@@ -37,13 +37,7 @@ def path_is_in_gitignore(relative_path: str | Path) -> bool:
     if is_dir and not as_posix.endswith("/"):
         as_posix += "/"
 
-    gitignore_path = Path(".gitignore")
-    if not gitignore_path.exists():
-        return False  # No ignore rules
-
-    spec = pathspec.PathSpec.from_lines(
-        "gitwildmatch", gitignore_path.read_text().splitlines()
-    )
+    spec = pathspec.PathSpec.from_lines("gitwildmatch", load_gitignore())
 
     return spec.match_file(as_posix)
 
@@ -78,3 +72,65 @@ def walk_os_skipping_gitignore_patterns(
         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-0.1.0 → winipedia_utils-0.1.2}/winipedia_utils/modules/package.py

@@ -19,7 +19,10 @@ from types import ModuleType
 from setuptools import find_namespace_packages as _find_namespace_packages
 from setuptools import find_packages as _find_packages
 
-from winipedia_utils.git.gitignore import walk_os_skipping_gitignore_patterns
+from winipedia_utils.git.gitignore.gitignore import (
+    load_gitignore,
+    walk_os_skipping_gitignore_patterns,
+)
 from winipedia_utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
@@ -148,7 +151,7 @@ def find_packages(
     depth: int | None = None,
     include_namespace_packages: bool = False,
     where: str = ".",
-    exclude: Iterable[str] = (),
+    exclude: Iterable[str] | None = None,
     include: Iterable[str] = ("*",),
 ) -> list[str]:
     """Discover Python packages in the specified directory.
@@ -172,6 +175,11 @@ def find_packages(
         find_packages(depth=1) might return ["package1", "package2"]
 
     """
+    if exclude is None:
+        exclude = load_gitignore()
+        exclude = [
+            p.replace("/", ".").removesuffix(".") for p in exclude if p.endswith("/")
+        ]
     if include_namespace_packages:
         package_names = _find_namespace_packages(
             where=where, exclude=exclude, include=include
@@ -193,7 +201,7 @@ def find_packages_as_modules(
     depth: int | None = None,
     include_namespace_packages: bool = False,
     where: str = ".",
-    exclude: Iterable[str] = (),
+    exclude: Iterable[str] | None = None,
     include: Iterable[str] = ("*",),
 ) -> list[ModuleType]:
     """Discover and import Python packages in the specified directory.

{winipedia_utils-0.1.0 → winipedia_utils-0.1.2}/winipedia_utils/projects/poetry/config.py

@@ -75,7 +75,7 @@ def _pyproject_tool_configs_are_correct() -> bool:
     return True
 
 
-def _add_tool_configurations_to_pyproject_toml() -> None:
+def _add_configurations_to_pyproject_toml() -> None:
     """Add tool.* configurations to pyproject.toml."""
     expected_tool_dict = _get_pyproject_toml_tool_configs()
     toml = laod_pyproject_toml()

{winipedia_utils-0.1.0 → winipedia_utils-0.1.2}/winipedia_utils/setup.py

@@ -6,11 +6,12 @@ This package assumes you are using poetry and pre-commit.
 This script is intended to be called once at the beginning of a project.
 """
 
+from winipedia_utils.git.gitignore.gitignore import _add_package_patterns_to_gitignore
 from winipedia_utils.git.pre_commit.config import _add_package_hook_to_pre_commit_config
 from winipedia_utils.git.pre_commit.run_hooks import _run_all_hooks
 from winipedia_utils.logging.logger import get_logger
 from winipedia_utils.projects.poetry.config import (
-    _add_tool_configurations_to_pyproject_toml,
+    _add_configurations_to_pyproject_toml,
 )
 from winipedia_utils.projects.poetry.poetry import (
     _install_dev_dependencies,
@@ -25,8 +26,10 @@ def _setup() -> None:
     _install_dev_dependencies()
     # create pre-commit config
     _add_package_hook_to_pre_commit_config()
+    # add patterns to .gitignore
+    _add_package_patterns_to_gitignore()
     # add tool.* configurations to pyproject.toml
-    _add_tool_configurations_to_pyproject_toml()
+    _add_configurations_to_pyproject_toml()
     # run pre-commit once, create tests is included here
     _run_all_hooks()
     logger.info("Setup complete!")

{winipedia_utils-0.1.0 → winipedia_utils-0.1.2}/winipedia_utils/testing/tests/base/fixtures/scopes/session.py

@@ -10,6 +10,7 @@ from importlib import import_module
 from pathlib import Path
 
 from winipedia_utils.consts import _DEV_DEPENDENCIES
+from winipedia_utils.git.gitignore.gitignore import _gitignore_is_correct
 from winipedia_utils.git.pre_commit.config import (
     _pre_commit_config_is_correct,
 )
@@ -130,6 +131,29 @@ def _test_pre_commit_config_yaml_is_correct() -> None:
     )
 
 
+@autouse_session_fixture
+def _test_gitignore_is_correct() -> None:
+    """Verify that the .gitignore file exists and has the correct content.
+
+    This fixture runs once per test session and checks that the .gitignore file
+    exists in the root directory and contains the correct content.
+
+    Raises:
+        AssertionError: If the .gitignore file doesn't exist
+                        or has incorrect content
+
+    """
+    gitignore_path = Path(".gitignore")
+    assert_with_msg(
+        gitignore_path.is_file(),
+        f"Expected {gitignore_path} to exist but it doesn't.",
+    )
+    assert_with_msg(
+        _gitignore_is_correct(),
+        "Gitignore is not correct.",
+    )
+
+
 @autouse_session_fixture
 def _test_no_namespace_packages() -> None:
     """Verify that there are no namespace packages in the project.