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

python3_cyberfusion_queue_support-1.3/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-queue-support
+Version: 1.3
+Summary: Library to queue actions.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-queue-support
+Description-Content-Type: text/markdown
+Requires-Dist: python3-cyberfusion-systemd-support~=2.0
+
+# python3-cyberfusion-queue-support
+
+Library to queue actions.
+
+`QueueSupport` allows you to _queue_ certain actions, such as restarting a service, unlinking a file, and much more.
+
+For example, suppose the file `/tmp/example.txt` should be chmodded to 0600. You can queue the chmod:
+
+```
+>>> from cyberfusion.QueueSupport import Queue
+>>> from cyberfusion.QueueSupport.items.chmod import ChmodItem
+>>> queue = Queue()
+>>> queue.add(ChmodItem(path="/tmp/example.txt", mode=0o600))
+```
+
+... see what the chmod _would_ do with 'preview mode':
+
+```
+>>> queue.process(preview=False)
+[<cyberfusion.QueueSupport.outcomes.ChmodItemModeChangeOutcome object at 0x7f947e8ef510>]
+>>> print(queue.process(preview=True)[0])
+Change mode of /tmp/example.txt from 0o644 to 0o600
+```
+
+... then actually run the chmod:
+
+```
+>>> print(queue.process(preview=False)[0])
+Change mode of /tmp/example2.txt from 0o644 to 0o600
+```
+
+# 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
+
+## Concepts
+
+All project-specific terms are in _italic_.
+
+After creating a _queue_, _items_ can be added to it.
+
+```python
+from cyberfusion.QueueSupport import Queue
+
+queue = Queue()
+
+item = ...
+
+queue.add(item)
+```
+
+_Items_ are of a certain type. Such as `ChmodItem` or `SystemdUnitRestartItem`. Items can have attributes, such as a path for an `MkdirItem`, or a unit name for `SystemdUnitEnableItem`.
+
+```python
+from cyberfusion.QueueSupport.items.chmod import ChmodItem
+from cyberfusion.QueueSupport.items.systemd_unit_enable import SystemdUnitEnableItem
+
+item1 = ChmodItem(path="/tmp/example.txt", mode=0o600)
+item2 = SystemdUnitEnableItem(name="httpd.service")
+```
+
+Each _item_ type has one or multiple _outcomes_. These 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_ come true.
+
+```python
+from cyberfusion.QueueSupport import Queue
+
+from cyberfusion.QueueSupport.items.rmtree import RmTreeItem
+
+item = RmTreeItem(path="/tmp/dir")
+
+queue = Queue()
+
+queue.add(item)
+
+# Fulfill every item in the queue
+
+queue.process(preview=False)
+queue.process(preview=True)  # Only show what the outcomes would be
+
+# Fulfill a single item
+
+item.fulfill()
+```
+
+## Diagram
+
+```mermaid
+graph TD;
+
+  subgraph QueueSupport
+    Queue["Queue"]
+    Item["Add item"]
+    Process["Process (fulfill all items)"]
+  end
+
+  Queue --> Item
+
+  subgraph ItemTypes["Item types"]
+    ChmodItem["ChmodItem"]
+    SystemdUnitEnableItem["SystemdUnitEnableItem"]
+    SystemdUnitRestartItem["SystemdUnitRestartItem"]
+    MkdirItem["MkdirItem"]
+    UnlinkItem["UnlinkItem"]
+    RmTreeItem["RmTreeItem"]
+    Other["Others..."]
+  end
+
+  Item --> ItemTypes
+  ItemTypes --> Outcome["Outcome (item's goal)"]
+
+  Process --> Fulfill["Fulfill outcomes for each item"]
+
+  %% Example flows for item attributes and outcomes
+  ChmodItem -.->|path, mode| Outcome
+  SystemdUnitEnableItem -.->|unit name| Outcome
+  MkdirItem -.->|path| Outcome
+  UnlinkItem -.->|unlink file| Outcome
+  RmTreeItem -.->|remove directory| Outcome
+
+  Queue --> Process
+  Process --> Fulfill
+```
+
+## 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.3/README.md

