Source code for distrax.devices.abstract_device

from typing import List, Protocol, runtime_checkable


[docs]@runtime_checkable
class AbstractDevice(Protocol):
    """An interface for Device Classes.

    A Device is a Block Device that will store the Object Storage Device.
    """

[docs]    def create_device(self, size: int, number: int = 1) -> None:
        """Create the block storage device.

        Args:
            size: The size of the blocks' device in GibiBytes i.e. 1 would be 1GiB
            number: Number of block devices to create, i.e. 4 will create 4 devices
                        of the size stated
        """
        ...

[docs]    @staticmethod
    def get_paths(number: int) -> List[str]:
        """Get the paths of the devices created.

        Args:
            number: number of devices created

        Returns:
            List of Device Paths, i.e. /dev/ram0,/dev/ram1
        """
        ...

[docs]    def remove_device(self) -> None:
        """Remove the block devices created."""
        ...