winipedia-utils 0.4.34__tar.gz → 0.4.39__tar.gz

{winipedia_utils-0.4.34 → winipedia_utils-0.4.39}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.34
+Version: 0.4.39
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE
@@ -103,13 +103,14 @@ The setup creates the following configuration files:
 - `.pre-commit-config.yaml` - Pre-commit hook configuration
 - `.gitignore` - Git ignore rules (assumes you added one on GitHub before.)
 - `pyproject.toml` - Project configuration with Poetry settings
-- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request)
+- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request, all workfows run on the latest possible python version in pyproject.toml)
 - `.github/workflows/release.yaml` - Release workflow (Creates a release on GitHub when the same actions as in health check pass and commits are pushed to main)
 - `.github/workflows/publish.yaml` - Publishing workflow (Publishes to PyPI when a release is created by the release workflow, if you use this workflow, you need to add a PYPI_TOKEN (named PYPI_TOKEN) to your GitHub secrets that has write access to the package on PyPI.)
 - `py.typed` - PEP 561 marker for type hints
 - `experiment.py` - For experimentation (ignored by git)
 - `test_zero.py` - Test file with one empyt test (so that initial tests pass)
 - `conftest.py` - Pytest configuration file
+- `.python-version` - Python version file for pyenv (if you use pyenv, puts in the lowest supported python version in pyproject.toml opposed to the latest possible python version in workflows)
 
 ### Pre-commit Hook Workflow
 

{winipedia_utils-0.4.34 → winipedia_utils-0.4.39}/README.md

@@ -77,13 +77,14 @@ The setup creates the following configuration files:
 - `.pre-commit-config.yaml` - Pre-commit hook configuration
 - `.gitignore` - Git ignore rules (assumes you added one on GitHub before.)
 - `pyproject.toml` - Project configuration with Poetry settings
-- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request)
+- `.github/workflows/health_check.yaml` - Health check workflow (Runs on every push and pull request, all workfows run on the latest possible python version in pyproject.toml)
 - `.github/workflows/release.yaml` - Release workflow (Creates a release on GitHub when the same actions as in health check pass and commits are pushed to main)
 - `.github/workflows/publish.yaml` - Publishing workflow (Publishes to PyPI when a release is created by the release workflow, if you use this workflow, you need to add a PYPI_TOKEN (named PYPI_TOKEN) to your GitHub secrets that has write access to the package on PyPI.)
 - `py.typed` - PEP 561 marker for type hints
 - `experiment.py` - For experimentation (ignored by git)
 - `test_zero.py` - Test file with one empyt test (so that initial tests pass)
 - `conftest.py` - Pytest configuration file
+- `.python-version` - Python version file for pyenv (if you use pyenv, puts in the lowest supported python version in pyproject.toml opposed to the latest possible python version in workflows)
 
 ### Pre-commit Hook Workflow
 

{winipedia_utils-0.4.34 → winipedia_utils-0.4.39}/pyproject.toml

@@ -1,7 +1,7 @@
 # Project section
 [project]
 name = "winipedia-utils"
-version = "0.4.34"
+version = "0.4.39"
 description = "A package with many utility functions"
 readme = "README.md"
 requires-python = ">=3.12"

winipedia_utils-0.4.39/winipedia_utils/git/github/github.py

@@ -0,0 +1,31 @@
+"""GitHub utilities for working with GitHub repositories."""
+
+import os
+
+from winipedia_utils.text.config import DotEnvConfigFile
+
+
+def get_github_repo_token() -> str:
+    """Get the GitHub token."""
+    # try os env first
+    token = os.getenv("REPO_TOKEN")
+    if token:
+        return token
+
+    # try .env next
+    dotenv_path = DotEnvConfigFile.get_path()
+    if not dotenv_path.exists():
+        msg = f"Expected {dotenv_path} to exist"
+        raise ValueError(msg)
+    dotenv = DotEnvConfigFile.load()
+    token = dotenv.get("REPO_TOKEN")
+    if token:
+        return token
+
+    msg = f"Expected REPO_TOKEN in {dotenv_path}"
+    raise ValueError(msg)
+
+
+def running_in_github_action() -> bool:
+    """Check if we are running in a GitHub action."""
+    return os.getenv("GITHUB_ACTIONS", "false") == "true"

