torchio.external.imports

Complexity

Total Complexity

9

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Importance

Changes

0

6 Functions

Rating	Name	Duplication	Size	Complexity
A	get_pandas()	0	2	1
A	get_ffmpeg()	0	4	1
A	_check_module()	0	9	3
A	_check_executable()	0	7	2
A	get_distinctipy()	0	2	1
A	_check_and_import()	0	3	1

from importlib import import_module
from importlib.util import find_spec
from shutil import which
from types import ModuleType


def _check_module(*, module: str, extra: str, package: str | None = None) -> None:
    if find_spec(module) is None:
        name = module if package is None else package
        message = (
            f'The `{name}` package is required for this.'
            f' Install TorchIO with the `{extra}` extra:'
            f' `pip install torchio[{extra}]`.'
        )
        raise ImportError(message)


def _check_and_import(module: str, extra: str, **kwargs) -> ModuleType:
    _check_module(module=module, extra=extra, **kwargs)
    return import_module(module)


def get_pandas() -> ModuleType:
    return _check_and_import(module='pandas', extra='csv')


def get_distinctipy() -> ModuleType:
    return _check_and_import(module='distinctipy', extra='plot')


def get_ffmpeg() -> ModuleType:
    ffmpeg = _check_and_import(module='ffmpeg', extra='video', package='ffmpeg-python')
    _check_executable('ffmpeg')
    return ffmpeg


def _check_executable(executable: str) -> None:
    if which(executable) is None:
        message = (
            f'The `{executable}` executable is required for this. Install it from your'
            ' package manager or download it from the official website.'
        )
        raise FileNotFoundError(message)