added __all__ to submodules

CHANGELOG.rst

@@ -1,3 +1,9 @@
+v0.6.2 (XXXX-XX-XX)
+-------------------
+
+* added `__all__` to all submodules to improve discoverability
+
+
 v0.6.1 (2024-05-23)
 --------------------
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dockerblade"
-version = "0.6.1"
+version = "0.6.2"
 description = "Interact with Docker containers via Python-like APIs"
 authors = ["Chris Timperley <[email protected]>"]
 license = "Apache-2.0"

src/dockerblade/__init__.py

@@ -1,3 +1,14 @@
+__all__ = (
+    "CalledProcessError",
+    "CompletedProcess",
+    "Container",
+    "DockerDaemon",
+    "FileSystem",
+    "Shell",
+    "Stopwatch",
+    "exceptions",
+)
+
 from loguru import logger as _logger
 
 from . import exceptions

src/dockerblade/daemon.py

@@ -1,14 +1,19 @@
+from __future__ import annotations
+
 __all__ = ("DockerDaemon",)
 
-from collections.abc import Mapping
-from types import TracebackType
-from typing import Any
+import typing as t
 
 import attr
 import docker
 from loguru import logger
 
-from .container import Container
+from dockerblade.container import Container
+
+if t.TYPE_CHECKING:
+    from collections.abc import Mapping
+    from types import TracebackType
+
 
 
 @attr.s(frozen=True)
@@ -27,7 +32,7 @@ def __attrs_post_init__(self) -> None:
         object.__setattr__(self, "api", api)
         logger.debug(f"created daemon connection: {self}")
 
-    def __enter__(self) -> "DockerDaemon":
+    def __enter__(self) -> t.Self:
         return self
 
     def __exit__(self,
@@ -51,18 +56,19 @@ def attach(self, id_or_name: str) -> Container:
         logger.debug(f"attached to container [{container}]")
         return container
 
-    def provision(self,
-                  image: str,
-                  command: str | None = None,
-                  *,
-                  entrypoint: str | None = None,
-                  environment: Mapping[str, str] | None = None,
-                  network_mode: str = "bridge",
-                  name: str | None = None,
-                  ports: Mapping[int, int] | None = None,
-                  user: str | None = None,
-                  volumes: Mapping[str, Any] | None = None,
-                  ) -> Container:
+    def provision(
+        self,
+        image: str,
+        command: str | None = None,
+        *,
+        entrypoint: str | None = None,
+        environment: Mapping[str, str] | None = None,
+        network_mode: str = "bridge",
+        name: str | None = None,
+        ports: Mapping[int, int] | None = None,
+        user: str | None = None,
+        volumes: Mapping[str, t.Any] | None = None,
+    ) -> Container:
         """Creates a Docker container from a given image.
 
         Arguments:

src/dockerblade/exceptions.py

@@ -1,5 +1,21 @@
+from __future__ import annotations
+
+__all__ = (
+    "DockerBladeException",
+    "UnexpectedError",
+    "EnvNotFoundError",
+    "CopyFailed",
+    "IsADirectoryError",
+    "DirectoryNotEmpty",
+    "IsNotADirectoryError",
+    "HostFileNotFound",
+    "ContainerFileNotFound",
+    "ContainerFileAlreadyExists",
+    "CalledProcessError",
+    "TimeoutExpired",
+)
+
 import subprocess as _subprocess
-import typing as _t
 
 import attr as _attr
 
@@ -12,7 +28,7 @@ class DockerBladeException(Exception):
 class UnexpectedError(DockerBladeException):
     """An unexpected error occurred during an operation."""
     description: str
-    error: _t.Optional["CalledProcessError"] = _attr.ib(default=None)
+    error: CalledProcessError | None = _attr.ib(default=None)
 
     def __str__(self) -> str:
         msg = f"An unexpected error occurred: {self.description}"

src/dockerblade/files.py

@@ -1,24 +1,27 @@
+from __future__ import annotations
+
 __all__ = ("FileSystem",)
 
 import contextlib
 import os
 import subprocess
 import tempfile
 import typing
-from collections.abc import Iterator
 from pathlib import Path
 from subprocess import DEVNULL
 from typing import Literal, overload
 
 import attr
 from loguru import logger
 
-from . import exceptions as exc
-from .util import quote_container, quote_host
+import dockerblade.exceptions as exc
+from dockerblade.util import quote_container, quote_host
 
 if typing.TYPE_CHECKING:
-    from .container import Container
-    from .shell import Shell
+    from collections.abc import Iterator
+
+    from dockerblade.container import Container
+    from dockerblade.shell import Shell
 
 _ON_WINDOWS = os.name == "nt"
 
@@ -36,8 +39,8 @@ class FileSystem:
     container: Container
         The container to which this filesystem belongs.
     """
-    container: "Container" = attr.ib()
-    _shell: "Shell" = attr.ib(repr=False, eq=False, hash=False)
+    container: Container = attr.ib()
+    _shell: Shell = attr.ib(repr=False, eq=False, hash=False)
 
     def copy_from_host(self, path_host: str, path_container: str) -> None:
         """Copies a given file or directory tree from the host to the container.

src/dockerblade/shell.py

@@ -1,4 +1,10 @@
-__all__ = ("Shell", "CompletedProcess", "CalledProcessError")
+from __future__ import annotations
+
+__all__ = (
+    "CalledProcessError",
+    "CompletedProcess",
+    "Shell",
+)
 
 import typing as t
 from pathlib import Path
@@ -77,7 +83,7 @@ class Shell:
     ContainerFileNotFound
         If a given source file is not found.
     """
-    container: "Container" = attr.ib()
+    container: Container = attr.ib()
     path: str = attr.ib()
     _sources: t.Sequence[str] = attr.ib(factory=tuple)
     _environment: t.Mapping[str, str] = attr.ib(factory=dict)

src/dockerblade/stopwatch.py

@@ -1,11 +1,16 @@
+from __future__ import annotations
+
 __all__ = ("Stopwatch",)
 
+import typing as t
 import warnings
 from timeit import default_timer as timer
-from types import TracebackType
 
 import attr
 
+if t.TYPE_CHECKING:
+    from types import TracebackType
+
 
 @attr.s(slots=True, repr=False, str=False, eq=False, hash=False)
 class Stopwatch:
@@ -22,15 +27,16 @@ class Stopwatch:
     _paused: bool = attr.ib(default=True)
     _time_start: float = attr.ib(default=0.0)
 
-    def __enter__(self) -> "Stopwatch":
+    def __enter__(self) -> t.Self:
         self.start()
         return self
 
-    def __exit__(self,
-                 ex_type: type[BaseException] | None,
-                 ex_val: BaseException | None,
-                 ex_tb: TracebackType | None,
-                 ) -> None:
+    def __exit__(
+        self,
+        ex_type: type[BaseException] | None,
+        ex_val: BaseException | None,
+        ex_tb: TracebackType | None,
+    ) -> None:
         self.stop()
 
     def __repr__(self) -> str:

src/dockerblade/version.py

@@ -1 +1,2 @@
+__all__ = ("__version__",)
 __version__ = "0.6.1"