charmlibs-pathops 1.0.1.post0__tar.gz → 1.2.0__tar.gz

{charmlibs_pathops-1.0.1.post0 → charmlibs_pathops-1.2.0}/PKG-INFO

@@ -1,16 +1,18 @@
 Metadata-Version: 2.4
 Name: charmlibs-pathops
-Version: 1.0.1.post0
+Version: 1.2.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.
-Project-URL: Repository, https://github.com/canonical/charmtech-charmlibs
-Project-URL: Issues, https://github.com/canonical/charmtech-charmlibs/issues
+Project-URL: Documentation, https://documentation.ubuntu.com/charmlibs
+Project-URL: Repository, https://github.com/canonical/charmlibs
+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
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: ops<4,>=2.19
 

{charmlibs_pathops-1.0.1.post0 → charmlibs_pathops-1.2.0}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "charmlibs-pathops"
 description = "A pathlib-like interface for Juju K8s charms to interact with files in their workload container."
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 authors = [
     {name="The Charm Tech team at Canonical Ltd."},
 ]
@@ -18,9 +18,21 @@ dependencies = [
     "ops>=2.19,<4",
 ]
 
+[dependency-groups]
+lint = [
+    "typing_extensions",
+]
+unit = []
+functional = []
+integration = [
+    "jubilant",
+]
+
 [project.urls]
