winipedia-utils 0.4.33__py3-none-any.whl → 0.4.38__py3-none-any.whl

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/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/git/github/workflows/base/base.py

@@ -7,6 +7,7 @@ from typing import Any
 import winipedia_utils
 from winipedia_utils.modules.module import make_obj_importpath
 from winipedia_utils.modules.package import get_src_package
+from winipedia_utils.projects.poetry.config import PyprojectConfigFile
 from winipedia_utils.text.config import YamlConfigFile
 from winipedia_utils.text.string import split_on_uppercase
 
@@ -149,7 +150,9 @@ class Workflow(YamlConfigFile):
             {
                 "name": "Setup Python",
                 "uses": "actions/setup-python@main",
-                "with": {"python-version": "3.x"},
+                "with": {
+                    "python-version": PyprojectConfigFile.get_latest_possible_python_version()  # noqa: E501
+                },
             }
         )
         steps.append(

winipedia_utils/projects/poetry/config.py

@@ -4,6 +4,7 @@ from pathlib import Path
 from typing import Any, cast
 
 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
 
@@ -130,6 +131,35 @@ class PyprojectConfigFile(TomlConfigFile):
         """Get the main author name."""
         return cls.get_main_author()["name"]
 
+    @classmethod
+    def get_latest_possible_python_version(cls) -> str:
+        """Get the latest possible python version."""
+        constraint = cls.load()["project"]["requires-python"]
+        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):
     """Config file for py.typed."""
@@ -164,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/projects/poetry/poetry.py

@@ -6,6 +6,9 @@ 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__)
@@ -40,3 +43,87 @@ def get_python_module_script(module: ModuleType) -> str:
 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/testing/skip.py

@@ -4,7 +4,16 @@ 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/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.33.dist-info → winipedia_utils-0.4.38.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: winipedia-utils
-Version: 0.4.33
+Version: 0.4.38
 Summary: A package with many utility functions
 License-Expression: MIT
 License-File: LICENSE

{winipedia_utils-0.4.33.dist-info → winipedia_utils-0.4.38.dist-info}/RECORD

@@ -10,12 +10,13 @@ winipedia_utils/data/structures/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9
 winipedia_utils/data/structures/dicts.py,sha256=jsFzQ96cvyHsvPSnsEUhksuWvLSGq6-Rryfw6gEXq-c,274
 winipedia_utils/git/__init__.py,sha256=IRmEVz0sUEw47Eli--57YaypWitxlcYThT_ulwkhNTE,47
 winipedia_utils/git/github/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
+winipedia_utils/git/github/github.py,sha256=xjV7s-ve1s6TJ2GMxm0pqoJkuJ5wECiHwKfhz5DKiUc,813
 winipedia_utils/git/github/repo/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
-winipedia_utils/git/github/repo/protect.py,sha256=_BtYRtGrZPPyR_CuFGkoPugCvuDib4inpnF09Y9NIm0,3164
+winipedia_utils/git/github/repo/protect.py,sha256=nOVjb5GVinGIClp7k9_qqgKnAl_gk1XwkViAQ5TaLTo,3151
 winipedia_utils/git/github/repo/repo.py,sha256=OqoOfqDhe_Iik71dNqi4h3fGrMno33hSjk0bpNg3eZk,7865
 winipedia_utils/git/github/workflows/__init__.py,sha256=BPdntTwFEyBMJ6MyT7gddPHswvRdH9tsRtfK72VSV7Y,57
 winipedia_utils/git/github/workflows/base/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
-winipedia_utils/git/github/workflows/base/base.py,sha256=6QyRPUHaTjHOLcA3Le2qffcMEzjvI0wZMOc9y2MIGr0,9575
+winipedia_utils/git/github/workflows/base/base.py,sha256=t2jYHVpvhCaKpaZI9Yhr8YJEp-2D_G4VUJKVVYIUolc,9749
 winipedia_utils/git/github/workflows/health_check.py,sha256=cPjSJxNy9h0bKNK69crmcERACx4VGR2XytyZ1JM_wMQ,1567
 winipedia_utils/git/github/workflows/publish.py,sha256=TPbSp5QH2vVl55UdqE_kjf1HIkdubcgqWlkLjWFX5EA,1378
 winipedia_utils/git/github/workflows/release.py,sha256=hnMT12J17LmFpPCTzva-lW95MOFDQ-1bAOrTVCxeaR8,1301
@@ -45,8 +46,8 @@ winipedia_utils/os/__init__.py,sha256=cBRq8hWhaWvYeC3cSBYL6Y70kM9COQWHj8vVxxSadI
 winipedia_utils/os/os.py,sha256=K_5FD1sC1h5aSdtqXAG0uq90sSweLYLkgkRPQS0Jfxg,1768
 winipedia_utils/projects/__init__.py,sha256=_iYHzUcTPmutpsExPDcMF9OQDgnz-kTSuWens9iP9bI,52
 winipedia_utils/projects/poetry/__init__.py,sha256=tbvV3wYd3H39hjjlKbF84Irj4hYgv1A7KWyXdCQzFro,59