@@ -0,0 +1,162 @@
+# python3-cyberfusion-queue-support
+
+Library to queue actions.
+
+`QueueSupport` allows you to _queue_ certain actions, such as restarting a service, unlinking a file, and much more.
+
+For example, suppose the file `/tmp/example.txt` should be chmodded to 0600. You can queue the chmod:
+
+```
+>>> from cyberfusion.QueueSupport import Queue
+>>> from cyberfusion.QueueSupport.items.chmod import ChmodItem
+>>> queue = Queue()
+>>> queue.add(ChmodItem(path="/tmp/example.txt", mode=0o600))
+```
+
+... see what the chmod _would_ do with 'preview mode':
+
+```
+>>> queue.process(preview=False)
+[<cyberfusion.QueueSupport.outcomes.ChmodItemModeChangeOutcome object at 0x7f947e8ef510>]
+>>> print(queue.process(preview=True)[0])
+Change mode of /tmp/example.txt from 0o644 to 0o600
+```
+
+... then actually run the chmod:
+
+```
+>>> print(queue.process(preview=False)[0])
+Change mode of /tmp/example2.txt from 0o644 to 0o600
+```
+
+# 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
+
+## Concepts
+
+All project-specific terms are in _italic_.
+
+After creating a _queue_, _items_ can be added to it.
+
+```python
+from cyberfusion.QueueSupport import Queue
+
+queue = Queue()
+
+item = ...
+
+queue.add(item)
+```
+
+_Items_ are of a certain type. Such as `ChmodItem` or `SystemdUnitRestartItem`. Items can have attributes, such as a path for an `MkdirItem`, or a unit name for `SystemdUnitEnableItem`.
+
+```python
+from cyberfusion.QueueSupport.items.chmod import ChmodItem
+from cyberfusion.QueueSupport.items.systemd_unit_enable import SystemdUnitEnableItem
+
+item1 = ChmodItem(path="/tmp/example.txt", mode=0o600)
+item2 = SystemdUnitEnableItem(name="httpd.service")
+```
+
+Each _item_ type has one or multiple _outcomes_. These 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_ come true.
+
+```python
+from cyberfusion.QueueSupport import Queue
+
+from cyberfusion.QueueSupport.items.rmtree import RmTreeItem
+
+item = RmTreeItem(path="/tmp/dir")
+
+queue = Queue()
+
+queue.add(item)
+
+# Fulfill every item in the queue
+
+queue.process(preview=False)
+queue.process(preview=True)  # Only show what the outcomes would be
+
+# Fulfill a single item
+
+item.fulfill()
+```
+
+## Diagram
+
+```mermaid
+graph TD;
+
+  subgraph QueueSupport
+    Queue["Queue"]
+    Item["Add item"]
+    Process["Process (fulfill all items)"]
+  end
+
+  Queue --> Item
+
+  subgraph ItemTypes["Item types"]
+    ChmodItem["ChmodItem"]
+    SystemdUnitEnableItem["SystemdUnitEnableItem"]
+    SystemdUnitRestartItem["SystemdUnitRestartItem"]
+    MkdirItem["MkdirItem"]
+    UnlinkItem["UnlinkItem"]
+    RmTreeItem["RmTreeItem"]
+    Other["Others..."]
+  end
+
+  Item --> ItemTypes
+  ItemTypes --> Outcome["Outcome (item's goal)"]
+
+  Process --> Fulfill["Fulfill outcomes for each item"]
+
+  %% Example flows for item attributes and outcomes
+  ChmodItem -.->|path, mode| Outcome
+  SystemdUnitEnableItem -.->|unit name| Outcome
+  MkdirItem -.->|path| Outcome
+  UnlinkItem -.->|unlink file| Outcome
+  RmTreeItem -.->|remove directory| Outcome
+
+  Queue --> Process
+  Process --> Fulfill
+```
+
+## 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.3}/pyproject.toml

@@ -4,14 +4,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-cyberfusion-queue-support"
-version = "1.1.4"
+version = "1.3"
 description = "Library to queue actions."
 readme = "README.md"
 authors = [
     { name = "Cyberfusion", email = "support@cyberfusion.io" },
 ]
 dependencies = [
-    "python3-cyberfusion-systemd-support~=1.0",
+    "python3-cyberfusion-systemd-support~=2.0",
 ]
 
 [project.urls]

