my_python_utils.traces package

Submodules

my_python_utils.traces.tracer module

class my_python_utils.traces.tracer.Tracer(pattern: Literal['uuid', 'ulid', 'timestamp'], base_dir: str = './outputs')

ベースクラス: object

backup(targets: List[str], compression: Literal['zip'] = 'zip')

バックアップファイルを作成する。 :param targets: バックアップ対象のファイルまたはディレクトリのリスト。 :param compression: 圧縮形式。zipのみサポート。

サンプル

`python tracer.backup(targets=["some_script.py", "some_function.py", "some_module.py"], compression="zip") `

describe(description: str = '', file_name: str = 'README.md')

トレースディレクトリにREADME.mdファイルを作成し、descriptionを保存する。 :param description: トレースの説明。 :param file_name: README.mdファイルの名前。デフォルトはREADME.md。

サンプル

`python tracer.describe(description="Some description of the trace", file_name="DESC.md") `

save(value: Any, file_name: str)

値をファイルに保存する。 :param value: 保存する値。 :param file_name: 保存するファイルの名前。

サンプル

`python tracer.save(value="Some value", file_name="some_value.txt") `

Module contents

class my_python_utils.traces.Tracer(pattern: Literal['uuid', 'ulid', 'timestamp'], base_dir: str = './outputs')

ベースクラス: object

backup(targets: List[str], compression: Literal['zip'] = 'zip')

バックアップファイルを作成する。 :param targets: バックアップ対象のファイルまたはディレクトリのリスト。 :param compression: 圧縮形式。zipのみサポート。

サンプル

`python tracer.backup(targets=["some_script.py", "some_function.py", "some_module.py"], compression="zip") `

describe(description: str = '', file_name: str = 'README.md')

トレースディレクトリにREADME.mdファイルを作成し、descriptionを保存する。 :param description: トレースの説明。 :param file_name: README.mdファイルの名前。デフォルトはREADME.md。

サンプル

`python tracer.describe(description="Some description of the trace", file_name="DESC.md") `

save(value: Any, file_name: str)

値をファイルに保存する。 :param value: 保存する値。 :param file_name: 保存するファイルの名前。

サンプル

`python tracer.save(value="Some value", file_name="some_value.txt") `