python3-cyberfusion-queue-support 1.2

Library to queue actions.

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.

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.

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.

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

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