charmlibs-pathops 1.3.0__tar.gz → 1.4.0__tar.gz

{charmlibs_pathops-1.3.0 → charmlibs_pathops-1.4.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: charmlibs-pathops
-Version: 1.3.0
+Version: 1.4.0
 Summary: A pathlib-like interface for Juju K8s charms to interact with files in their workload container.
 Author: The Charm Tech team at Canonical Ltd.
 License-Expression: Apache-2.0
-Project-URL: Documentation, https://documentation.ubuntu.com/charmlibs/reference/charmlibs/pathops/
-Project-URL: Repository, https://github.com/canonical/charmlibs
+Project-URL: Documentation, https://canonical.com/juju/docs/charmlibs/reference/charmlibs/pathops/
+Project-URL: Repository, https://github.com/canonical/charmlibs/tree/main/pathops
 Project-URL: Issues, https://github.com/canonical/charmlibs/issues
 Project-URL: Changelog, https://github.com/canonical/charmlibs/blob/main/pathops/CHANGELOG.md
 Classifier: Programming Language :: Python :: 3

{charmlibs_pathops-1.3.0 → charmlibs_pathops-1.4.0}/pyproject.toml

@@ -29,8 +29,8 @@ integration = [
 ]
 
 [project.urls]
-"Documentation" = "https://documentation.ubuntu.com/charmlibs/reference/charmlibs/pathops/"
-"Repository" = "https://github.com/canonical/charmlibs"
+"Documentation" = "https://canonical.com/juju/docs/charmlibs/reference/charmlibs/pathops/"
+"Repository" = "https://github.com/canonical/charmlibs/tree/main/pathops"
 "Issues" = "https://github.com/canonical/charmlibs/issues"
 "Changelog" = "https://github.com/canonical/charmlibs/blob/main/pathops/CHANGELOG.md"
 

{charmlibs_pathops-1.3.0 → charmlibs_pathops-1.4.0}/src/charmlibs/pathops/_container_path.py

@@ -17,6 +17,7 @@
 from __future__ import annotations
 
 import errno
+import os
 import pathlib
 import re
 import typing
@@ -27,7 +28,6 @@ from ops import pebble
 from . import _constants, _errors, _fileinfo
 
 if typing.TYPE_CHECKING:
-    import os
     from collections.abc import Generator
     from typing import Literal, TypeGuard
 
@@ -151,14 +151,37 @@ class ContainerPath:
         """
         return self._path.is_absolute()
 
-    def match(self, path_pattern: str) -> bool:
+    def is_relative_to(self, other: str | os.PathLike[str], /) -> bool:
+        """Return whether this path is relative to the ``other`` path.
+
+        Only the path is matched against, the container is not considered.
+        """
+        return self._path.is_relative_to(other)
+
+    def match(self, path_pattern: str | os.PathLike[str]) -> bool:
         """Return whether this path matches the given pattern.
 
         If the pattern is relative, matching is done from the right; otherwise, the entire path is
         matched. The recursive wildcard ``'**'`` is **not** supported by this method. Matching is
         always case-sensitive. Only the path is matched against, the container is not considered.
+
+        Args:
+            path_pattern: A :class:`str` or :class:`os.PathLike` object.
+
+        .. warning::
+            :class:`ContainerPath` is not :class:`os.PathLike`. A :class:`ContainerPath` instance
+            is not a valid value for ``path_pattern``, and will result in a :class:`TypeError`.
         """
-        return self._path.match(path_pattern)
+        # Python 3.14's pathlib.PurePath.match accepts any object with `with_segments`, which
+        # would silently allow a ContainerPath through. Reject it explicitly to match the
+        # behaviour of joinpath / __truediv__ and stay consistent across Python versions.
+        if isinstance(path_pattern, ContainerPath):
+            raise TypeError(
+                f'ContainerPath is not a valid pattern for ContainerPath.match: {path_pattern!r}'
+            )
+        # Python <3.12 requires path_pattern to be a string. Python 3.12+ accepts any path-like.
+        # When the library requires Python 3.12+, we can drop the os.fspath call and this comment.
+        return self._path.match(os.fspath(path_pattern))
 
     def with_name(self, name: str) -> Self:
         """Return a new ContainerPath, with the same container, but with the path name replaced.
@@ -174,6 +197,20 @@ class ContainerPath:
         """
         return self.with_segments(self._path.with_name(name))
 
+    def with_stem(self, stem: str) -> Self:
+        """Return a new ContainerPath, with the same container, but with the path stem replaced.
+
+        The stem is the path name minus its last suffix.
+
+        ::
+
+            container = self.unit.get_container('c')
+            path = ContainerPath('/', 'foo', 'bar.txt', container=container)
+            repr(path.with_stem('baz'))
+            # ContainerPath('/foo/baz.txt', container=<ops.Container 'c'>)"
+        """
+        return self.with_segments(self._path.with_stem(stem))
+
     def with_suffix(self, suffix: str) -> Self:
         """Return a new ContainerPath with the same container and the suffix changed.
 

{charmlibs_pathops-1.3.0 → charmlibs_pathops-1.4.0}/src/charmlibs/pathops/_types.py

@@ -116,6 +116,11 @@ class PathProtocol(typing.Protocol):
         ...
 
     # NOTE: Not supported -- (Python 3.12) ``case_sensitive`` keyword argument
+    # NOTE: Not supported -- (Python 3.12) path-like ``path_pattern``
+    # ContainerPath.match accepts str | os.PathLike[str], but the protocol stays narrow.
+    # Widening it here would oblige us to shim LocalPath.match too, and we can't write that
+    # override without also handling the case_sensitive keyword, which pathlib.Path.match
+    # doesn't have before 3.12.
     def match(self, path_pattern: str) -> bool:
         """Return whether this path matches the given pattern.
 
@@ -132,6 +137,13 @@ class PathProtocol(typing.Protocol):
         """
         ...
 
+    def with_stem(self, stem: str) -> Self:
+        """Return a new instance of the same type, with the path stem replaced.
+
+        The stem is the path name minus its last suffix.
+        """
+        ...
+
     def with_suffix(self, suffix: str) -> Self:
         """Return a new instance of the same type, with the path suffix replaced.
 
@@ -594,14 +606,12 @@ class PathProtocol(typing.Protocol):
 # ContainerPath to ease compatibility with pathlib.Path on 3.12+ if we someday
 # support relative paths
 
-# def is_relative_to(self, other: _StrPath) -> Self: ...  # 3.9+
-# not part of protocol but can be provided on ContainerPath implementation
-# to ease compatibility with pathlib.Path on 3.9+
-
-# def with_stem(self, stem: str) -> Self: ...  # 3.9+
-# not part of protocol but can be provided on ContainerPath implementation
-# to ease compatibility with pathlib.Path on 3.9+
-# could be added to the protocol if we're happy for LocalPath to double as backports
+# def is_relative_to(self, other: _StrPath, /) -> bool: ...  # 3.9+
+# provided on ContainerPath to ease compatibility with pathlib.Path on 3.9+,
+# but deliberately not part of the protocol: pathlib's signature is `*other` until
+# 3.12, so the protocol would have to declare `other` as positional-only for LocalPath
+# to satisfy it, and the 3.12 `walk_up` keyword can't be offered until the minimum
+# supported Python is 3.12
 
 # def with_segments(self, *pathsegments: _StrPath) -> Self: ...
 # required for 3.12+ subclassing machinery

charmlibs_pathops-1.4.0/src/charmlibs/pathops/_version.txt

@@ -0,0 +1 @@
+1.4.0

{charmlibs_pathops-1.3.0 → charmlibs_pathops-1.4.0}/src/charmlibs_pathops.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: charmlibs-pathops
-Version: 1.3.0
+Version: 1.4.0
 Summary: A pathlib-like interface for Juju K8s charms to interact with files in their workload container.
 Author: The Charm Tech team at Canonical Ltd.
 License-Expression: Apache-2.0
-Project-URL: Documentation, https://documentation.ubuntu.com/charmlibs/reference/charmlibs/pathops/
-Project-URL: Repository, https://github.com/canonical/charmlibs
+Project-URL: Documentation, https://canonical.com/juju/docs/charmlibs/reference/charmlibs/pathops/
+Project-URL: Repository, https://github.com/canonical/charmlibs/tree/main/pathops
 Project-URL: Issues, https://github.com/canonical/charmlibs/issues
 Project-URL: Changelog, https://github.com/canonical/charmlibs/blob/main/pathops/CHANGELOG.md
 Classifier: Programming Language :: Python :: 3

charmlibs_pathops-1.3.0/src/charmlibs/pathops/_version.txt

@@ -1 +0,0 @@
-1.3.0