-winipedia_utils/projects/poetry/config.py,sha256=dei-jinjcwme6oAMO1Wxk7_O7Ac6s0g6PXBglfsTvcw,5296
-winipedia_utils/projects/poetry/poetry.py,sha256=JC-N7NjYCHxUSCGbdpvQltJDabfvTIKLgd62d9XhACo,1174
+winipedia_utils/projects/poetry/config.py,sha256=aqMBG36hWB5XK9Z1484JEFRUsM5HkPgMdJ8EoKtZ3p8,7762
+winipedia_utils/projects/poetry/poetry.py,sha256=CM-MKuYSITRIS95qngtCpDpjQS6tCe6joZOM03yEFdU,4033
 winipedia_utils/projects/project.py,sha256=rirg4xCIOTI6w7cLWufAVHAix7FGicvaCd9OnZQP8dA,521
 winipedia_utils/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 winipedia_utils/resources/__init__.py,sha256=XHsbmjiaGom-KX-S3leCY9cJD3aP9p_0X6xYMcdkHBU,23
@@ -70,7 +71,7 @@ winipedia_utils/testing/config.py,sha256=Xtgu7Nsll6pIzHLUDsalzt-nPBNSNOs0JKCXWi5
 winipedia_utils/testing/convention.py,sha256=7vurpqS--awhN_FLSOviSKENGuFyY9Ejr1NKRm0MPsg,4833
 winipedia_utils/testing/create_tests.py,sha256=KJL23BtsnDsujUa9fwBA5AHo85vy61oxgRPSTztJT7k,9347
 winipedia_utils/testing/fixtures.py,sha256=G8QIrZXndtud0uOk6PY3f8IIDoyX_ronogjeLAYGjrM,1033
-winipedia_utils/testing/skip.py,sha256=5AdF7naPkBi4B1AF6b1plJF3Wmb-BzGBvUORbHZTo8c,236
+winipedia_utils/testing/skip.py,sha256=vAsaIFjxhBhay2ykTqSwjfrJF6Hl2VwT6dQgKxTNRXM,484
 winipedia_utils/testing/tests/__init__.py,sha256=kL-1O6lAO5j4JPOqPdi3dHdbOQ_UXcgPFppj82HhrRU,57
 winipedia_utils/testing/tests/base/__init__.py,sha256=dBH1yfONmqUC49zshS6BJ4ZgEcw7iFGoFCqRmU7Vhrw,62
 winipedia_utils/testing/tests/base/fixtures/__init__.py,sha256=Bs_HSqx8DcMb8yU1vNbgIEszOMNVnIW02C4tmDdHB8E,71
@@ -82,12 +83,12 @@ winipedia_utils/testing/tests/base/fixtures/scopes/module.py,sha256=eWxUP9cFJ0kH
 winipedia_utils/testing/tests/base/fixtures/scopes/package.py,sha256=pR3so6QPymIRM4PJTODrlBKI-yQnZ2P78BsiyTPaF8o,302
 winipedia_utils/testing/tests/base/fixtures/scopes/session.py,sha256=EcBqu3iwT7397wDxFCY-NkiaH7JPVJDdXVUTGXClWJc,6108
 winipedia_utils/testing/tests/base/utils/__init__.py,sha256=mC-8dCkp8xarqkQu2QQLrPjHi6Ww9hcixWdHeQHWeRs,68
-winipedia_utils/testing/tests/base/utils/utils.py,sha256=qN6SiSVPk3Cr-WMsvtSyyULeksocWiGqjEfDRzzcGfA,3194
+winipedia_utils/testing/tests/base/utils/utils.py,sha256=D7N-PW4N8853nJ2m4eYjO3jBMByYB9oh1GK4Hl5Tbwg,2598
 winipedia_utils/testing/tests/conftest.py,sha256=BLgUJtLecOwuEsIyJ__0buqovd5AhiGvbMNk8CHgSQs,888
 winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
 winipedia_utils/text/config.py,sha256=lt5QIXS2cY_aS0emZztcG6nRYwiqFKe0lGEq6msMF5E,7434
 winipedia_utils/text/string.py,sha256=yXmwOab5hXyVQG1NwlWDpy2prj0U7Vb2F5HKLT2Y77Q,3382
-winipedia_utils-0.4.33.dist-info/METADATA,sha256=Js4VMX8o1DB7mTF_pfcyb3sT4dbeUQDI49fo1r-EzZc,13344
-winipedia_utils-0.4.33.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-winipedia_utils-0.4.33.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
-winipedia_utils-0.4.33.dist-info/RECORD,,
+winipedia_utils-0.4.38.dist-info/METADATA,sha256=zZ1EEyURgkEq7w5X_A6zikGQbdc2psG5W7GZZg_WjzU,13344
+winipedia_utils-0.4.38.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+winipedia_utils-0.4.38.dist-info/licenses/LICENSE,sha256=o316mE2gGzd__JT69p7S_zlOmKiHh8YjpImCCcWyTvM,1066
+winipedia_utils-0.4.38.dist-info/RECORD,,