-"Repository" = "https://github.com/canonical/charmtech-charmlibs"
-"Issues" = "https://github.com/canonical/charmtech-charmlibs/issues"
+"Documentation" = "https://documentation.ubuntu.com/charmlibs"
+"Repository" = "https://github.com/canonical/charmlibs"
+"Issues" = "https://github.com/canonical/charmlibs/issues"
+"Changelog" = "https://github.com/canonical/charmlibs/blob/main/pathops/CHANGELOG.md"
 
 [build-system]
 requires = [
@@ -33,9 +45,16 @@ version = {file = ["src/charmlibs/pathops/_version.txt"]}
 
 [tool.ruff]
 extend = "../pyproject.toml"
-src = ["src", "tests/unit", "tests/integration/pebble"]  # correctly sort local imports in tests
+src = ["src", "tests/unit", "tests/functional", "tests/integration"]  # correctly sort local imports in tests
 
 [tool.pyright]
 extend = "../pyproject.toml"
 include = ["src", "tests"]
-pythonVersion = "3.8"  # check no python > 3.8 features are used
+pythonVersion = "3.10"
+
+[tool.charmlibs.functional]
+pebble = ["v1.1.1","master"]
+ubuntu = ["22.04", "latest"]
+
+[tool.charmlibs.integration]
+tags = ["22.04", "24.04"]

{charmlibs_pathops-1.0.1.post0 → charmlibs_pathops-1.2.0}/src/charmlibs/pathops/__init__.py

@@ -21,7 +21,8 @@ The ``pathops`` charm library provides:
 - :class:`ContainerPath`: the concrete implementation of the interface for remote paths in the
   workload container of Kubernetes charms. Operations are implemented using the Pebble file API.
 - :class:`LocalPath`: the concrete implementation of the interface for local paths, which includes
-  both machine charms and the charm container of Kubernetes charms.
+  both machine charms and the charm container of Kubernetes charms. Inherits from
+  :class:`pathlib.PosixPath` and extends the signature of some methods.
 - Top-level helper functions such as :func:`ensure_contents`, which operate on both container
   and local paths.
 

{charmlibs_pathops-1.0.1.post0 → charmlibs_pathops-1.2.0}/src/charmlibs/pathops/_container_path.py

@@ -28,9 +28,10 @@ from . import _constants, _errors, _fileinfo
 
 if typing.TYPE_CHECKING:
     import os
-    from typing import Generator, Literal
+    from collections.abc import Generator
+    from typing import Literal, TypeGuard
 
-    from typing_extensions import Self, TypeGuard
+    from typing_extensions import Self
 
 
 class RelativePathError(ValueError):
@@ -514,16 +515,21 @@ class ContainerPath:
             _errors.raise_not_a_directory(repr(self))
         self._remove_path()
 
-    def unlink(self) -> None:
+    def unlink(self, missing_ok: bool = False) -> None:
         """Remove this path if it is not a directory.
 
         Raises:
-            FileNotFoundError: if the path does not exist.
+            FileNotFoundError: if the path does not exist and ``missing_ok`` is false.
             IsADirectoryError: if the path exists but is a directory.
             PermissionError: if the Pebble user does not have permissions for the operation.
             PebbleConnectionError: if the remote Pebble client cannot be reached.
         """
-        info = _fileinfo.from_container_path(self, follow_symlinks=False)
+        try:
+            info = _fileinfo.from_container_path(self, follow_symlinks=False)
+        except FileNotFoundError:
+            if missing_ok:
+                return
+            raise
         if info.type == pebble.FileType.DIRECTORY:
             _errors.raise_is_a_directory(repr(self))
         self._remove_path()

{charmlibs_pathops-1.0.1.post0 → charmlibs_pathops-1.2.0}/src/charmlibs/pathops/_types.py

@@ -22,7 +22,7 @@ from . import _constants
 
 if typing.TYPE_CHECKING:
     import os
-    from typing import Generator, Sequence
+    from collections.abc import Generator, Sequence
 
     from typing_extensions import Self
 
@@ -50,6 +50,19 @@ class PathProtocol(typing.Protocol):
     not the case, then equality is ``False`` and other comparisons are :class:`NotImplemented`.
 
     Protocol implementers are hashable.
+
+    .. warning::
+        User implementations of ``PathProtocol`` are not covered by this package's semantic
+        versioning promise.
+
+        The semantic versioning of this package reflects the runtime use of :class:`ContainerPath`
+        and :class:`LocalPath`. ``PathProtocol`` is always updated to reflect the latest changes to
+        :class:`ContainerPath` and :class:`LocalPath`.
+
+        ``PathProtocol`` will always be a valid type annotation for :class:`ContainerPath`,
+        :class:`LocalPath`, and :class:`pathlib.PosixPath` objects. However, user implementations
+        of ``PathProtocol`` may experience type checking breakage on minor version bumps of this
+        package.
     """
 
     #############################
@@ -367,11 +380,11 @@ class PathProtocol(typing.Protocol):
         """
         ...
 
-    def unlink(self) -> None:
+    def unlink(self, missing_ok: bool = False) -> None:
         """Remove this path if it is not a directory.
 
         Raises:
-            FileNotFoundError: if the path does not exist.
+            FileNotFoundError: if the path does not exist and ``missing_ok`` is false.
             IsADirectoryError: if the path exists but is a directory.
             PermissionError: if the local or remote user does not have the appropriate permissions.
             PebbleConnectionError: if the remote Pebble client cannot be reached.

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

@@ -0,0 +1 @@
+1.2.0

{charmlibs_pathops-1.0.1.post0 → charmlibs_pathops-1.2.0}/src/charmlibs_pathops.egg-info/PKG-INFO

@@ -1,16 +1,18 @@
 Metadata-Version: 2.4
 Name: charmlibs-pathops
-Version: 1.0.1.post0
+Version: 1.2.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.
-Project-URL: Repository, https://github.com/canonical/charmtech-charmlibs
-Project-URL: Issues, https://github.com/canonical/charmtech-charmlibs/issues
+Project-URL: Documentation, https://documentation.ubuntu.com/charmlibs
+Project-URL: Repository, https://github.com/canonical/charmlibs
+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
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: ops<4,>=2.19
 

charmlibs_pathops-1.0.1.post0/src/charmlibs/pathops/_version.txt

@@ -1 +0,0 @@
-1.0.1.post0