expelliarmus.utils#

Module Contents#

Functions#

check_file_encoding(→ None)

check_encoding(→ str)

check_input_file(→ Union[str, pathlib.Path])

check_output_file(→ Union[str, pathlib.Path])

check_chunk_size(→ int)

check_buff_size(→ int)

check_new_duration(→ int)

check_external_file(→ Union[str, pathlib.Path])

check_time_window(→ int)

check_dtype_order(→ tuple)

expelliarmus.utils.check_file_encoding(fpath: Union[str, pathlib.Path], encoding: str) → None[source]#
Parameters

  • fpath (Union[str, pathlib.Path]) –

  • encoding (str) –

Return type

None

expelliarmus.utils.check_encoding(encoding: str) → str[source]#
Parameters

encoding (str) –

Return type

str

expelliarmus.utils.check_input_file(fpath: Union[str, pathlib.Path], encoding: str) → Union[str, pathlib.Path][source]#
Parameters

  • fpath (Union[str, pathlib.Path]) –

  • encoding (str) –

Return type

Union[str, pathlib.Path]

expelliarmus.utils.check_output_file(fpath: Union[str, pathlib.Path], encoding: str) → Union[str, pathlib.Path][source]#
Parameters

  • fpath (Union[str, pathlib.Path]) –

  • encoding (str) –

Return type

Union[str, pathlib.Path]

expelliarmus.utils.check_chunk_size(chunk_size: int, encoding: str) → int[source]#
Parameters

  • chunk_size (int) –

  • encoding (str) –

Return type

int

expelliarmus.utils.check_buff_size(buff_size: int) → int[source]#
Parameters

buff_size (int) –

Return type

int

expelliarmus.utils.check_new_duration(new_duration: int) → int[source]#
Parameters

new_duration (int) –

Return type

int

expelliarmus.utils.check_external_file(fpath: Union[str, pathlib.Path], self_fpath: Union[str, pathlib.Path], encoding: str) → Union[str, pathlib.Path][source]#
Parameters

  • fpath (Union[str, pathlib.Path]) –

  • self_fpath (Union[str, pathlib.Path]) –

  • encoding (str) –

Return type

Union[str, pathlib.Path]

expelliarmus.utils.check_time_window(time_window: int) → int[source]#
Parameters

time_window (int) –

Return type

int

expelliarmus.utils.check_dtype_order(dtype_order: tuple) → tuple[source]#
Parameters

dtype_order (tuple) –

Return type

tuple