plugins_api.utils.format_utils
Format and conversion utilities for plugins_api.
Functions
| Name | Description |
|---|---|
extract_file_extension | Derive a normalized file extension from a filename or path. |
is_file_extension_supported | Return whether file_extension is allowed by supported_extensions. |
normalize_file_extension | Normalize a stored or declared file extension. |
size_to_bytes | Convert a size value with unit to bytes. |
extract_file_extensionfunction#
def extract_file_extension(filename: str | None) -> str | NoneDerive a normalized file extension from a filename or path.
Uses the basename only. When the final segment is a known compression
suffix (gz, bz2, xz, zst, zip, z) and a preceding
segment exists, returns a compound extension (e.g. fastq.gz).
Examples
>>> extract_file_extension("sample.fastq.gz")'fastq.gz'>>> extract_file_extension("reads.fq")'fq'>>> extract_file_extension("archive.tar.gz")'tar.gz'>>> extract_file_extension("README")Noneis_file_extension_supportedfunction#
def is_file_extension_supported(file_extension: str | None, supported_extensions: list[str] | tuple[str, ...] | set[str]) -> boolReturn whether file_extension is allowed by supported_extensions.
An empty supported_extensions list means all extensions are allowed.
Missing / blank file_extension is never allowed when the list is
non-empty. Comparison is case-insensitive and ignores a leading dot.
Parameters
Returns
boolTrueif the extension is accepted.
normalize_file_extensionfunction#
def normalize_file_extension(extension: str | None) -> str | NoneNormalize a stored or declared file extension.
Strips whitespace and a leading dot, lowercases the value, and maps empty
results to None. Compound extensions such as fastq.gz are preserved.
size_to_bytesfunction#
def size_to_bytes(size: float, unit: str = 'bytes') -> intConvert a size value with unit to bytes.
Parameters
Returns
int- The size in bytes.
Raises
ValueError- If an invalid unit is provided.
Examples
Decimal (SI) conversion:
>>> size_to_bytes(100, "MB")100000000>>> size_to_bytes(50, "GB")50000000000Binary (IEC) conversion:
>>> size_to_bytes(1024, "KiB")1048576>>> size_to_bytes(100, "MiB")104857600>>> size_to_bytes(50, "GiB")53687091200
