dycw-utilities 0.155.4__tar.gz → 0.156.0__tar.gz

{dycw_utilities-0.155.4 → dycw_utilities-0.156.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.155.4
+Version: 0.156.0
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.155.4 → dycw_utilities-0.156.0}/pyproject.toml

@@ -144,7 +144,7 @@ psutil = [
   "psutil >=7.0.0, <7.1",
 ]
 pyinstrument = [
-  "pyinstrument >=5.0.3, <5.1",
+  "pyinstrument >=5.1.0, <5.2",
 ]
 pytest = [
   "pytest >=8.4.1, <8.5",
@@ -227,7 +227,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.155.4"
+version = "0.156.0"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -259,7 +259,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.155.4"
+current_version = "0.156.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.155.4 → dycw_utilities-0.156.0}/src/tests/test_click.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import enum
+import pathlib
 from dataclasses import dataclass
 from enum import auto
 from operator import attrgetter
@@ -30,11 +31,7 @@ from utilities.click import (
     Date,
     DateDelta,
     DateTimeDelta,
-    DirPath,
     Enum,
-    ExistingDirPath,
-    ExistingFilePath,
-    FilePath,
     FrozenSetChoices,
     FrozenSetEnums,
     FrozenSetInts,
@@ -46,6 +43,7 @@ from utilities.click import (
     ListInts,
     ListStrs,
     MonthDay,
+    Path,
     PlainDateTime,
     Time,
     TimeDelta,
@@ -57,6 +55,7 @@ from utilities.hypothesis import (
     date_time_deltas,
     dates,
     month_days,
+    paths,
     plain_date_times,
     text_ascii,
     time_deltas,
@@ -68,7 +67,6 @@ from utilities.text import join_strs, strip_and_dedent
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable
-    from pathlib import Path
 
 
 class TestContextSettingsHelpOptionNames:
@@ -81,91 +79,17 @@ class TestContextSettingsHelpOptionNames:
         assert result.exit_code == 0
 
 
-class TestFileAndDirPaths:
-    def test_existing_dir_path(self, *, tmp_path: Path) -> None:
-        @command()
-        @argument("path", type=ExistingDirPath)
-        def cli(*, path: Path) -> None:
-            from pathlib import Path
-
-            assert isinstance(path, Path)
+class TestPath:
+    def test_path(self, *, tmp_path: pathlib.Path) -> None:
+        path_use = pathlib.Path("~", tmp_path)
 
-        result = CliRunner().invoke(cli, [str(tmp_path)])
-        assert result.exit_code == 0
-
-        file_path = tmp_path.joinpath("file.txt")
-        file_path.touch()
-        result = CliRunner().invoke(cli, [str(file_path)])
-        assert result.exit_code == 2
-        assert search("is a file", result.stderr)
-
-        non_existent = tmp_path.joinpath("non-existent")
-        result = CliRunner().invoke(cli, [str(non_existent)])
-        assert result.exit_code == 2
-        assert search("does not exist", result.stderr)
-
-    def test_existing_file_path(self, *, tmp_path: Path) -> None:
         @command()
-        @argument("path", type=ExistingFilePath)
-        def cli(*, path: Path) -> None:
-            from pathlib import Path
-
-            assert isinstance(path, Path)
+        @argument("path", type=Path())
+        def cli(*, path: pathlib.Path) -> None:
+            assert isinstance(path, pathlib.Path)
+            assert path == path.expanduser()
 
-        result = CliRunner().invoke(cli, [str(tmp_path)])
-        assert result.exit_code == 2
-        assert search("is a directory", result.stderr)
-
-        file_path = tmp_path.joinpath("file.txt")
-        file_path.touch()
-        result = CliRunner().invoke(cli, [str(file_path)])
-        assert result.exit_code == 0
-
-        non_existent = tmp_path.joinpath("non-existent")
-        result = CliRunner().invoke(cli, [str(non_existent)])
-        assert result.exit_code == 2
-        assert search("does not exist", result.stderr)
-
-    def test_dir_path(self, *, tmp_path: Path) -> None:
-        @command()
-        @argument("path", type=DirPath)
-        def cli(*, path: Path) -> None:
-            from pathlib import Path
-
-            assert isinstance(path, Path)
-
-        result = CliRunner().invoke(cli, [str(tmp_path)])
-        assert result.exit_code == 0
-
-        file_path = tmp_path.joinpath("file.txt")
-        file_path.touch()
-        result = CliRunner().invoke(cli, [str(file_path)])
-        assert result.exit_code == 2
-        assert search("is a file", result.stderr)
-
-        non_existent = tmp_path.joinpath("non-existent")
-        result = CliRunner().invoke(cli, [str(non_existent)])
-        assert result.exit_code == 0
-
-    def test_file_path(self, *, tmp_path: Path) -> None:
-        @command()
-        @argument("path", type=FilePath)
-        def cli(*, path: Path) -> None:
-            from pathlib import Path
-
-            assert isinstance(path, Path)
-
-        result = CliRunner().invoke(cli, [str(tmp_path)])
-        assert result.exit_code == 2
-        assert search("is a directory", result.stderr)
-
-        file_path = tmp_path.joinpath("file.txt")
-        file_path.touch()
-        result = CliRunner().invoke(cli, [str(file_path)])
-        assert result.exit_code == 0
-
-        non_existent = tmp_path.joinpath("non-existent")
-        result = CliRunner().invoke(cli, [str(non_existent)])
+        result = CliRunner().invoke(cli, [str(path_use)])
         assert result.exit_code == 0
 
 
@@ -301,6 +225,9 @@ class TestParameters:
             serialize=whenever.MonthDay.format_common_iso,
             failable=True,
         ),
+        _Case(
+            param=Path(), name="path", strategy=paths(), serialize=str, failable=False
+        ),
         _Case(
             param=PlainDateTime(),
             name="plain date-time",

{dycw_utilities-0.155.4 → dycw_utilities-0.156.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.155.4"
+__version__ = "0.156.0"

{dycw_utilities-0.155.4 → dycw_utilities-0.156.0}/src/utilities/click.py

@@ -6,7 +6,6 @@ import pathlib
 import uuid
 from typing import TYPE_CHECKING, TypedDict, assert_never, override
 
-import click
 import whenever
 from click import Choice, Context, Parameter, ParamType
 from click.types import IntParamType, StringParamType
@@ -29,6 +28,7 @@ if TYPE_CHECKING:
         IPv6AddressLike,
         MaybeStr,
         MonthDayLike,
+        PathLike,
         PlainDateTimeLike,
         TimeDeltaLike,
         TimeLike,
@@ -37,16 +37,6 @@ if TYPE_CHECKING:
     )
 
 
-FilePath = click.Path(file_okay=True, dir_okay=False, path_type=pathlib.Path)
-DirPath = click.Path(file_okay=False, dir_okay=True, path_type=pathlib.Path)
-ExistingFilePath = click.Path(
-    exists=True, file_okay=True, dir_okay=False, path_type=pathlib.Path
-)
-ExistingDirPath = click.Path(
-    exists=True, file_okay=False, dir_okay=True, path_type=pathlib.Path
-)
-
-
 class _HelpOptionNames(TypedDict):
     help_option_names: Sequence[str]
 
@@ -252,6 +242,32 @@ class MonthDay(ParamType):
                 assert_never(never)
 
 
+class Path(ParamType):
+    """A path-valued parameter."""
+
+    name = "path"
+
+    @override
+    def __repr__(self) -> str:
+        return self.name.upper()
+
+    @override
+    def convert(
+        self, value: PathLike, param: Parameter | None, ctx: Context | None
+    ) -> pathlib.Path:
+        """Convert a value into the `Path` type."""
+        match value:
+            case pathlib.Path():
+                return value.expanduser()
+            case str():
+                try:
+                    return pathlib.Path(value).expanduser()
+                except ValueError as error:
+                    self.fail(str(error), param, ctx)
+            case never:
+                assert_never(never)
+
+
 class PlainDateTime(ParamType):
     """A local-datetime-valued parameter."""
 
@@ -592,11 +608,7 @@ __all__ = [
     "Date",
     "DateDelta",
     "DateTimeDelta",
-    "DirPath",
     "Enum",
-    "ExistingDirPath",
-    "ExistingFilePath",
-    "FilePath",
     "FrozenSetChoices",
     "FrozenSetEnums",
     "FrozenSetParameter",
@@ -609,6 +621,8 @@ __all__ = [
     "ListParameter",
     "ListStrs",
     "MonthDay",
+    "Path",
+    "Path",
     "PlainDateTime",
     "Time",
     "TimeDelta",