utilities#

Note

See the Glossary for the meaning of the acronyms used in this guide.

contexts#

plugin_dirs(dirs: Iterable[str] = ('.',)) → Iterator[None][source]#
redirect_print(new_target: Optional[IO] = None) → Iterator[None][source]#

decorators#

require_package(name: str, exc_message: typing.Optional[str] = None, exc_type: typing.Type[dioptra.sdk.exceptions.base.BaseOptionalDependencyError] = <class 'dioptra.sdk.exceptions.base.BaseOptionalDependencyError'>) → Callable[[dioptra.sdk.utilities.decorators._require_package.T], dioptra.sdk.utilities.decorators._require_package.T][source]#

logging#

attach_stdout_stream_handler(as_json: bool, logger: Optional[logging.Logger] = None) → None[source]#
clear_logger_handlers(logger: Optional[logging.Logger]) → None[source]#
configure_structlog() → None[source]#
set_logging_level(level: str, logger: Optional[logging.Logger] = None) → None[source]#
class StderrLogStream(as_json: bool)[source]#

Bases: dioptra.sdk.utilities.logging.log_stream.LogStream

close()[source]#
flush()[source]#
class StdoutLogStream(as_json: bool)[source]#

Bases: dioptra.sdk.utilities.logging.log_stream.LogStream

close()[source]#
flush()[source]#

paths#

set_path_ext(filepath: Union[str, pathlib.Path], ext: str) → pathlib.Path[source]#
clear_directory(dir_: Union[str, pathlib.Path])[source]#

Remove all subdirectories and files from the given directory.

Parameters

dir – A string or Path object referring to a directory