wasp_general.os.linux package

Submodules

wasp_general.os.linux.lvm module

class wasp_general.os.linux.lvm.WLVMInfo(command, fields_count, lvm_entity, sudo=False)

Bases: object

Basic class for actual LVM information. This class creates WLVMInfoCommand object which may be called on an object creation (it depends on constructor parameters)

lvm_command()

Return LVM-command object

Returns:WLVMInfoCommand

lvm_entity()

Return object fields

Returns:tuple of str (fields)

class wasp_general.os.linux.lvm.WLVMInfoCommand(command, fields_count, cmd_timeout=None, sudo=False)

Bases: object

This is a helper, with which it is easier to call for pvdisplay, vgdisplay or lvdisplay program.

This class uses subprocess.check_output method for a program calling. And when non-zero code is returned by the program, an subprocess.CalledProcessError exception is raised. There is a timeout for a program to be complete. If a program wasn’t completed for that period of time, subprocess.TimeoutExpired exception is raised

cmd_timeout()

Timeout for a program to complete

Returns:int, float

command()

Return target program

Returns:str

fields_count()

Return number of fields in a program output

Returns:int

lvm_info(name=None)

Call a program

Parameters:name – if specified - program will return information for that lvm-entity only. otherwise -

all available entries are returned

Returns:tuple of str (fields)

sudo()

Return ‘sudo’ flag (whether to run this program with sudo or not)

Returns:bool

class wasp_general.os.linux.lvm.WLogicalVolume(logical_volume, sudo=False)

Bases: wasp_general.os.linux.lvm.WLVMInfo

Class represent a logical volume

all()

Return every logical volume in the system

Returns:tuple of WLogicalVolume

create_snapshot(snapshot_size, snapshot_suffix)

Create snapshot for this logical volume.

Parameters:

• snapshot_size – size of newly created snapshot volume. This size is a fraction of the source logical volume space (of this logical volume)
• snapshot_suffix – suffix for logical volume name (base part is the same as the original volume name)

Returns:

WLogicalVolume

device_number()

Return tuple of major and minor device number of logical volume

Returns:tuple of int

extents_count()

Return current logical extents associated to logical volume

Returns:int

classmethod logical_volume(file_path, sudo=False)

Return logical volume that stores the given path

Parameters:

• file_path – target path to search
• sudo – same as ‘sudo’ in WLogicalVolume.__init__()

Returns:

WLogicalVolume or None (if file path is outside current mount points)

remove_volume()

Remove this volume

Returns:None

sectors_count()

Return logical volume size in sectors

Returns:int

snapshot_allocation()

Return allocated size (fraction of total snapshot volume space). If this is not a snapshot volume, than RuntimeError exception is raised.

Returns:float

snapshot_corrupted()

Check if this snapshot volume is corrupted or not

Returns:bool (True if corrupted, False - otherwise)

uuid()

Return UUID of logical volume

Returns:str

volume_group()

Return volume group

Returns:WVolumeGroup

volume_group_name()

Return volume group name

Returns:str

volume_name()

Return logical volume name

Returns:str

volume_path()

Return logical volume path

Returns:str

class wasp_general.os.linux.lvm.WPhysicalVolume(physical_volume, sudo=False)

Bases: wasp_general.os.linux.lvm.WLVMInfo

Class represent a physical volume

all()

Return every physical volume in the system

Returns:tuple of WPhysicalVolume

allocated_extents()

Return allocated number of physical extents (may have 0 value if this volume is not allocated to any)

Returns:int

device_name()

Return physical volume device name

Returns:str

extent_size()

Return physical extent size in kilobytes (may have 0 value if this volume is not allocated to any)

Returns:int

free_extents()

Return free number of physical extents (may have 0 value if this volume is not allocated to any)

Returns:int

sectors_count()

Return physical volume size in sectors

Returns:int

total_extents()

Return total number of physical extents (may have 0 value if this volume is not allocated to any)

Returns:int

uuid()

Return physical volume UUID

Returns:str

volume_group()

Return related volume group name (may be empty string if this volume is not allocated to any)

Returns:str

class wasp_general.os.linux.lvm.WVolumeGroup(volume_group, sudo=False)

Bases: wasp_general.os.linux.lvm.WLVMInfo

Class represent a volume group

actual_volumes()

Return actual number of physical volumes

Returns:int

all()

Return every volume group in the system

Returns:tuple of WVolumeGroup

allocated_extents()

Return allocated number of physical extents for this volume group

Returns:int

extent_size()

Return physical extent size in kilobytes

Returns:int

free_extents()

Return free number of physical extents for this volume group

Returns:int

group_access()

Return volume group access

Returns:str

group_name()

Return volume group name

Returns:str

logical_volumes()

Return current number of logical volumes

Returns:int

maximum_logical_volumes()

Return maximum number of logical volumes (0 - for unlimited)

Returns:int

maximum_physical_volumes()

Return maximum number of physical volumes (0 - for unlimited)

Returns:int

opened_logical_volumes()

Return open count of all logical volumes in this volume group

Returns:int

physical_volumes()

Return current number of physical volumes

Returns:int

size()

Return size of volume group in kilobytes

Returns:int

total_extents()

Return total number of physical extents for this volume group

Returns:int

uuid()

Return UUID of volume group

Returns:str

wasp_general.os.linux.mounts module

class wasp_general.os.linux.mounts.WMountPoint(mount_record)

Bases: object

This class supply information about system mount points. It allows to find mount point by a custom file path.

device()

Return a mount point device path

Returns:str

device_name()

Return a mount point device name (a base name of a device path)

Returns:str

dump_flag()

Return dump flag for this mount point

Returns:bool

fs()

Return a mount point filesystem name

Returns:str

fsck_order()

Return fsck (filesystem check) order for this mount point

Returns:int

classmethod mount(device, mount_directory, fs=None, options=None, cmd_timeout=None, sudo=False)

Mount a device to mount directory

Parameters:

• device – device to mount
• mount_directory – target directory where the given device will be mounted to
• fs – optional, filesystem on the specified device. If specifies - overrides OS filesystem detection with this value.
• options – specifies mount options (OS/filesystem dependent)
• cmd_timeout – if specified - timeout with which this mount command should be evaluated (if command isn’t complete within the given timeout - an exception will be raised)
• sudo – whether to use sudo to run mount command

Returns:

None

classmethod mount_point(file_path)

Return mount point that, where the given path is reside on

Parameters:file_path – target path to search Returns:WMountPoint or None (if file path is outside current mount points)

classmethod mounts()

Return tuple of current mount points

Returns:tuple of WMountPoint

options()

Return a mount point options (options with which this point was mounted)

Returns:tuple of str

path()

Return a mount point path (path where this mount point is mounted to)

Returns:str

classmethod umount(device_or_directory, cmd_timeout=None, sudo=False)

Unmount device (or mount directory)

Parameters:

• device_or_directory – device name or mount directory to unmount
• cmd_timeout – if specified - timeout with which this unmount command should be evaluated (if command isn’t complete within the given timeout - an exception will be raised)
• sudo – whether to use sudo to run mount command

Returns:

None

Module contents