[UPD] Version 9.0.0 update to use 'docker compose' V2, included library python-on-whales to get some Config information from compose.yml files.

Author: mbcosta

docky/__init__.py

@@ -3,4 +3,5 @@
 from . import cmd
 from . import common
 from .main import Docky
-from . import dcpatched
+# TODO: Check the command 'docky open'
+# from . import dcpatched

docky/cmd/base.py

@@ -13,7 +13,7 @@
 
 class Docky(cli.Application):
     PROGNAME = "docky"
-    VERSION = "8.0.0"
+    VERSION = "9.0.0"
     SUBCOMMAND_HELPMSG = None
 
     def _run(self, cmd, retcode=FG):
@@ -44,7 +44,7 @@ def _run(self, *args, **kwargs):
 
     def _init_project(self):
         self.project = Project()
-        self.compose = local["docker-compose"]
+        self.compose = local["docker"]["compose"]
 
     def main(self, *args, **kwargs):
         if self._project_specific:

docky/cmd/kill.py

@@ -3,7 +3,6 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 from .base import Docky, DockySub
-from compose.parallel import parallel_kill
 
 
 @Docky.subcommand("kill")
@@ -13,5 +12,4 @@ class DockyKill(DockySub):
     def _main(self, *args):
         # docker compose do not kill the container odoo as is was run
         # manually, so we implement our own kill
-        containers = self.project.get_containers()
-        parallel_kill(containers, {"signal": "SIGKILL"})
+        self._run(self.compose["kill", "-s", "SIGKILL"])

docky/cmd/run_open.py

@@ -57,9 +57,17 @@ def _main(self, *optionnal_command_line):
         self._run(self.compose["rm", "-f"])
         self.project.display_service_tooltip()
         self.project.create_volume()
-        self._exec("docker-compose", [
-            "run", "--rm", "--service-ports", "--use-aliases", "-e", "NOGOSU=True",
-            self.service] + self.cmd)
+        # Default command
+        docky_cmd = ["run", "--rm", "--use-aliases", "-e", "NOGOSU=True", self.service] + self.cmd
+
+        self._exec("docker", ["compose"] + docky_cmd)
+
+        # TODO: Should we use python-on-whales commands?
+        #  Its possible make
+        # docker.compose.run(self.project.name, and other parameters)
+        # But until now was not possible make the same command as above,
+        # if its possible we should consider the option to use it.
+        # https://gabrieldemarmiesse.github.io/python-on-whales/sub-commands/compose/
 
 
 @Docky.subcommand("open")

docky/common/project.py

@@ -2,10 +2,7 @@
 # @author Sébastien BEAU <[email protected]>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
-import docker
-from compose.project import OneOffFilter
-from compose.cli import command
-from compose.config.errors import ComposeFileNotFound
+from python_on_whales import docker
 from plumbum import local
 
 from .api import logger
@@ -15,42 +12,44 @@ class Project(object):
 
     def __init__(self):
         try:
-            self.project = command.project_from_options(".", {})
-        except ComposeFileNotFound:
+            self.project = docker.compose.config(return_json=True)
+        except:
             print("No docker-compose found, create one with :")
             print("$ docky init")
             exit(-1)
 
-        self.name = self.project.name
-        self.loaded_config = None
+        self.name = self.project.get("name")
+        self.loaded_config = self.project
         self.service = self._get_main_service(self.project)
 
     def _get_main_service(self, project):
         """main_service has docky.main.service defined in
         his label."""
-        for service in project.services:
-            labels = service.options.get("labels", {})
+        for service in project.get("services"):
+            labels = project["services"][service].get("labels")
             # service.labels() do not contain docky.main.service
             # see also compose.service.merge_labels
-            if labels.get("docky.main.service", False):
-                return service.name
+            if labels:
+                if labels.get("docky.main.service"):
+                    return service
 
     def get_containers(self, service=None):
-        kwargs = {"one_off": OneOffFilter.include}
+        kwargs = {}
         if service:
