docker-composer 2.17.4__tar.gz → 5.0.2__tar.gz

docker_composer-5.0.2/.gitignore

@@ -0,0 +1,255 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,kate
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,kate
+
+### Kate ###
+# Swap Files #
+.*.kate-swp
+.swp.*
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+.idea/**
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+.out/**
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+**__pycache__
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+pythonenv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# profiling data
+.prof
+
+# End of https://www.toptal.com/developers/gitignore/api/python,pycharm,kate

{docker_composer-2.17.4 → docker_composer-5.0.2}/PKG-INFO

@@ -1,27 +1,21 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: docker-composer
-Version: 2.17.4
+Version: 5.0.2
 Summary: Use docker-compose (V2) 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.9,<4.0
+Project-URL: Homepage, https://github.com/schollm/docker-composer
+Project-URL: Repository, https://github.com/schollm/docker-composer
+Author-email: Micha <schollm-git@gmx.com>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
 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.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)
-Requires-Dist: loguru (>=0.5.3)
-Project-URL: Repository, https://github.com/schollm/docker-composer
+Requires-Python: <4.0,>=3.9
 Description-Content-Type: text/markdown
 
 # Docker Composer
@@ -30,6 +24,8 @@ All commands and parameters are exposed as python classes and attributes
 to allow for full auto-completion of its parameters with IDEs
 that support it.
 
+**Runtime footprint:** This library is **stdlib-only** (zero third-party runtime dependencies).
+
 
 ## Install
 ```shell script
@@ -70,14 +66,24 @@ print(process.stdout.encode("UTF-8"))
 
 ## Develop
 
-### Coding Standards
+### Development Setup
 
-| **Type**       | Package  | Comment                         |
-| -------------- | -------- | ------------------------------- |
-| **Linter**     | `black`  | Also for auto-formatted modules |
-| **Logging**    | `loguru` |                                 |
-| **Packaging**  | `poetry` |                                 |
-| **Tests**      | `pytest` |                                 |
-| **Typing**     | `mypy`   | Type all methods                |
-| **Imports**    | `isort`  |                                 |
+When developing, the `_utils` module is available for generating the docker_composer
+module from the `docker compose`CLI help output.
+This is not required for normal package usage.
+
+```bash
+uv sync --group dev
+uv run poe generate
+```
+
+### Coding Standards
 
+| **Type**       | Package   | Comment                         |
+| -------------- |-----------| ------------------------------- |
+| **Linter**     | `ruff`    | Also for auto-formatted modules |
+| **Logging**    | `logging` |                                 |
+| **Packaging**  | `uv`      |                                 |
+| **Tests**      | `pytest`  |                                 |
+| **Typing**     | `mypy`    | Type all methods                |
+| **Imports**    | `ruff`    |                                 |

{docker_composer-2.17.4 → docker_composer-5.0.2}/README.md

@@ -4,6 +4,8 @@ All commands and parameters are exposed as python classes and attributes
 to allow for full auto-completion of its parameters with IDEs
 that support it.
 
+**Runtime footprint:** This library is **stdlib-only** (zero third-party runtime dependencies).
+
 
 ## Install
 ```shell script
@@ -44,13 +46,24 @@ print(process.stdout.encode("UTF-8"))
 
 ## Develop
 
+### Development Setup
+
+When developing, the `_utils` module is available for generating the docker_composer
+module from the `docker compose`CLI help output.
+This is not required for normal package usage.
+
+```bash
+uv sync --group dev
+uv run poe generate
+```
+
 ### Coding Standards
 
-| **Type**       | Package  | Comment                         |
-| -------------- | -------- | ------------------------------- |
-| **Linter**     | `black`  | Also for auto-formatted modules |
-| **Logging**    | `loguru` |                                 |
-| **Packaging**  | `poetry` |                                 |
-| **Tests**      | `pytest` |                                 |
-| **Typing**     | `mypy`   | Type all methods                |
-| **Imports**    | `isort`  |                                 |
+| **Type**       | Package   | Comment                         |
+| -------------- |-----------| ------------------------------- |
+| **Linter**     | `ruff`    | Also for auto-formatted modules |
+| **Logging**    | `logging` |                                 |
+| **Packaging**  | `uv`      |                                 |
+| **Tests**      | `pytest`  |                                 |
+| **Typing**     | `mypy`    | Type all methods                |
+| **Imports**    | `ruff`    |                                 |

docker_composer-5.0.2/pyproject.toml

@@ -0,0 +1,71 @@
+[project]
+name = "docker-composer"
+version = "5.0.2"
+description = "Use docker-compose (V2) from within Python"
+authors = [{ name = "Micha", email = "schollm-git@gmx.com" }]
+requires-python = ">=3.9,<4.0"
+readme = "README.md"
+license = "Apache-2.0"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/schollm/docker-composer"
+Repository = "https://github.com/schollm/docker-composer"
+
+[dependency-groups]
+dev = [
+    "black>=25.1.0",
+    "isort>=6.0.1",
+    "poethepoet>=0.30.0",
+    "pytest>=6.1.2",
+    "pytest-cov>=6.1.1",
+    "ruff>=0.11.10",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/docker_composer"]
+
+[tool.hatch.build.targets.wheel]
+include = ["src/docker_composer"]
+exclude = ["src/docker_composer/_utils"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/docker_composer" = "docker_composer"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+addopts = """
+  --junit-xml=.out/junit-pytest.xml
+  --cov=src/docker_composer
+  --cov-report=xml:.out/coverage.xml
+  --cov-report=html:.out/coverage-html
+  --cov-report term-missing:skip-covered
+  --cov-branch
+  --doctest-modules
+"""
+
+[tool.poe.tasks]
+ruff-check = { cmd = "uv run ruff check" }
+ruff-format-check = { cmd = "uv run ruff format --check" }
+pytest =  { cmd = "uv run pytest" }
+format = { cmd = "uv run ruff format" }
+build = { cmd = "uv build" }
+publish-dist = { cmd = "uv publish" }
+generate-code = { cmd = "uv run python -m docker_composer._utils.generate_class" }
+sync-version = { cmd = "uv run python -m docker_composer._utils.sync_version" }
+publish = { sequence = ["build", "publish-dist"] }
+test = { sequence = ["ruff-check", "ruff-format-check", "pytest $POE_EXTRA_ARGS"] }
+generate = { sequence = ["generate-code", "sync-version"] }

docker_composer-5.0.2/src/docker_composer/__init__.py

@@ -0,0 +1,6 @@
+try:
+    from docker_composer.runner.root import DockerComposeRoot as DockerCompose
+except ImportError:
+    pass
+
+__all__ = ["DockerCompose"]

{docker_composer-2.17.4 → docker_composer-5.0.2}/src/docker_composer/_utils/argument.py

@@ -1,8 +1,12 @@
-from typing import Any, Iterable, Iterator, List, Optional, Tuple, Type
+"""Helper modules to parse docker compoose --help arguments"""
 
-import attr
-from loguru import logger
+from __future__ import annotations
+from typing import Iterable, Iterator
 
+import logging
+from dataclasses import dataclass
+
+logger = logging.getLogger(__name__)
 OPTION = "OPTION"
 
 _TYPE_CONVERSIONS = {
@@ -16,7 +20,6 @@ _TYPE_CONVERSIONS = {
     "LEVEL": int,
     "MEM": int,
     "NAME": str,
-    OPTION: bool,
     "PATH": str,
     "SERVICE": str,
     "SIGNAL": int,
@@ -24,28 +27,34 @@ _TYPE_CONVERSIONS = {
     "TIMEOUT": int,
     "TLS_KEY_PATH": str,
     "USER": str,
-    "type": str,
-    "string": str,
+    "bytes": int,
+    "docker": bool,
+    "filter": str,
     "int": int,
     "list": list,
+    "scale": int,
     "str": str,
+    "string": str,
     "stringArray": list[str],
+    "type": str,
     "volumes": list[str],
-    "docker": bool,
+    OPTION: bool,
 }
 
 
-@attr.s(auto_attribs=True, frozen=True)
+@dataclass(frozen=True)
 class Argument:
     arg: str
     type_desc: str
-    type: Type
+    type_: type
     description: str
     default: str = ""
 
     @property
     def type_str(self) -> str:
-        return "Any" if self.type == object else self.type.__name__
+        if self.type_ is object:
+            raise ValueError(self.type_)
+        return self.type_.__name__
 
     @property
     def is_option(self) -> bool:
@@ -55,20 +64,7 @@ class Argument:
     def from_line(line: str) -> "Argument":
         if "  " in line:
             return _from_line_has_sep(line)
-
-        words = iter(line.split())
-        has_more = True
-        while has_more:
-            arg, default_str, has_more = _parse_arg(next(words))
-        type_desc = next(words)
-        type_from_default = _get_type_name_from_default(default_str)
-        desc = " ".join(words)
-        if type_desc[1:].islower() and "=" not in type_desc:
-            desc = f"{type_desc} {desc}"
-            type_desc = type_from_default
-
-        type_ = _get_type(type_from_default if default_str else type_desc)
-        return Argument(arg, type_desc, type_, desc, default_str)
+        raise ValueError(line)
 
 
 def _collect_arguments(arguments: Iterable[str]) -> Iterator[str]:
@@ -83,7 +79,7 @@ def _collect_arguments(arguments: Iterable[str]) -> Iterator[str]:
         yield res.strip()
 
 
-def parse_dc_argument(lines: List[str]) -> List[Argument]:
+def parse_dc_argument(lines: list[str]) -> list[Argument]:
     """
     Parse arguments from lines of docker-compose specifications
     :param lines: Lines of the Options sections from `docker-compose --help`.
@@ -93,18 +89,18 @@ def parse_dc_argument(lines: List[str]) -> List[Argument]:
     return [Argument.from_line(line) for line in iter_lines if "--version" not in line]
 
 
-def _get_type(type_name) -> Type:
+def _get_type(type_name) -> type:
     res = _TYPE_CONVERSIONS.get(type_name, None)
     if res is None:
         if "=" in type_name:
             res = dict
         else:
-            logger.warning("Unknown type {}, use str", type_name)
+            logger.warning("Unknown type %s, use str", type_name)
             res = str
     return res
 
 
-def _parse_arg(arg: str) -> Tuple[str, str, bool]:
+def _parse_arg(arg: str) -> tuple[str, str, bool]:
     while arg.startswith("-"):
         arg = arg[1:]
     # if argument ends with a comma, it is followed by an alias. (usually -f, --foo)
@@ -130,11 +126,7 @@ def _get_type_name_from_default(default: str) -> str:
     elif default == "proto":
         return "str"
     else:
-        try:
-            return eval(default).__class__.__name__
-        except NameError:
-            logger.warning("Could not get type for value '{}'", default)
-            return "str"
+        raise NotImplementedError(default)
 
 
 def _from_line_has_sep(line) -> "Argument":
@@ -145,17 +137,18 @@ def _from_line_has_sep(line) -> "Argument":
     :param line: a single line with the description separated from the definition by at least two blanks
     :return: Argument
     """
-    desc_idx = line[4:].index("  ")
-    desc = line[desc_idx + 2 + 4 :].strip()
-    args = iter(line[: desc_idx + 4].split())
+    min_arg_chars = 2  #  Simple argument with single dash (e.g. -x)
+    min_full_chars = 4  # Named argument with double-dash (e.g. --xy)
+    desc_idx = line[min_arg_chars:].index("  ")
+    # Help output can wrap differently depending on terminal width.
+    # Normalize all whitespace so wrapped descriptions are stable.
+    desc = line[desc_idx + min_full_chars :].strip()
+    args = iter(line[: desc_idx + min_full_chars].split())
     arg, default, has_more = "", "", True
     while has_more:
         arg, default, has_more = _parse_arg(next(args))
     type_from_default = _get_type_name_from_default(default)
-    try:
-        type_desc = next(args)
-    except StopIteration:
-        type_desc = type_from_default
+    type_desc = next(args, type_from_default)
 
     type_ = _get_type(type_from_default if default else type_desc)
     return Argument(arg, type_desc, type_, desc, default=default)