python3-cyberfusion-queue-support 1.1.3__tar.gz → 1.2__tar.gz

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python3-cyberfusion-queue-support
-Version: 1.1.3
+Version: 1.2
 Summary: Library to queue actions.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-queue-support
@@ -11,6 +11,43 @@ Requires-Dist: python3-cyberfusion-systemd-support~=1.0
 
 Library to queue actions.
 
+# Concepts
+
+All project-specific terms are in _italic_.
+
+After creating a _queue_, _items_ can be added to it.
+
+```python
+queue = Queue()
+
+queue.add(item)
+```
+
+These _items_ can be of multiple types such as `ChmodItem` or `SystemdUnitRestartItem`, and they can have attributes such as a path for an `MkdirItem` or a unit name for a `SystemdUnitEnableItem`.
+
+```python
+item1 = ChmodItem(path="/tmp/example.txt", mode=0o600)
+item2 = SystemdUnitEnableItem(name="httpd.service")
+```
+
+Each _item_ type has one or multiple _outcomes_ that should come true for an _item_ of that type to be completed. For example: for an _item_ of type `UnlinkItem`, the _outcome_ is that the file at the path given with the _item_ is unlinked.
+
+When a _queue_ is _processed_, all the _items_ added to it are _fulfilled_, meaning all the _items'_ _outcomes_ are completed.
+
+```python
+item = RmTreeItem(path="/tmp/dir")
+
+queue = Queue()
+
+queue.add(item)
+
+# for each item added to the queue, its fulfill() function is run
+queue.process()
+
+# this would do the same
+item.fulfill()
+```
+
 # Install
 
 ## PyPI

python3_cyberfusion_queue_support-1.2/README.md

