poetry-plugin-hook 0.0.0__tar.gz

poetry_plugin_hook-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Christoph Dörrer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

poetry_plugin_hook-0.0.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.1
+Name: poetry-plugin-hook
+Version: 0.0.0
+Summary: poetry plugin to register new command to check if all dependencies are up-to-date
+Author: Christoph Dörrer
+Author-email: d-chris@web.de
+Requires-Python: >=3.9,<4.0
+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.12
+Requires-Dist: cleo (>=2.1.0,<3.0.0)
+Requires-Dist: poetry (>=1.8.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+# poetry-plugin-latest
+
+poetry plugin to add a command to check if all dependencies are up-to-date
+
+```cmd
+$ poetry latest --help
+
+Description:
+  Check if all top-level dependencies are up-to-date
+
+Usage:
+  latest [options] [--] [<package>]
+
+Arguments:
+  package                    The package to inspect
+
+Options:
+      --without=WITHOUT      The dependency groups to ignore. (multiple values allowed)
+      --with=WITH            The optional dependency groups to include. (multiple values allowed)
+      --only=ONLY            The only dependency groups to include. (multiple values allowed)
+  -l, --latest               Show the latest version. (option is always True)
+  -o, --outdated             Show the latest version but only for packages that are outdated. (option is always True)
+  -T, --top-level            Show only top-level dependencies. (option is always True)
+  -h, --help                 Display help for the given command. When no command is given display help for the list command.
+  -q, --quiet                Do not output any message.
+  -V, --version              Display this application version.
+      --ansi                 Force ANSI output.
+      --no-ansi              Disable ANSI output.
+  -n, --no-interaction       Do not ask any interactive question.
+      --no-plugins           Disables plugins.
+      --no-cache             Disables Poetry source caches.
+  -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory).
+  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
+
+Help:
+  The show command displays detailed information about a package, or
+  lists all packages available.
+```
+

poetry_plugin_hook-0.0.0/README.md

@@ -0,0 +1,38 @@
+# poetry-plugin-latest
+
+poetry plugin to add a command to check if all dependencies are up-to-date
+
+```cmd
+$ poetry latest --help
+
+Description:
+  Check if all top-level dependencies are up-to-date
+
+Usage:
+  latest [options] [--] [<package>]
+
+Arguments:
+  package                    The package to inspect
+
+Options:
+      --without=WITHOUT      The dependency groups to ignore. (multiple values allowed)
+      --with=WITH            The optional dependency groups to include. (multiple values allowed)
+      --only=ONLY            The only dependency groups to include. (multiple values allowed)
+  -l, --latest               Show the latest version. (option is always True)
+  -o, --outdated             Show the latest version but only for packages that are outdated. (option is always True)
+  -T, --top-level            Show only top-level dependencies. (option is always True)
+  -h, --help                 Display help for the given command. When no command is given display help for the list command.
+  -q, --quiet                Do not output any message.
+  -V, --version              Display this application version.
+      --ansi                 Force ANSI output.
+      --no-ansi              Disable ANSI output.
+  -n, --no-interaction       Do not ask any interactive question.
+      --no-plugins           Disables plugins.
+      --no-cache             Disables Poetry source caches.
+  -C, --directory=DIRECTORY  The working directory for the Poetry command (defaults to the current working directory).
+  -v|vv|vvv, --verbose       Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
+
+Help:
+  The show command displays detailed information about a package, or
+  lists all packages available.
+```

poetry_plugin_hook-0.0.0/poetry_plugin_hook/__init__.py

@@ -0,0 +1,17 @@
+from poetry.plugins.application_plugin import ApplicationPlugin
+
+from .latest import LatestCommand
+from .sync import SyncCommand
+
+
+class HookPlugin(ApplicationPlugin):
+    def activate(self, application):
+
+        application.command_loader.register_factory(
+            LatestCommand.name,
+            lambda: LatestCommand(),
+        )
+        application.command_loader.register_factory(
+            SyncCommand.name,
+            lambda: SyncCommand(),
+        )

poetry_plugin_hook-0.0.0/poetry_plugin_hook/latest.py

@@ -0,0 +1,72 @@
+import re
+
+from poetry.console.commands.show import ShowCommand
+
+from .redirect import buffered_io, strip_ansi
+
+
+class LatestCommand(ShowCommand):
+    name = "hook latest"
+    description = "Check if all top-level dependencies are up-to-date."
+    help = ""
+
+    _dependencies = re.compile(
+        r"^(?P<package>\w\S+)\s+"
+        r"(?P<current>\d\S+)\s+"
+        r"(?P<latest>\d\S+)\s+"
+        r"(?P<description>\w.*?)$",
+        re.MULTILINE,
+    )
+
+    _true_options = ["latest", "outdated", "top-level"]
+    _del_options = ["no-dev", "tree", "all", "why"]
+
+    def configure(self) -> None:
+        """
+        Modifiy all options from `poetry show` to fit the `poetry latest` command.
+
+        Returns:
+            None
+        """
+
+        self.options = [
+            option for option in self.options if option.name not in self._del_options
+        ]
+
+        for opt in filter(lambda o: o.name in self._true_options, self.options):
+            opt._description += " <warning>(option is always True)</warning>"
+
+        super().configure()
+
+    def handle(self) -> int:
+        """
+        Executes `poetry show -o -T` to check for outdated dependencies.
+
+        Catches stdout to check for dependencies and returns non-zero.
+
+        Returns:
+            int: Non-zero if there are outdated dependencies, zero otherwise.
+        """
+
+        # force options to True, `poetry show -o -T`
+        for option in self._true_options:
+            self.io.input.set_option(option, True)
+
+        # redirect output to check for outdated dependencies
+        with buffered_io(self) as io:
+            super().handle()
+            text = io.fetch_output()
+
+        # count outdated dependencies
+        outdated = len(
+            self._dependencies.findall(
+                strip_ansi(text),
+            )
+        )
+
+        if outdated == 0:
+            self.line("All top-level dependencies are up-to-date.")
+        else:
+            self.line(text)
+
+        return outdated

poetry_plugin_hook-0.0.0/poetry_plugin_hook/redirect.py

@@ -0,0 +1,82 @@
+import contextlib
+import re
+from abc import ABC, abstractmethod
+from typing import Generator, List
+
+from cleo.io.buffered_io import BufferedIO
+from cleo.io.io import IO
+
+
+class CommandCleo(ABC):
+    @property
+    @abstractmethod
+    def _io(self) -> IO:
+        pass
+
+
+def strip_ansi(text: str) -> str:
+    """
+    Remove ANSI escape sequences from a string.
+
+    Args:
+        text (str): The string to remove ANSI escape sequences from.
+
+    Returns:
+        str: The string without ANSI escape sequences.
+    """
+    return re.sub(r"\x1B[@-_][0-?]*[ -/]*[@-~]", "", text)
+
+
+@contextlib.contextmanager
+def buffered_io(
+    *args: CommandCleo,
+    **kwargs,
+) -> Generator[BufferedIO, None, None]:
+    """
+    Context manager that temporarily replaces the I/O of multiple Poetry commands with
+    the same buffered I/O to capture their output.
+
+    Args:
+        *cmds (List[CommandCleo]): The Poetry commands whose I/O will be captured.
+        **kwargs: Additional keyword arguments to pass to the BufferedIO constructor.
+
+    Yields:
+        BufferedIO: The buffered I/O object.
+
+    Raises:
+        ValueError: If any of the commands does not have an I/O attribute.
+
+    Example:
+        ```python
+        with buffered_ios(cmd1, cmd2, decorated=False) as io:
+            # Perform operations with the buffered I/O
+            output = io.fetch_output()
+        ```
+    """
+
+    # perform check if all commands have a `_io` attribute
+    original: List[IO] = []
+
+    for cmd in args:
+        if not hasattr(cmd, "_io"):
+            raise ValueError(f"Command {cmd} does not have an I/O attribute.")
+
+        original.append(cmd._io)
+
+    # create a new buffered I/O object
+    io = BufferedIO(
+        input=kwargs.pop("input", original[0].input),
+        decorated=kwargs.pop("decorated", original[0].output.is_decorated()),
+        **kwargs,
+    )
+
+    try:
+        # assign the buffered I/O object to all commands
+        for cmd in args:
+            cmd._io = io
+
+        yield io
+    finally:
+        # restore the original I/O objects
+        for cmd, original_io in zip(args, original):
+            cmd._io = original_io

poetry_plugin_hook-0.0.0/poetry_plugin_hook/sync.py

@@ -0,0 +1,90 @@
+import re
+
+from cleo.exceptions import CleoError
+from cleo.helpers import option
+from poetry.console.commands.install import InstallCommand
+
+from .redirect import buffered_io, strip_ansi
+
+
+class SyncCommand(InstallCommand):
+    name = "hook sync"
+    description = "Install the current project and synchronize the environment."
+    help = ""
+
+    _true_options = ["sync"]
+    _del_options = ["no-dev", "remove-untracked", "compile"]
+    _exit_codes = ["any", "installs", "updates", "removals"]
+
+    _operations = re.compile(
+        r"^Package operations: "
+        r"(?P<installs>\d+)\D+"
+        r"(?P<updates>\d+)\D+"
+        r"(?P<removals>\d+)\D+"
+        r"(?P<skipped>\d+)\D+$",
+        re.MULTILINE,
+    )
+
+    def configure(self) -> None:
+
+        self.options = [
+            option(
+                "exit",
+                description=(
+                    "Specify the value to return as exitcode. "
+                    f"<info>choices={str(self._exit_codes)}</info>"
+                ),
+                flag=False,
+                default="any",
+            )
+        ] + [option for option in self.options if option.name not in self._del_options]
+
+        for opt in filter(lambda o: o.name in self._true_options, self.options):
+            opt._description += " <warning>(option is always True)</warning>"
+
+        super().configure()
+
+    def handle(self) -> int:
+
+        # check if the exit option is valid
+        exit = self.io.input.option("exit")
+        if exit not in self._exit_codes:
+            raise CleoError(f"Invalid option: {exit=}")
+
+        # force options to `poetry install --sync`
+        for opt in self._true_options:
+            self.io.input.set_option(opt, True)
+
+        with buffered_io(
+            self.installer.executor,
+            self.installer,
+            self,
+        ) as io:
+            super().handle()
+            stdout = io.fetch_output()
+
+        # parse the output for matching lines and take the last one
+        match: re.Match = list(
+            self._operations.finditer(
+                strip_ansi(stdout),
+            )
+        )[-1]
+
+        # retrive the exit code
+        try:
+            result = int(match.group(exit))
+        except IndexError:
+            result = 0
+
+            for code in self._exit_codes:
+                try:
+                    result += int(match.group(code))
+                except IndexError:
+                    pass
+
+        if result == 0:
+            self.line(match.group(0))
+        else:
+            self.line(stdout)
+
+        return result

poetry_plugin_hook-0.0.0/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "poetry-plugin-hook"
+version = "0.0.0"
+description = "poetry plugin to register new command to check if all dependencies are up-to-date"
+authors = ["Christoph Dörrer <d-chris@web.de>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+poetry = "^1.8.0"
+cleo = "^2.1.0"
+
+[tool.poetry.plugins."poetry.application.plugin"]
+hook = "poetry_plugin_hook:HookPlugin"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"