docker-composer 0.8.4__tar.gz → 2.17.2__tar.gz

{docker-composer-0.8.4 → docker_composer-2.17.2}/PKG-INFO

@@ -1,26 +1,26 @@
 Metadata-Version: 2.1
 Name: docker-composer
-Version: 0.8.4
+Version: 2.17.2
 Summary: Use docker-compose from within Python
 Home-page: https://github.com/schollm/docker-composer
 License: Apache-2.0
 Author: Micha
 Author-email: schollm-git@gmx.com
-Requires-Python: >=3.6,<4.0
-Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Requires-Dist: attrs (>=20.3.0,<21.0.0)
-Requires-Dist: loguru (>=0.5.3,<0.6.0)
+Requires-Dist: attrs (>=20.3.0)
+Requires-Dist: loguru (>=0.5.3)
 Project-URL: Repository, https://github.com/schollm/docker-composer
 Description-Content-Type: text/markdown
 

{docker-composer-0.8.4 → docker_composer-2.17.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docker-composer"
-version = "0.8.4"
+version = "2.17.2"
 description = "Use docker-compose from within Python"
 authors = ["Micha <schollm-git@gmx.com>"]
 readme = "README.md"
@@ -18,19 +18,20 @@ classifiers = [
   "Topic :: Software Development :: Build Tools",
   "Topic :: Software Development :: Libraries :: Application Frameworks",
   "Operating System :: OS Independent",
-  "Development Status :: 4 - Beta"
+  "Development Status :: 5 - Production/Stable"
 ]
 
 
 [tool.poetry.dependencies]
-python = "^3.6"
-attrs = "^20.3.0"
-loguru = "^0.5.3"
+python = ">=3.9,<4.0"
+attrs = ">=20.3.0"
+loguru = ">=0.5.3"
 
 [tool.poetry.dev-dependencies]
-pytest = "^6.1.2"
-black = "^20.8b1"
-isort = "^5.6.4"
+flake8 = "^6.0.0"
+pytest = ">=6.1.2"
+black = ">=20.8b1"
+isort = ">=5.6.4"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/_utils/argument.py

@@ -29,6 +29,9 @@ _TYPE_CONVERSIONS = {
     "int": int,
     "list": list,
     "str": str,
+    "stringArray": list[str],
+    "volumes": list[str],
+    "docker": bool,
 }
 
 
@@ -72,7 +75,7 @@ def _collect_arguments(arguments: Iterable[str]) -> Iterator[str]:
     """Combine argument lines to obtain one line per argument"""
     res = ""
     for arg in arguments:
-        if res and arg[:6].strip().startswith("-"):
+        if res and arg[:12].strip().startswith("-"):
             yield res.strip()
             res = ""
         res += f"\n   {arg.strip()}"

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/_utils/generate_class.py

@@ -1,10 +1,9 @@
-import os
 import subprocess
 from collections import defaultdict
 from functools import lru_cache, reduce
 from operator import add
 from pathlib import Path
-from typing import Iterable, Iterator, List, Mapping, Optional, Set, Tuple, Union
+from typing import Iterable, Iterator, List, Mapping, Set, Tuple, Union
 
 import black
 import isort
@@ -38,8 +37,11 @@ def get_help_message(subcommand: str = "") -> str:
     args = [arg for arg in ["docker-compose", subcommand, "--help"] if arg]
     process = subprocess.run(args, capture_output=True, text=True)
     if process.returncode:
-        logger.error(process.returncode)
+        logger.error(
+            "docker-compose {} --help exited with {}:", subcommand, process.returncode
+        )
         logger.error(process.stderr)
+
     return process.stdout
 
 
@@ -51,7 +53,9 @@ def collect_help_lines(msg: str) -> Mapping[str, List[str]]:
     parts: Mapping[str, List[str]] = defaultdict(list)
     part = "general"
     for line in msg.split("\n"):
-        if line and line[0] != " " and line.endswith(":") and " " not in line:
+        if not line:
+            part = "general"
+        elif " " not in line and line.endswith(":"):
             part = line[:-1].lower()
         else:
             parts[part].append(line)
@@ -181,7 +185,9 @@ class {class_name}(DockerBaseRunner):
         level=level,
     )
     try:
