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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python3-cyberfusion-queue-support
-Version: 1.1.4
+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.4 → 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.4"
+version = "1.2"
 description = "Library to queue actions."
 readme = "README.md"
 authors = [

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.4 → 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.4 → 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.4
+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.4 → 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.4/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))
-```