pip operations¶

class reemote.operations.pip.packages.Packages(packages: List[str], present: bool, guard: bool = True, sudo: bool = False, su: bool = False)[source]¶

Bases: Operation_packages

A class to manage package operations on a remote system using pip.

This class provides functionality to install or remove Python packages on remote systems using the pip package manager. It allows configuration of execution privileges and safety guards for package operations.

packages¶

List of package names to install or remove.

Type:: List[str]

present¶

If True, packages will be installed; if False, packages will be removed.

Type:: bool

guard¶

If False the commands will not be executed.

Type:: bool

sudo¶

If True, the commands will be executed with [sudo](file:///home/kim/reemote/reemote/command.py#L11-L11) privileges.

Type:: bool

su¶

If True, the commands will be executed with [su](file:///home/kim/reemote/reemote/command.py#L12-L12) privileges.

Type:: bool

Examples:

# Install Python packages on all hosts
r = yield Packages(["requests", "flask"], present=True)
# Check if the operation was successful
if r.cp.return_code == 0:
    print("Python packages installed successfully")

# Remove Python packages on all hosts
r = yield Packages(["requests", "flask"], present=False)
# Check if the operation was successful
if r.cp.return_code == 0:
    print("Python packages removed successfully")

Usage:: This class is designed to be used in a generator-based workflow where commands are yielded for execution.

Notes

Commands are constructed based on the [present](file:///home/kim/reemote/reemote/operation_packages.py#L30-L30) flag to determine whether to install or remove packages.
Uses pip install and pip uninstall commands internally for package management.
Inherits from [Operation_packages](file:///home/kim/reemote/reemote/operation_packages.py#L4-L89) base class.

get_packages()[source]¶: Retrieve the list of installed packages. Subclasses must implement this method.

install_packages(packages=None, guard=None, present=None, sudo=None, su=None)[source]¶: Install the specified packages. Subclasses must implement this method.

remove_packages(packages=None, guard=None, present=None, sudo=None, su=None)[source]¶: Remove the specified packages. Subclasses must implement this method.