-        res = isort.code(res, config=isort.Config(settings_path=project_root()))
+        res = isort.code(
+            res, config=isort.Config(settings_path=project_root().as_posix())
+        )
     except ISortError as exc:
         logger.exception(exc)
     try:
@@ -191,7 +197,7 @@ class {class_name}(DockerBaseRunner):
         return res
 
 
-def write_class(cmd: str, file_name: Optional[str] = None) -> None:
+def write_class(cmd: str) -> None:
     """
     Generate a class for `cmd` and write it to `file_name`
 
@@ -199,18 +205,15 @@ def write_class(cmd: str, file_name: Optional[str] = None) -> None:
     :param file_name: Name of output file (empty/None for auto-generation)
     :return:
     """
-    if not file_name:
-        file_name = os.path.join(
-            os.path.dirname(__file__),
-            "..",
-            "runner",
-            "cmd" if cmd else "",
-            f"{cmd or 'root'}.py",
-        )
+    base_path = Path(__file__).parents[1] / "runner"
+    if cmd:
+        file_name = base_path / "cmd" / f"{cmd}.py"
+    else:
+        file_name = base_path / "root.py"
+
     class_str = generate_class(f"DockerCompose{(cmd or 'root').capitalize()}", cmd)
-    logger.info("Write {:<8s} -> {}", cmd or "root", file_name)
-    with open(file_name, "w") as f:
-        f.write(class_str)
+    logger.info("Write {:<8s} -> {}", cmd, file_name)
+    file_name.write_text(class_str, encoding="utf-8")
 
 
 def main() -> None:

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/base.py

@@ -56,7 +56,6 @@ class DockerBaseRunner:
         stdin=None,
         stdout=None,
         stderr=None,