-            kwargs["service_names"] = [service]
-        return self.project.containers(**kwargs)
+            kwargs["services"] = [service]
+        return docker.compose.ps(**kwargs)
 
     def display_service_tooltip(self):
         infos = self._get_services_info()
-        for service in self.project.services:
-            labels = service.options.get("labels", {})
+        for service in self.project.get("services"):
+            dict_service = self.project["services"].get(service)
+            labels = dict_service.get("labels", {})
             if labels.get("docky.access.help"):
                 # TODO remove after some versions
                 logger.warning(
                     "'docky.access.help' is replaced by 'docky.help'. "
                     "Please update this key in your docker files.")
-            if infos.get(service.name):
+            if infos.get(dict_service.get("name")):
                 # some applications provide extra parameters to access resource
                 infos[service.name] += labels.get("docky.url_suffix", "")
                 logger.info(infos[service.name])
@@ -60,28 +59,27 @@ def display_service_tooltip(self):
     def _get_services_info(self):
         """ Search IP and Port for each services
         """
-        client = docker.from_env()
-        services = (x for x in client.containers.list()
-                    if self.project.name in x.attrs["Name"])
         infos = {}
-        for serv in services:
+        main_service = self._get_main_service(self.project)
+        for service in self.project.get("services"):
+            if service != main_service:
+                continue
+            serv = self.project["services"][service]
             proj_key = [
-                x for x in serv.attrs["NetworkSettings"]["Networks"].keys()
-                if self.project.name in x]
+                x for x in serv["networks"].keys()]
             proj_key = proj_key and proj_key[0] or False
-            if not serv.attrs["NetworkSettings"]["Networks"].get(proj_key):
+            if not serv["networks"]:
                 continue
-            ip = serv.attrs["NetworkSettings"]["Networks"][proj_key].get(
-                "IPAddress", "")
+            ip = serv["networks"].get("IPAdress", "")
             info = {
-                "name": serv.attrs["Config"]["Labels"].get(
+                "name": serv["labels"].get(
                     "com.docker.compose.service", ""),
                 "ip": ip,
-                "port": [x for x in serv.attrs["NetworkSettings"].get("Ports", "")]
+                "port": [x for x in serv.get("ports", "")],
             }
             if info["name"] != "db" and info.get("port"):
                 urls = ["http://%s:%s" % (info["ip"], port.replace("/tcp", ""))
-                        for port in info["port"]]
+                        for port in info["port"][0]]
                 # There is no web app to access 'db' service: try adminer for that
                 infos[info["name"]] = "%s %s" % (info["name"], " ".join(urls))
         return infos
@@ -92,9 +90,10 @@ def create_volume(self):
         Only apply to external volumes.
         docker-compose up do not attemps to create it
         so we have to do it ourselves"""
-        for service in self.project.services:
-            for volume in service.options.get("volumes", []):
-                if volume.external:
+        for service in self.project.get("services"):
+            dict_service = self.project["services"].get(service)
+            for volume in dict_service.get("volumes", []):
+                if volume.get("external"):
                     path = local.path(local.env.expand(volume.external))
                     if not path.exists():
                         logger.info(
@@ -103,7 +102,6 @@ def create_volume(self):
                         path.mkdir()
 
     def get_user(self, service_name):
-        service = self.project.get_service(name=service_name)
-        labels = service.options.get("labels")
+        labels = self.project["services"].get(service_name).get("labels")
         if labels:
-            return labels.get("docky.user", None)
+            return labels.get("docky.user")

requirements.txt

@@ -1,9 +1,7 @@
-docker-compose>=1.23.1
+python-on-whales
 plumbum
 rainbow_logging_handler
 python-slugify
-# Only for solving installation issue with pip that fail to
-# solve the version of request compatible with docker and docker-compose
-requests<3,>=2.20.0
-importlib-metadata; python_version >= '3.10'
-PyYAML >= 5.1, < 5.4
+requests
+importlib-metadata
+PyYAML >= 6.0.1