python3_cyberfusion_queue_support-1.3/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.3}/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.3/src/python3_cyberfusion_queue_support.egg-info/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-queue-support
+Version: 1.3
+Summary: Library to queue actions.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-queue-support
+Description-Content-Type: text/markdown
+Requires-Dist: python3-cyberfusion-systemd-support~=2.0
+
+# python3-cyberfusion-queue-support
+
+Library to queue actions.
+
+`QueueSupport` allows you to _queue_ certain actions, such as restarting a service, unlinking a file, and much more.
+
+For example, suppose the file `/tmp/example.txt` should be chmodded to 0600. You can queue the chmod:
+
+```
+>>> from cyberfusion.QueueSupport import Queue
+>>> from cyberfusion.QueueSupport.items.chmod import ChmodItem
+>>> queue = Queue()
+>>> queue.add(ChmodItem(path="/tmp/example.txt", mode=0o600))
+```
+
+... see what the chmod _would_ do with 'preview mode':
+
+```
+>>> queue.process(preview=False)
+[<cyberfusion.QueueSupport.outcomes.ChmodItemModeChangeOutcome object at 0x7f947e8ef510>]
+>>> print(queue.process(preview=True)[0])
+Change mode of /tmp/example.txt from 0o644 to 0o600
+```
+
+... then actually run the chmod:
+
+```
+>>> print(queue.process(preview=False)[0])
+Change mode of /tmp/example2.txt from 0o644 to 0o600
+```
+
+# 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
+
+## Concepts
+
+All project-specific terms are in _italic_.
+
+After creating a _queue_, _items_ can be added to it.
+
+```python
+from cyberfusion.QueueSupport import Queue
+
+queue = Queue()
+
+item = ...
+
+queue.add(item)
+```
+
+_Items_ are of a certain type. Such as `ChmodItem` or `SystemdUnitRestartItem`. Items can have attributes, such as a path for an `MkdirItem`, or a unit name for `SystemdUnitEnableItem`.
+
+```python
+from cyberfusion.QueueSupport.items.chmod import ChmodItem
+from cyberfusion.QueueSupport.items.systemd_unit_enable import SystemdUnitEnableItem
+
+item1 = ChmodItem(path="/tmp/example.txt", mode=0o600)
+item2 = SystemdUnitEnableItem(name="httpd.service")
+```
+
+Each _item_ type has one or multiple _outcomes_. These 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_ come true.
+
+```python
+from cyberfusion.QueueSupport import Queue
+
+from cyberfusion.QueueSupport.items.rmtree import RmTreeItem
+
+item = RmTreeItem(path="/tmp/dir")
+
+queue = Queue()
+
+queue.add(item)
+
+# Fulfill every item in the queue
+
+queue.process(preview=False)
+queue.process(preview=True)  # Only show what the outcomes would be
+
+# Fulfill a single item
+
+item.fulfill()
+```
+
+## Diagram
+
+```mermaid
+graph TD;
+
+  subgraph QueueSupport
+    Queue["Queue"]
+    Item["Add item"]
+    Process["Process (fulfill all items)"]
+  end
+
+  Queue --> Item
+
+  subgraph ItemTypes["Item types"]
+    ChmodItem["ChmodItem"]
+    SystemdUnitEnableItem["SystemdUnitEnableItem"]
+    SystemdUnitRestartItem["SystemdUnitRestartItem"]
+    MkdirItem["MkdirItem"]
+    UnlinkItem["UnlinkItem"]
+    RmTreeItem["RmTreeItem"]
+    Other["Others..."]
+  end
+
+  Item --> ItemTypes
+  ItemTypes --> Outcome["Outcome (item's goal)"]
+
+  Process --> Fulfill["Fulfill outcomes for each item"]
+
+  %% Example flows for item attributes and outcomes
+  ChmodItem -.->|path, mode| Outcome
+  SystemdUnitEnableItem -.->|unit name| Outcome
+  MkdirItem -.->|path| Outcome
+  UnlinkItem -.->|unlink file| Outcome
+  RmTreeItem -.->|remove directory| Outcome
+
+  Queue --> Process
+  Process --> Fulfill
+```
+
+## 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.3}/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.3/src/python3_cyberfusion_queue_support.egg-info/requires.txt

@@ -0,0 +1 @@
+python3-cyberfusion-systemd-support~=2.0

python3_cyberfusion_queue_support-1.1.4/PKG-INFO

@@ -1,54 +0,0 @@
-Metadata-Version: 2.1
-Name: python3-cyberfusion-queue-support
-Version: 1.1.4
-Summary: Library to queue actions.
-Author-email: Cyberfusion <support@cyberfusion.io>
-Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-queue-support
-Description-Content-Type: text/markdown
-Requires-Dist: python3-cyberfusion-systemd-support~=1.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))
-```

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))
-```

python3_cyberfusion_queue_support-1.1.4/src/python3_cyberfusion_queue_support.egg-info/PKG-INFO

@@ -1,54 +0,0 @@
-Metadata-Version: 2.1
-Name: python3-cyberfusion-queue-support
-Version: 1.1.4
-Summary: Library to queue actions.
-Author-email: Cyberfusion <support@cyberfusion.io>
-Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-queue-support
-Description-Content-Type: text/markdown
-Requires-Dist: python3-cyberfusion-systemd-support~=1.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))
-```

python3_cyberfusion_queue_support-1.1.4/src/python3_cyberfusion_queue_support.egg-info/requires.txt

@@ -1 +0,0 @@
-python3-cyberfusion-systemd-support~=1.0