-        capture_output=False,
         **kwargs,
     ) -> subprocess.CompletedProcess:
         """Call docker-compose with the generated command
@@ -76,7 +75,6 @@ class DockerBaseRunner:
             stdin=stdin,
             stdout=stdout,
             stderr=stderr,
-            capture_output=capture_output,
             **kwargs,
         )
         logger.debug("Returned from {}: {}", cmd[0], p.returncode)

docker_composer-2.17.2/src/docker_composer/runner/cmd/build.py

@@ -0,0 +1,38 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeBuild(DockerBaseRunner):
+    """
+    Usage:  docker compose build [OPTIONS] [SERVICE...]
+    Build or rebuild services
+    """
+
+    build_arg: Optional[list] = None
+    """Set build-time variables for services."""
+    no_cache: Optional[bool] = None
+    """Do not use cache when building the image"""
+    progress: Optional[str] = None
+    """Set type of progress output (auto, tty, plain, quiet) (default "auto")"""
+    pull: Optional[bool] = None
+    """Always attempt to pull a newer version of the image."""
+    push: Optional[bool] = None
+    """Push service images."""
+    quiet: Optional[bool] = None
+    """Don't print anything to STDOUT"""
+    ssh: Optional[str] = None
+    """Set SSH authentications used when building service images. (use 'default' for using your default SSH Agent)"""
+    _cmd: str = "build"
+    _options: List[str] = [
+        "no_cache",
+        "pull",
+        "push",
+        "quiet",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/config.py

@@ -0,0 +1,53 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeConfig(DockerBaseRunner):
+    """
+    Usage:  docker compose config [OPTIONS] [SERVICE...]
+    Parse, resolve and render compose file in canonical format
+    """
+
+    format: Optional[str] = None
+    """Format the output. Values: [yaml | json] (default "yaml")"""
+    hash: Optional[str] = None
+    """Print the service config hash, one per line."""
+    images: Optional[bool] = None
+    """Print the image names, one per line."""
+    no_consistency: Optional[bool] = None
+    """Don't check model consistency - warning: may produce invalid Compose output"""
+    no_interpolate: Optional[bool] = None
+    """Don't interpolate environment variables."""
+    no_normalize: Optional[bool] = None
+    """Don't normalize compose model."""
+    output: Optional[str] = None
+    """Save to file (default to stdout)"""
+    profiles: Optional[bool] = None
+    """Print the profile names, one per line."""
+    quiet: Optional[bool] = None
+    """Only validate the configuration, don't print anything."""
+    resolve_image_digests: Optional[bool] = None
+    """Pin image tags to digests."""
+    services: Optional[bool] = None
+    """Print the service names, one per line."""
+    volumes: Optional[bool] = None
+    """Print the volume names, one per line."""
+    _cmd: str = "config"
+    _options: List[str] = [
+        "images",
+        "no_consistency",
+        "no_interpolate",
+        "no_normalize",
+        "profiles",
+        "quiet",
+        "resolve_image_digests",
+        "services",
+        "volumes",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/cp.py

@@ -0,0 +1,29 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeCp(DockerBaseRunner):
+    """
+    Usage:  docker compose cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-
+        docker compose cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH
+    Copy files/folders between a service container and the local filesystem
+    """
+
+    archive: Optional[bool] = None
+    """Archive mode (copy all uid/gid information)"""
+    follow_link: Optional[bool] = None
+    """Always follow symbol link in SRC_PATH"""
+    index: Optional[int] = None
+    """Index of the container if there are multiple instances of a service ."""
+    _cmd: str = "cp"
+    _options: List[str] = [
+        "archive",
+        "follow_link",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/create.py

@@ -0,0 +1,39 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeCreate(DockerBaseRunner):
+    """
+    Usage:  docker compose create [OPTIONS] [SERVICE...]
+    Creates containers for a service.
+    """
+
+    build: Optional[bool] = None
+    """Build images before starting containers."""
+    force_recreate: Optional[bool] = None
+    """Recreate containers even if their configuration and image haven't changed."""
+    no_build: Optional[bool] = None
+    """Don't build an image, even if it's missing."""
+    no_recreate: Optional[bool] = None
+    """If containers already exist, don't recreate them. Incompatible with --force-recreate."""
+    pull: Optional[str] = None
+    """Pull image before running ("always"|"missing"|"never") (default "missing")"""
+    remove_orphans: Optional[bool] = None
+    """Remove containers for services not defined in the Compose file."""
+    scale: Optional[str] = None
+    """Scale SERVICE to NUM instances. Overrides the scale setting in the Compose file if present."""
+    _cmd: str = "create"
+    _options: List[str] = [
+        "build",
+        "force_recreate",
+        "no_build",
+        "no_recreate",
+        "remove_orphans",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/down.py

@@ -0,0 +1,29 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeDown(DockerBaseRunner):
+    """
+    Usage:  docker compose down [OPTIONS]
+    Stop and remove containers, networks
+    """
+
+    remove_orphans: Optional[bool] = None
+    """Remove containers for services not defined in the Compose file."""
+    rmi: Optional[str] = None
+    """Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")"""
+    timeout: Optional[int] = None
+    """Specify a shutdown timeout in seconds (default 10)"""
+    volumes: Optional[list] = None
+    """Remove named volumes declared in the volumes section of the Compose file and anonymous volumes attached to containers."""
+    _cmd: str = "down"
+    _options: List[str] = [
+        "remove_orphans",
+    ]

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/runner/cmd/events.py

@@ -1,5 +1,5 @@
-# DO NOT EDIT: Autogenerated by src/docker_composer/_utils/generate_class.py
-# for docker-compose version 1.25.0, build unknown
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
 
 from typing import List, Optional
 
@@ -11,10 +11,8 @@ from docker_composer.base import DockerBaseRunner
 @attr.s(auto_attribs=True)
 class DockerComposeEvents(DockerBaseRunner):
     """
+    Usage:  docker compose events [OPTIONS] [SERVICE...]
     Receive real time events from containers.
-
-    Usage: events [options] [SERVICE...]
-
     """
 
     json: Optional[bool] = None

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/runner/cmd/exec.py

@@ -1,5 +1,5 @@
-# DO NOT EDIT: Autogenerated by src/docker_composer/_utils/generate_class.py
-# for docker-compose version 1.25.0, build unknown
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
 
 from typing import List, Optional
 
@@ -11,31 +11,26 @@ from docker_composer.base import DockerBaseRunner
 @attr.s(auto_attribs=True)
 class DockerComposeExec(DockerBaseRunner):
     """
-    Execute a command in a running container
-
-    Usage: exec [options] [-e KEY=VAL...] SERVICE COMMAND [ARGS...]
-
+    Usage:  docker compose exec [OPTIONS] SERVICE COMMAND [ARGS...]
+    Execute a command in a running container.
     """
 
     detach: Optional[bool] = None
     """Detached mode: Run command in the background."""
+    env: Optional[list] = None
+    """Set environment variables"""
+    index: Optional[int] = None
+    """index of the container if there are multiple instances of a service [default: 1]. (default 1)"""
+    no_TTY: Optional[bool] = None
+    """Disable pseudo-TTY allocation. By default docker compose exec allocates a TTY. (default true)"""
     privileged: Optional[bool] = None
     """Give extended privileges to the process."""
     user: Optional[str] = None
     """Run the command as this user."""
-    T: Optional[bool] = None
-    """Disable pseudo-tty allocation. By default `docker-compose exec`
-       allocates a TTY."""
-    index: Optional[int] = None
-    """index of the container if there are multiple
-       instances of a service [default: 1]"""
-    env: Optional[dict] = None
-    """not supported in API < 1.25)"""
     workdir: Optional[str] = None
     """Path to workdir directory for this command."""
     _cmd: str = "exec"
     _options: List[str] = [
         "detach",
         "privileged",
-        "T",
     ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/images.py

@@ -0,0 +1,25 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeImages(DockerBaseRunner):
+    """
+    Usage:  docker compose images [OPTIONS] [SERVICE...]
+    List images used by the created containers
+    """
+
+    format: Optional[str] = None
+    """Format the output. Values: [table | json]. (default "table")"""
+    quiet: Optional[bool] = None
+    """Only display IDs"""
+    _cmd: str = "images"
+    _options: List[str] = [
+        "quiet",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/kill.py

@@ -0,0 +1,25 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeKill(DockerBaseRunner):
+    """
+    Usage:  docker compose kill [OPTIONS] [SERVICE...]
+    Force stop service containers.
+    """
+
+    remove_orphans: Optional[bool] = None
+    """Remove containers for services not defined in the Compose file."""
+    signal: Optional[str] = None
+    """SIGNAL to send to the container. (default "SIGKILL")"""
+    _cmd: str = "kill"
+    _options: List[str] = [
+        "remove_orphans",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/logs.py

@@ -0,0 +1,38 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeLogs(DockerBaseRunner):
+    """
+    Usage:  docker compose logs [OPTIONS] [SERVICE...]
+    View output from containers
+    """
+
+    follow: Optional[bool] = None
+    """Follow log output."""
+    no_color: Optional[bool] = None
+    """Produce monochrome output."""
+    no_log_prefix: Optional[bool] = None
+    """Don't print prefix in logs."""
+    since: Optional[str] = None
+    """Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"""
+    tail: Optional[str] = None
+    """Number of lines to show from the end of the logs for each container. (default "all")"""
+    timestamps: Optional[bool] = None
+    """Show timestamps."""
+    until: Optional[str] = None
+    """Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"""
+    _cmd: str = "logs"
+    _options: List[str] = [
+        "follow",
+        "no_color",
+        "no_log_prefix",
+        "timestamps",
+    ]

docker_composer-2.17.2/src/docker_composer/runner/cmd/ls.py

@@ -0,0 +1,30 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposeLs(DockerBaseRunner):
+    """
+    Usage:  docker compose ls [OPTIONS]
+    List running compose projects
+    """
+
+    all: Optional[bool] = None
+    """Show all stopped Compose projects"""
+    filter: Optional[str] = None
+    """Filter output based on conditions provided."""
+    format: Optional[str] = None
+    """Format the output. Values: [table | json]. (default "table")"""
+    quiet: Optional[bool] = None
+    """Only display IDs."""
+    _cmd: str = "ls"
+    _options: List[str] = [
+        "all",
+        "quiet",
+    ]

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/runner/cmd/pause.py

@@ -1,5 +1,5 @@
-# DO NOT EDIT: Autogenerated by src/docker_composer/_utils/generate_class.py
-# for docker-compose version 1.25.0, build unknown
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
 
 from typing import List, Optional
 
@@ -11,10 +11,8 @@ from docker_composer.base import DockerBaseRunner
 @attr.s(auto_attribs=True)
 class DockerComposePause(DockerBaseRunner):
     """
-    Pause services.
-
-    Usage: pause [SERVICE...]
-
+    Usage:  docker compose pause [SERVICE...]
+    Pause services
     """
 
     _cmd: str = "pause"

{docker-composer-0.8.4 → docker_composer-2.17.2}/src/docker_composer/runner/cmd/port.py

@@ -1,5 +1,5 @@
-# DO NOT EDIT: Autogenerated by src/docker_composer/_utils/generate_class.py
-# for docker-compose version 1.25.0, build unknown
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
 
 from typing import List, Optional
 
@@ -11,16 +11,13 @@ from docker_composer.base import DockerBaseRunner
 @attr.s(auto_attribs=True)
 class DockerComposePort(DockerBaseRunner):
     """
+    Usage:  docker compose port [OPTIONS] SERVICE PRIVATE_PORT
     Print the public port for a port binding.
-
-    Usage: port [options] SERVICE PRIVATE_PORT
-
     """
 
-    protocol: Optional[str] = None
-    """tcp or udp [default: tcp]"""
     index: Optional[int] = None
-    """index of the container if there are multiple
-       instances of a service [default: 1]"""
+    """index of the container if service has multiple replicas (default 1)"""
+    protocol: Optional[str] = None
+    """tcp or udp (default "tcp")"""
     _cmd: str = "port"
     _options: List[str] = []

docker_composer-2.17.2/src/docker_composer/runner/cmd/ps.py

@@ -0,0 +1,35 @@
+# DO NOT EDIT: Autogenerated by /Users/micha/dev/external/docker-composer/src/docker_composer/_utils/generate_class.py
+# for Docker Compose version v2.17.2
+
+from typing import List, Optional
+
+import attr
+
+from docker_composer.base import DockerBaseRunner
+
+
+@attr.s(auto_attribs=True)
+class DockerComposePs(DockerBaseRunner):
+    """
+    Usage:  docker compose ps [OPTIONS] [SERVICE...]
+    List containers
+    """
+
+    all: Optional[bool] = None
+    """Show all stopped containers (including those created by the run command)"""
+    filter: Optional[str] = None
+    """Filter services by a property (supported filters: status)."""
+    format: Optional[str] = None
+    """Format the output. Values: [table | json] (default "table")"""
+    quiet: Optional[bool] = None
+    """Only display IDs"""
+    services: Optional[bool] = None
+    """Display services"""
+    status: Optional[list] = None
+    """Filter services by status. Values: [paused | restarting | removing | running | dead | created | exited]"""
+    _cmd: str = "ps"
+    _options: List[str] = [
+        "all",
+        "quiet",
+        "services",
+    ]