@@ -0,0 +1,82 @@
+# python3-cyberfusion-queue-support
+
+Library to queue actions.
+
+# Concepts
+
+All project-specific terms are in _italic_.
+
+After creating a _queue_, _items_ can be added to it.
+
+```python
+queue = Queue()
+
+queue.add(item)
+```
+
+These _items_ can be of multiple types such as `ChmodItem` or `SystemdUnitRestartItem`, and they can have attributes such as a path for an `MkdirItem` or a unit name for a `SystemdUnitEnableItem`.
+
+```python
+item1 = ChmodItem(path="/tmp/example.txt", mode=0o600)
+item2 = SystemdUnitEnableItem(name="httpd.service")
+```
+
+Each _item_ type has one or multiple _outcomes_ that should come true for an _item_ of that type to be completed. For example: for an _item_ of type `UnlinkItem`, the _outcome_ is that the file at the path given with the _item_ is unlinked.
+
+When a _queue_ is _processed_, all the _items_ added to it are _fulfilled_, meaning all the _items'_ _outcomes_ are completed.
+
+```python
+item = RmTreeItem(path="/tmp/dir")
+
+queue = Queue()
+
+queue.add(item)
+
+# for each item added to the queue, its fulfill() function is run
+queue.process()
+
+# this would do the same
+item.fulfill()
+```
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-queue-support
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Example
+
+```python
+from cyberfusion.QueueSupport import Queue
+from cyberfusion.QueueSupport.items.chmod import ChmodItem
+
+queue = Queue()
+
+item = ChmodItem(path="/tmp/example.txt", mode=0o600)
+print(item.outcomes)
+
+queue.add(item)
+
+preview = True or False
+
+outcomes = queue.process(preview=preview)
+
+for outcome in outcomes:
+    print(str(outcome))
+```

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-cyberfusion-queue-support"
-version = "1.1.3"
+version = "1.2"
 description = "Library to queue actions."
 readme = "README.md"
 authors = [

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/interfaces.py

@@ -24,7 +24,7 @@ class ItemInterface(metaclass=ABCMeta):
     @property
     @abstractmethod
     def outcomes(self) -> List[OutcomeInterface]:  # pragma: no cover
-        """Get outcomes of calling self.fulfill."""
+        """Get outcomes of item."""
         pass
 
     @abstractmethod

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/chmod.py

@@ -5,7 +5,6 @@ import os
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import ChmodItemModeChangeOutcome
 from cyberfusion.QueueSupport.utilities import get_decimal_permissions
@@ -34,8 +33,8 @@ class ChmodItem(_Item):
             raise PathIsSymlinkError(self.path)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[ChmodItemModeChangeOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if not os.path.exists(self.path):
@@ -59,12 +58,8 @@ class ChmodItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        mode_change_outcomes = [
-            x for x in self.outcomes if isinstance(x, ChmodItemModeChangeOutcome)
-        ]
-
-        if mode_change_outcomes:
-            os.chmod(mode_change_outcomes[0].path, mode_change_outcomes[0].new_mode)
+        for outcome in self.outcomes:
+            os.chmod(outcome.path, outcome.new_mode)
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/chown.py

@@ -9,7 +9,6 @@ from pwd import getpwuid
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import (
     ChownItemGroupChangeOutcome,
@@ -52,8 +51,10 @@ class ChownItem(_Item):
             raise PathIsSymlinkError(self.path)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(
+        self,
+    ) -> List[ChownItemOwnerChangeOutcome | ChownItemGroupChangeOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if not os.path.exists(self.path):
@@ -107,26 +108,19 @@ class ChownItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        owner_name_change_outcomes = [
-            x for x in self.outcomes if isinstance(x, ChownItemOwnerChangeOutcome)
-        ]
-        group_name_change_outcomes = [
-            x for x in self.outcomes if isinstance(x, ChownItemGroupChangeOutcome)
-        ]
-
-        if owner_name_change_outcomes:
-            os.chown(
-                owner_name_change_outcomes[0].path,
-                uid=get_uid(owner_name_change_outcomes[0].new_owner_name),
-                gid=-1,
-            )
-
-        if group_name_change_outcomes:
-            os.chown(
-                group_name_change_outcomes[0].path,
-                uid=-1,
-                gid=get_gid(group_name_change_outcomes[0].new_group_name),
-            )
+        for outcome in self.outcomes:
+            if isinstance(outcome, ChownItemOwnerChangeOutcome):
+                os.chown(
+                    outcome.path,
+                    uid=get_uid(outcome.new_owner_name),
+                    gid=-1,
+                )
+            else:
+                os.chown(
+                    outcome.path,
+                    uid=-1,
+                    gid=get_gid(outcome.new_group_name),
+                )
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/command.py

@@ -5,7 +5,6 @@ import subprocess
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import CommandQueueFulfillFailed
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import CommandItemRunOutcome
 
@@ -28,8 +27,8 @@ class CommandItem(_Item):
         self._hide_outcomes = hide_outcomes
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[CommandItemRunOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         outcomes.append(CommandItemRunOutcome(command=self.command))
@@ -38,26 +37,21 @@ class CommandItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        run_outcomes = [
-            x for x in self.outcomes if isinstance(x, CommandItemRunOutcome)
-        ]
-
-        command = run_outcomes[0].command
-
-        try:
-            output = subprocess.run(
-                command,
-                check=True,
-                text=True,
-                capture_output=True,
-            )
-
-            logger.info("Command stdout: %s", output.stdout)
-            logger.info("Command stderr: %s", output.stderr)
-        except subprocess.CalledProcessError as e:
-            raise CommandQueueFulfillFailed(
-                self, command=command, stdout=e.stdout, stderr=e.stderr
-            ) from e
+        for outcome in self.outcomes:
+            try:
+                output = subprocess.run(
+                    outcome.command,
+                    check=True,
+                    text=True,
+                    capture_output=True,
+                )
+
+                logger.info("Command stdout: %s", output.stdout)
+                logger.info("Command stderr: %s", output.stderr)
+            except subprocess.CalledProcessError as e:
+                raise CommandQueueFulfillFailed(
+                    self, command=outcome.command, stdout=e.stdout, stderr=e.stderr
+                ) from e
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/copy.py

@@ -6,7 +6,6 @@ import shutil
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import CopyItemCopyOutcome
 
@@ -37,8 +36,8 @@ class CopyItem(_Item):
             raise PathIsSymlinkError(self.destination)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[CopyItemCopyOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         outcomes.append(
@@ -49,9 +48,8 @@ class CopyItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        copy_outcomes = [x for x in self.outcomes if isinstance(x, CopyItemCopyOutcome)]
-
-        shutil.copyfile(copy_outcomes[0].source, copy_outcomes[0].destination)
+        for outcome in self.outcomes:
+            shutil.copyfile(outcome.source, outcome.destination)
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/mkdir.py

@@ -5,7 +5,6 @@ import os
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import MkdirItemCreateOutcome
 
@@ -31,8 +30,8 @@ class MkdirItem(_Item):
             raise PathIsSymlinkError(self.path)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[MkdirItemCreateOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if not os.path.isdir(self.path):
@@ -46,12 +45,8 @@ class MkdirItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        create_outcomes = [
-            x for x in self.outcomes if isinstance(x, MkdirItemCreateOutcome)
-        ]
-
-        if create_outcomes:
-            os.mkdir(create_outcomes[0].path)
+        for outcome in self.outcomes:
+            os.mkdir(outcome.path)
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/move.py

@@ -6,7 +6,6 @@ import shutil
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import MoveItemMoveOutcome
 
@@ -37,8 +36,8 @@ class MoveItem(_Item):
             raise PathIsSymlinkError(self.destination)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[MoveItemMoveOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         outcomes.append(
@@ -49,9 +48,8 @@ class MoveItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        move_outcomes = [x for x in self.outcomes if isinstance(x, MoveItemMoveOutcome)]
-
-        shutil.move(move_outcomes[0].source, move_outcomes[0].destination)
+        for outcome in self.outcomes:
+            shutil.move(outcome.source, outcome.destination)
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

python3_cyberfusion_queue_support-1.2/src/cyberfusion/QueueSupport/items/rmtree.py

@@ -0,0 +1,57 @@
+"""Item."""
+
+import logging
+import os
+import shutil
+from typing import List, Optional
+
+from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
+from cyberfusion.QueueSupport.items import _Item
+from cyberfusion.QueueSupport.outcomes import RmTreeItemRemoveOutcome
+
+logger = logging.getLogger(__name__)
+
+
+class RmTreeItem(_Item):
+    """Represents item."""
+
+    def __init__(
+        self,
+        *,
+        path: str,
+        reference: Optional[str] = None,
+        hide_outcomes: bool = False,
+    ) -> None:
+        """Set attributes."""
+        self.path = path
+        self._reference = reference
+        self._hide_outcomes = hide_outcomes
+
+        if os.path.islink(self.path):
+            raise PathIsSymlinkError(self.path)
+
+    @property
+    def outcomes(self) -> List[RmTreeItemRemoveOutcome]:
+        """Get outcomes of calling self.fulfill."""
+        outcomes = []
+
+        if os.path.exists(self.path):
+            outcomes.append(
+                RmTreeItemRemoveOutcome(
+                    path=self.path,
+                )
+            )
+
+        return outcomes
+
+    def fulfill(self) -> None:
+        """Fulfill outcomes."""
+        for outcome in self.outcomes:
+            shutil.rmtree(outcome.path)
+
+    def __eq__(self, other: object) -> bool:
+        """Get equality based on attributes."""
+        if not isinstance(other, RmTreeItem):
+            return False
+
+        return other.path == self.path

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/systemd_tmp_files_create.py

@@ -3,7 +3,6 @@
 import logging
 from typing import List, Optional
 
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import (
     SystemdTmpFilesCreateItemCreateOutcome,
@@ -29,8 +28,8 @@ class SystemdTmpFilesCreateItem(_Item):
         self._hide_outcomes = hide_outcomes
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[SystemdTmpFilesCreateItemCreateOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         outcomes.append(SystemdTmpFilesCreateItemCreateOutcome(path=self.path))
@@ -39,13 +38,8 @@ class SystemdTmpFilesCreateItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        systemd_tmp_files_create_outcomes = [
-            x
-            for x in self.outcomes
-            if isinstance(x, SystemdTmpFilesCreateItemCreateOutcome)
-        ]
-
-        TmpFileConfigurationFile(systemd_tmp_files_create_outcomes[0].path).create()
+        for outcome in self.outcomes:
+            TmpFileConfigurationFile(outcome.path).create()
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/systemd_unit_disable.py

@@ -3,7 +3,6 @@
 import logging
 from typing import List, Optional
 
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import (
     SystemdUnitDisableItemDisableOutcome,
@@ -31,8 +30,8 @@ class SystemdUnitDisableItem(_Item):
         self.unit = Unit(self.name)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[SystemdUnitDisableItemDisableOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if self.unit.is_enabled:
@@ -42,14 +41,8 @@ class SystemdUnitDisableItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        systemd_unit_disable_outcomes = [
-            x
-            for x in self.outcomes
-            if isinstance(x, SystemdUnitDisableItemDisableOutcome)
-        ]
-
-        if systemd_unit_disable_outcomes:
-            systemd_unit_disable_outcomes[0].unit.disable()
+        for outcome in self.outcomes:
+            outcome.unit.disable()
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/systemd_unit_enable.py

@@ -3,7 +3,6 @@
 import logging
 from typing import List, Optional
 
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import (
     SystemdUnitEnableItemEnableOutcome,
@@ -31,8 +30,8 @@ class SystemdUnitEnableItem(_Item):
         self.unit = Unit(self.name)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[SystemdUnitEnableItemEnableOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if not self.unit.is_enabled:
@@ -42,14 +41,8 @@ class SystemdUnitEnableItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        systemd_unit_enable_outcomes = [
-            x
-            for x in self.outcomes
-            if isinstance(x, SystemdUnitEnableItemEnableOutcome)
-        ]
-
-        if systemd_unit_enable_outcomes:
-            systemd_unit_enable_outcomes[0].unit.enable()
+        for outcome in self.outcomes:
+            outcome.unit.enable()
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/systemd_unit_reload.py

@@ -3,7 +3,6 @@
 import logging
 from typing import List, Optional
 
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import (
     SystemdUnitReloadItemReloadOutcome,
@@ -31,8 +30,8 @@ class SystemdUnitReloadItem(_Item):
         self.unit = Unit(self.name)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[SystemdUnitReloadItemReloadOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         outcomes.append(SystemdUnitReloadItemReloadOutcome(unit=self.unit))
@@ -41,13 +40,8 @@ class SystemdUnitReloadItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        systemd_unit_reload_outcomes = [
-            x
-            for x in self.outcomes
-            if isinstance(x, SystemdUnitReloadItemReloadOutcome)
-        ]
-
-        systemd_unit_reload_outcomes[0].unit.reload()
+        for outcome in self.outcomes:
+            outcome.unit.reload()
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/systemd_unit_restart.py

@@ -3,7 +3,6 @@
 import logging
 from typing import List, Optional
 
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import (
     SystemdUnitRestartItemRestartOutcome,
@@ -31,8 +30,8 @@ class SystemdUnitRestartItem(_Item):
         self.unit = Unit(self.name)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[SystemdUnitRestartItemRestartOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         outcomes.append(SystemdUnitRestartItemRestartOutcome(unit=self.unit))
@@ -41,13 +40,8 @@ class SystemdUnitRestartItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        systemd_unit_restart_outcomes = [
-            x
-            for x in self.outcomes
-            if isinstance(x, SystemdUnitRestartItemRestartOutcome)
-        ]
-
-        systemd_unit_restart_outcomes[0].unit.restart()
+        for outcome in self.outcomes:
+            outcome.unit.restart()
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/systemd_unit_stop.py

@@ -3,7 +3,6 @@
 import logging
 from typing import List, Optional
 
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import SystemdUnitStopItemStopOutcome
 from cyberfusion.SystemdSupport.units import Unit
@@ -29,8 +28,8 @@ class SystemdUnitStopItem(_Item):
         self.unit = Unit(self.name)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[SystemdUnitStopItemStopOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if self.unit.is_active:
@@ -40,12 +39,8 @@ class SystemdUnitStopItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        systemd_unit_stop_outcomes = [
-            x for x in self.outcomes if isinstance(x, SystemdUnitStopItemStopOutcome)
-        ]
-
-        if systemd_unit_stop_outcomes:
-            systemd_unit_stop_outcomes[0].unit.stop()
+        for outcome in self.outcomes:
+            outcome.unit.stop()
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/items/unlink.py

@@ -5,7 +5,6 @@ import os
 from typing import List, Optional
 
 from cyberfusion.QueueSupport.exceptions import PathIsSymlinkError
-from cyberfusion.QueueSupport.interfaces import OutcomeInterface
 from cyberfusion.QueueSupport.items import _Item
 from cyberfusion.QueueSupport.outcomes import UnlinkItemUnlinkOutcome
 
@@ -31,8 +30,8 @@ class UnlinkItem(_Item):
             raise PathIsSymlinkError(self.path)
 
     @property
-    def outcomes(self) -> List[OutcomeInterface]:
-        """Get outcomes of calling self.fulfill."""
+    def outcomes(self) -> List[UnlinkItemUnlinkOutcome]:
+        """Get outcomes of item."""
         outcomes = []
 
         if os.path.exists(self.path):
@@ -46,12 +45,8 @@ class UnlinkItem(_Item):
 
     def fulfill(self) -> None:
         """Fulfill outcomes."""
-        unlink_outcomes = [
-            x for x in self.outcomes if isinstance(x, UnlinkItemUnlinkOutcome)
-        ]
-
-        if unlink_outcomes:
-            os.unlink(unlink_outcomes[0].path)
+        for outcome in self.outcomes:
+            os.unlink(outcome.path)
 
     def __eq__(self, other: object) -> bool:
         """Get equality based on attributes."""

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/cyberfusion/QueueSupport/outcomes.py

@@ -105,6 +105,25 @@ class UnlinkItemUnlinkOutcome(OutcomeInterface):
         return other.path == self.path
 
 
+class RmTreeItemRemoveOutcome(OutcomeInterface):
+    """Represents outcome."""
+
+    def __init__(self, *, path: str) -> None:
+        """Set attributes."""
+        self.path = path
+
+    def __str__(self) -> str:
+        """Get human-readable string."""
+        return f"Remove directory tree {self.path}"
+
+    def __eq__(self, other: object) -> bool:
+        """Get equality based on attributes."""
+        if not isinstance(other, RmTreeItemRemoveOutcome):
+            return False
+
+        return other.path == self.path
+
+
 class CommandItemRunOutcome(OutcomeInterface):
     """Represents outcome."""
 

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/python3_cyberfusion_queue_support.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python3-cyberfusion-queue-support
-Version: 1.1.3
+Version: 1.2
 Summary: Library to queue actions.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-queue-support
@@ -11,6 +11,43 @@ Requires-Dist: python3-cyberfusion-systemd-support~=1.0
 
 Library to queue actions.
 
+# Concepts
+
+All project-specific terms are in _italic_.
+
+After creating a _queue_, _items_ can be added to it.
+
+```python
+queue = Queue()
+
+queue.add(item)
+```
+
+These _items_ can be of multiple types such as `ChmodItem` or `SystemdUnitRestartItem`, and they can have attributes such as a path for an `MkdirItem` or a unit name for a `SystemdUnitEnableItem`.
+
+```python
+item1 = ChmodItem(path="/tmp/example.txt", mode=0o600)
+item2 = SystemdUnitEnableItem(name="httpd.service")
+```
+
+Each _item_ type has one or multiple _outcomes_ that should come true for an _item_ of that type to be completed. For example: for an _item_ of type `UnlinkItem`, the _outcome_ is that the file at the path given with the _item_ is unlinked.
+
+When a _queue_ is _processed_, all the _items_ added to it are _fulfilled_, meaning all the _items'_ _outcomes_ are completed.
+
+```python
+item = RmTreeItem(path="/tmp/dir")
+
+queue = Queue()
+
+queue.add(item)
+
+# for each item added to the queue, its fulfill() function is run
+queue.process()
+
+# this would do the same
+item.fulfill()
+```
+
 # Install
 
 ## PyPI

{python3_cyberfusion_queue_support-1.1.3 → python3_cyberfusion_queue_support-1.2}/src/python3_cyberfusion_queue_support.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ src/cyberfusion/QueueSupport/items/command.py
 src/cyberfusion/QueueSupport/items/copy.py
 src/cyberfusion/QueueSupport/items/mkdir.py
 src/cyberfusion/QueueSupport/items/move.py
+src/cyberfusion/QueueSupport/items/rmtree.py
 src/cyberfusion/QueueSupport/items/systemd_tmp_files_create.py
 src/cyberfusion/QueueSupport/items/systemd_unit_disable.py
 src/cyberfusion/QueueSupport/items/systemd_unit_enable.py

python3_cyberfusion_queue_support-1.1.3/README.md

@@ -1,45 +0,0 @@
-# python3-cyberfusion-queue-support
-
-Library to queue actions.
-
-# Install
-
-## PyPI
-
-Run the following command to install the package from PyPI:
-
-    pip3 install python3-cyberfusion-queue-support
-
-## Debian
-
-Run the following commands to build a Debian package:
-
-    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
-    dpkg-buildpackage -us -uc
-
-# Configure
-
-No configuration is supported.
-
-# Usage
-
-## Example
-
-```python
-from cyberfusion.QueueSupport import Queue
-from cyberfusion.QueueSupport.items.chmod import ChmodItem
-
-queue = Queue()
-
-item = ChmodItem(path="/tmp/example.txt", mode=0o600)
-print(item.outcomes)
-
-queue.add(item)
-
-preview = True or False
-
-outcomes = queue.process(preview=preview)
-
-for outcome in outcomes:
-    print(str(outcome))
-```