{winipedia_utils-0.4.34 → winipedia_utils-0.4.39}/winipedia_utils/git/github/repo/protect.py

@@ -2,6 +2,7 @@
 
 from typing import Any
 
+from winipedia_utils.git.github.github import get_github_repo_token
 from winipedia_utils.git.github.repo.repo import (
     DEFAULT_BRANCH,
     DEFAULT_RULESET_NAME,
@@ -12,7 +13,6 @@ from winipedia_utils.git.github.repo.repo import (
 from winipedia_utils.git.github.workflows.health_check import HealthCheckWorkflow
 from winipedia_utils.modules.package import get_src_package
 from winipedia_utils.projects.poetry.config import PyprojectConfigFile
-from winipedia_utils.testing.tests.base.utils.utils import get_github_repo_token
 
 
 def protect_repository() -> None:

{winipedia_utils-0.4.34 → winipedia_utils-0.4.39}/winipedia_utils/projects/poetry/config.py

@@ -3,10 +3,8 @@
 from pathlib import Path
 from typing import Any, cast
 
-from packaging.specifiers import SpecifierSet
-from packaging.version import Version
-
 from winipedia_utils.modules.package import get_src_package, make_name_from_package
+from winipedia_utils.projects.poetry.poetry import VersionConstraint
 from winipedia_utils.testing.convention import TESTS_PACKAGE_NAME
 from winipedia_utils.text.config import ConfigFile, TomlConfigFile
 
@@ -137,19 +135,30 @@ class PyprojectConfigFile(TomlConfigFile):
     def get_latest_possible_python_version(cls) -> str:
         """Get the latest possible python version."""
         constraint = cls.load()["project"]["requires-python"]
-        spec = constraint.strip().strip('"').strip("'")
-        sset = SpecifierSet(spec)
-        # find upper bound specifiers
-        uppers = [Version(sp.version) for sp in sset if sp.operator in ("<", "<=")]
-        if uppers:
-            top = max(uppers)
-            # if strict "<", we might treat it as “one less” in minor
-            if any(sp.operator == "<" and Version(sp.version) == top for sp in sset):
-                # subtract one minor
-                return f"{top.major}.{top.minor - 1}"
-            return f"{top.major}.{top.minor}"
-        # no upper bound → “3.x”
-        return "3.x"
+        version_constraint = VersionConstraint(constraint)
+        upper = version_constraint.get_upper_exclusive()
+        if upper is None:
+            return "3.x"
+
+        # convert to inclusive
+        if upper.micro != 0:
+            micro = upper.micro - 1
+            return f"{upper.major}.{upper.minor}" + (f".{micro}" if micro != 0 else "")
+        if upper.minor != 0:
+            minor = upper.minor - 1
+            return f"{upper.major}" + (f".{minor}" if minor != 0 else "")
+        return f"{upper.major - 1}.x"
+
+    @classmethod
+    def get_first_supported_python_version(cls) -> str:
+        """Get the first supported python version."""
+        constraint = cls.load()["project"]["requires-python"]
+        version_constraint = VersionConstraint(constraint)
+        lower = version_constraint.get_lower_inclusive()
+        if lower is None:
+            msg = "Need a lower bound for python version"
+            raise ValueError(msg)
+        return str(lower)
 
 
 class TypedConfigFile(ConfigFile):
@@ -185,3 +194,44 @@ class PyTypedConfigFile(ConfigFile):
     def get_parent_path(cls) -> Path:
         """Get the path to the config file."""
         return Path(PyprojectConfigFile.get_package_name())
+
+
+class DotPythonVersionConfigFile(ConfigFile):
+    """Config file for .python-version."""
+
+    VERSION_KEY = "version"
+
+    @classmethod
+    def get_filename(cls) -> str:
+        """Get the filename of the config file."""
+        return ""  # so it builds the path .python-version
+
+    @classmethod
+    def get_file_extension(cls) -> str:
+        """Get the file extension of the config file."""
+        return "python-version"
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the path to the config file."""
+        return Path()
+
+    @classmethod
+    def get_configs(cls) -> dict[str, Any]:
+        """Get the config."""
+        return {
+            cls.VERSION_KEY: PyprojectConfigFile.get_first_supported_python_version()
+        }
+
+    @classmethod
+    def load(cls) -> dict[str, Any]:
+        """Load the config file."""
+        return {cls.VERSION_KEY: cls.get_path().read_text()}
+
+    @classmethod
+    def dump(cls, config: dict[str, Any] | list[Any]) -> None:
+        """Dump the config file."""
+        if not isinstance(config, dict):
+            msg = f"Cannot dump {config} to .python-version file."
+            raise TypeError(msg)
+        cls.get_path().write_text(config[cls.VERSION_KEY])

winipedia_utils-0.4.39/winipedia_utils/projects/poetry/poetry.py

@@ -0,0 +1,129 @@
+"""Project utilities for introspection and manipulation.
+
+This module provides utility functions for working with Python projects
+"""
+
+from collections.abc import Iterable
+from types import ModuleType
+
+from packaging.specifiers import SpecifierSet
+from packaging.version import Version
+
+from winipedia_utils.logging.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+POETRY_ARG = "poetry"
+
+POETRY_RUN_ARGS = [POETRY_ARG, "run"]
+
+RUN_PYTHON_MODULE_ARGS = ["python", "-m"]
+
+
+def get_script_from_args(args: Iterable[str]) -> str:
+    """Get the script from args."""
+    return " ".join(args)
+
+
+def get_run_python_module_args(module: ModuleType) -> list[str]:
+    """Get the args to run a module."""
+    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
+        make_obj_importpath,
+    )
+
+    return [*RUN_PYTHON_MODULE_ARGS, make_obj_importpath(module)]
+
+
+def get_python_module_script(module: ModuleType) -> str:
+    """Get the script to run a module."""
+    return get_script_from_args(get_run_python_module_args(module))
+
+
+def get_poetry_run_module_script(module: ModuleType) -> str:
+    """Get the script to run a module."""
+    return get_script_from_args([*POETRY_RUN_ARGS, *get_run_python_module_args(module)])
+
+
+class VersionConstraint:
+    """Version class."""
+
+    def __init__(self, constraint: str) -> None:
+        """Initialize the version."""
+        self.constraint = constraint
+        self.spec = self.constraint.strip().strip('"').strip("'")
+        self.sset = SpecifierSet(self.spec)
+
+        self.lowers_inclusive = [
+            Version(s.version) for s in self.sset if s.operator == ">="
+        ]
+        self.lowers_exclusive = [
+            Version(s.version) for s in self.sset if s.operator == ">"
+        ]
+        # increment the last number of exclusive, so
+        # >3.4.1 to >=3.4.2; <3.4.0 to <=3.4.1; 3.0.0 to <=3.0.1
+        self.lowers_exclusive_to_inclusive = [
+            Version(f"{v.major}.{v.minor}.{v.micro + 1}") for v in self.lowers_exclusive
+        ]
+        self.lowers_inclusive = (
+            self.lowers_inclusive + self.lowers_exclusive_to_inclusive
+        )
+
+        self.uppers_inclusive = [
+            Version(s.version) for s in self.sset if s.operator == "<="
+        ]
+        self.uppers_exclusive = [
+            Version(s.version) for s in self.sset if s.operator == "<"
+        ]
+
+        # increment the last number of inclusive, so
+        # <=3.4.1 to <3.4.2; >=3.4.0 to >3.4.1; 3.0.0 to >3.0.1
+        self.uppers_inclusive_to_exclusive = [
+            Version(f"{v.major}.{v.minor}.{v.micro + 1}") for v in self.uppers_inclusive
+        ]
+        self.uppers_exclusive = (
+            self.uppers_inclusive_to_exclusive + self.uppers_exclusive
+        )
+
+        self.upper_exclusive = (
+            min(self.uppers_exclusive) if self.uppers_exclusive else None
+        )
+        self.lower_inclusive = (
+            max(self.lowers_inclusive) if self.lowers_inclusive else None
+        )
+
+    def get_lower_inclusive(self, default: str | None = None) -> Version | None:
+        """Get the minimum version.
+
+        Is given inclusive. E.g. >=3.8, <3.12 -> 3.8
+        if >3.7, <3.12 -> 3.7.1
+
+        E.g. >=3.8, <3.12 -> 3.8
+
+        Args:
+            default: The default value to return if there is no minimum version
+
+        Returns:
+            The minimum version
+        """
+        if self.lower_inclusive is None:
+            return Version(default) if default else None
+
+        return self.lower_inclusive
+
+    def get_upper_exclusive(self, default: str | None = None) -> Version | None:
+        """Get the maximum version.
+
+        Is given exclusive. E.g. >=3.8, <3.12 -> 3.12
+        if >=3.8, <=3.12 -> 3.12.1
+
+        Args:
+            default: The default value to return if there is no maximum version
+
+        Returns:
+            The maximum version
+        """
+        if self.upper_exclusive is None:
+            return Version(default) if default else None
+
+        return self.upper_exclusive

winipedia_utils-0.4.39/winipedia_utils/testing/skip.py

@@ -0,0 +1,19 @@
+"""Has utils towards skipping tests."""
+
+import functools
+
+import pytest
+
+from winipedia_utils.git.github.github import running_in_github_action
+
+skip_fixture_test: pytest.MarkDecorator = functools.partial(
+    pytest.mark.skip,
+    reason="Fixtures are not testable bc they cannot be called directly.",
+)()
+
+
+skip_in_github_actions: pytest.MarkDecorator = functools.partial(
+    pytest.mark.skipif,
+    running_in_github_action(),
+    reason="Test cannot run in GitHub action.",
+)()

{winipedia_utils-0.4.34 → winipedia_utils-0.4.39}/winipedia_utils/testing/tests/base/utils/utils.py

@@ -9,7 +9,6 @@ Returns:
 
 """
 
-import os
 from collections.abc import Callable
 from types import ModuleType
 from typing import Any
@@ -26,7 +25,6 @@ from winipedia_utils.testing.convention import (
     make_test_obj_importpath_from_obj,
     make_untested_summary_error_msg,
 )
-from winipedia_utils.text.config import DotEnvConfigFile
 
 logger = get_logger(__name__)
 
@@ -81,24 +79,3 @@ def assert_isabstrct_method(method: Any) -> None:
         is_abstractmethod(method),
         f"Expected {method} to be abstract method",
     )
-
-
-def get_github_repo_token() -> str:
-    """Get the GitHub token."""
-    # try os env first
-    token = os.getenv("REPO_TOKEN")
-    if token:
-        return token
-
-    # try .env next
-    dotenv_path = DotEnvConfigFile.get_path()
-    if not dotenv_path.exists():
-        msg = f"Expected {dotenv_path} to exist"
-        raise ValueError(msg)
-    dotenv = DotEnvConfigFile.load()
-    token = dotenv.get("REPO_TOKEN")
-    if token:
-        return token
-
-    msg = f"Expected REPO_TOKEN in {dotenv_path}"
-    raise ValueError(msg)

winipedia_utils-0.4.34/winipedia_utils/projects/poetry/poetry.py

@@ -1,42 +0,0 @@
-"""Project utilities for introspection and manipulation.
-
-This module provides utility functions for working with Python projects
-"""
-
-from collections.abc import Iterable
-from types import ModuleType
-
-from winipedia_utils.logging.logger import get_logger
-
-logger = get_logger(__name__)
-
-
-POETRY_ARG = "poetry"
-
-POETRY_RUN_ARGS = [POETRY_ARG, "run"]
-
-RUN_PYTHON_MODULE_ARGS = ["python", "-m"]
-
-
-def get_script_from_args(args: Iterable[str]) -> str:
-    """Get the script from args."""
-    return " ".join(args)
-
-
-def get_run_python_module_args(module: ModuleType) -> list[str]:
-    """Get the args to run a module."""
-    from winipedia_utils.modules.module import (  # noqa: PLC0415  # avoid circular import
-        make_obj_importpath,
-    )
-
-    return [*RUN_PYTHON_MODULE_ARGS, make_obj_importpath(module)]
-
-
-def get_python_module_script(module: ModuleType) -> str:
-    """Get the script to run a module."""
-    return get_script_from_args(get_run_python_module_args(module))
-
-
-def get_poetry_run_module_script(module: ModuleType) -> str:
-    """Get the script to run a module."""
-    return get_script_from_args([*POETRY_RUN_ARGS, *get_run_python_module_args(module)])

winipedia_utils-0.4.34/winipedia_utils/testing/skip.py

@@ -1,10 +0,0 @@
-"""Has utils towards skipping tests."""
-
-import functools
-
-import pytest
-
-skip_fixture_test: pytest.MarkDecorator = functools.partial(
-    pytest.mark.skip,
-    reason="Fixtures are not testable bc they cannot be called directly.",
-)()