utils

Utilities for CapSule.

Utility functions and type definitions for Mori capsule. (qurry.capsule.mori.utils)

class qurry.capsule.utils.JSONDumpArgs

Default arguments for print function.

class qurry.capsule.utils.OpenArgs

Default arguments for open function.

class qurry.capsule.utils.PrintArgs

Default arguments for print function.

qurry.capsule.utils.create_json_dump_args(json_dump_args: dict[str, Any] | JSONDumpArgs | None = None) → JSONDumpArgs

Create JSON dump arguments.

Parameters:

json_dump_args (Union[dict[str, Any], JSONDumpArgs]) – Arguments for json.dump function.

Returns:

The JSON dump arguments.

Return type:

JSONDumpArgs

qurry.capsule.utils.create_open_args(open_args: dict[str, Any] | OpenArgs | None = None, is_read_only: bool = False) → OpenArgs

Create open arguments. :param open_args: Arguments for open function. :type open_args: Union[dict[str, Any], OpenArgs] :param is_read_only: Whether the file is read-only. Defaults to False. :type is_read_only: bool, optional

Raises:

TypeError – If ‘open_args’ is not a dict.

Returns:

The open arguments.

Return type:

OpenArgs

qurry.capsule.utils.create_print_args(print_args: dict[str, Any] | PrintArgs | None = None) → PrintArgs

Create print arguments.

Parameters:

print_args (Union[dict[str, Any], PrintArgs]) – Arguments for print function.

Returns:

The print arguments.

Return type:

PrintArgs