winipedia-utils 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

winipedia_utils/git/gitignore/__init__.py

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

winipedia_utils/git/{gitignore.py → 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/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/setup.py

@@ -6,6 +6,7 @@ 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
@@ -25,6 +26,8 @@ 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()
     # run pre-commit once, create tests is included here

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.

{winipedia_utils-0.1.0.dist-info → winipedia_utils-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: winipedia-utils
-Version: 0.1.0
+Version: 0.1.1
 Summary: A package with many utility functions
 License: MIT
 Author: Winipedia

{winipedia_utils-0.1.0.dist-info → winipedia_utils-0.1.1.dist-info}/RECORD

@@ -11,7 +11,8 @@ winipedia_utils/django/bulk.py,sha256=7MLfq83xanxbVFo4ANdtcYv5S-oQwdrNkH5ljPzjKL
 winipedia_utils/django/command.py,sha256=ENEg_crSbnm3nQIks-j2DjjAfeZ7ppJkZOyw__IpSYw,13824
 winipedia_utils/django/database.py,sha256=tH8AA5LTMYY-co8R_pI6xs0SrmJqjrOEJUJdnWc4TBE,11487
 winipedia_utils/git/__init__.py,sha256=pPo5DDqaQkFim8L6x22DXjqthLnKAxLyXlXl7JXGUdw,48
-winipedia_utils/git/gitignore.py,sha256=iliNf_FBfcnyGW2zjoh1yg5fOVvSAISt9vOJb10rAUs,2551
+winipedia_utils/git/gitignore/__init__.py,sha256=t65uvpOaNvh7ICgwuJFRr7vS2nWfxzWUGIpnJs0_jzE,58
+winipedia_utils/git/gitignore/gitignore.py,sha256=wCU2lRztTFKQ7JrKnCqPLCsuVRjfx8wGfTy42BLgFJI,4512
 winipedia_utils/git/pre_commit/__init__.py,sha256=2sBe5nOqmm3qb8YjhZzE4tCHhqxWOZ6R2ECljSVG7i4,59
 winipedia_utils/git/pre_commit/config.py,sha256=MUgk-43kd5l0cRk9VKzMQl88bDodsN8rSZcMzSzPpQw,1959
 winipedia_utils/git/pre_commit/hooks.py,sha256=Q6rXvbpUf9UasQ8vSBruoLA-wjm37jamvIUkXJ1B3FE,3210
@@ -26,7 +27,7 @@ winipedia_utils/modules/__init__.py,sha256=e3CFaC3FhK4ibknFOv1bqOZxA7XeVwmLqWX7o
 winipedia_utils/modules/class_.py,sha256=RDjal6QYYs9z81DT1mIFrnEhQ9vgN2tCAYN1WWnN24Y,2462
 winipedia_utils/modules/function.py,sha256=Qn1OPV5dwO-7f3a0f0RpWcrH-E9teGPwldRtwbFYzRM,2551
 winipedia_utils/modules/module.py,sha256=iJwUJPhVkxyRjJqHVVWh3GNJFiYf45ZdSfR21puQAmw,12673
-winipedia_utils/modules/package.py,sha256=CKyeT4Pb2KBzpCM-tHxnC1kq6XvU7W7pWLz1W-wJiv0,12245
+winipedia_utils/modules/package.py,sha256=77DiJmIUrsSsJHAdBZwA8iCi5gv2KSmFCwYyF1uvWLw,12485
 winipedia_utils/oop/__init__.py,sha256=wGjsVwLbTVEQWOfDJvN9nlvC-3NmAi8Doc2xIrm6e78,47
 winipedia_utils/oop/mixins/__init__.py,sha256=PDK-cJcdRUfDUCz36qQ5pmMW07G133WtN49OpmILGNI,54
 winipedia_utils/oop/mixins/meta.py,sha256=UpHags1j80OABxW4Q3QYt7A7lLIArvgUrGcWeYJaRyU,10576
@@ -37,7 +38,7 @@ winipedia_utils/projects/__init__.py,sha256=6oTiSlUMAwO5xnH4SGVnvspzKcxrxo9kn1L4
 winipedia_utils/projects/poetry/__init__.py,sha256=0yNMuu9KmM19od4VBxBV3HLK-RdCsa0e2Zhg33J7RmQ,60
 winipedia_utils/projects/poetry/config.py,sha256=r8sbhsF26yro5qLg2srjl3s9MftwEbfmE2F9bAFA58E,2976
 winipedia_utils/projects/poetry/poetry.py,sha256=5jyUSMxhCZ7pz9bOaz5E9r7Da9qIrGOp6wcBzI1y7Cg,932
-winipedia_utils/setup.py,sha256=ozdPXwHBRWLSiL2xLfbWnRZ_OHl560eKgP8e94cuDAM,1280
+winipedia_utils/setup.py,sha256=hu-LoIIOEeDa9uUsOSIl5PWrRDjtVCiyucRBjiML1u4,1444
 winipedia_utils/testing/__init__.py,sha256=kXhB5xw02ec5xpcW_KV--9CBKdyCjnuR-NZzAJ5tq0g,51
 winipedia_utils/testing/assertions.py,sha256=0JF4mqVTnLQ1qkAL_FuTwyN_idr00rvVlta7aDdnUXA,851
 winipedia_utils/testing/convention.py,sha256=NxC_hYaUXshsa6LL6nQoEEKpTzC1KwTloKL8aS2gUPI,5010
@@ -52,13 +53,13 @@ winipedia_utils/testing/tests/base/fixtures/scopes/class_.py,sha256=XCx4HZeHbJJ-
 winipedia_utils/testing/tests/base/fixtures/scopes/function.py,sha256=5dW7-IPqJ_3Q2j1vftZL5FYKvNSKufqiHzLTTWYhja4,309
 winipedia_utils/testing/tests/base/fixtures/scopes/module.py,sha256=V0H9WFrdSV7uj__bXM_GKcCJnjResqI7fFjcxyvNaZk,1169
 winipedia_utils/testing/tests/base/fixtures/scopes/package.py,sha256=IKOfj6vfyjEQdRV5cJoPRQvALmePpGxWkGy23di00-w,309
-winipedia_utils/testing/tests/base/fixtures/scopes/session.py,sha256=dd8QRSV_zJpz6_r0Xinryar-ciblFxszn0Bh5p2I6Pw,7652
+winipedia_utils/testing/tests/base/fixtures/scopes/session.py,sha256=CP-CY_qsa2bc8FCIvb64LaB_G0C43eGa3Rt8QtnY4LQ,8435
 winipedia_utils/testing/tests/base/utils/__init__.py,sha256=mC-8dCkp8xarqkQu2QQLrPjHi6Ww9hcixWdHeQHWeRs,68
 winipedia_utils/testing/tests/base/utils/utils.py,sha256=dUPDrgAxlfREQb33zz23MfzacLLuwjy2AO-PQQp_aSI,2820
 winipedia_utils/testing/tests/conftest.py,sha256=CvLtsr-KhSPzbQYin6SYZQC1Ez3AzIsqCWhuLuXinAs,826
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/string.py,sha256=1jbBftlgxffGgSlPnQh3aRPIr8XekEwpSenjFCW6JyM,3478
-winipedia_utils-0.1.0.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
-winipedia_utils-0.1.0.dist-info/METADATA,sha256=_mORtARL4qiNjHVQRf-1FtpYsFmKFhruGwGSa5kzPzg,12311
-winipedia_utils-0.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-winipedia_utils-0.1.0.dist-info/RECORD,,
+winipedia_utils-0.1.1.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
+winipedia_utils-0.1.1.dist-info/METADATA,sha256=UBPvyoK1Hk-0TdpO_7_x2uTtrSp2QQ-ElLvsGyTNzDQ,12311
+winipedia_utils-0.1.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+winipedia_utils-0.1.1.dist-info/RECORD,,