otsutil

よく使う関数やクラスを纏めたライブラリです。

このライブラリは以下の環境で作成・最適化されています。 Windows10/11, Python 3.12.0+

インストール

インストール pip install otsutil

アップデート pip install -U otsutil

アンインストール pip uninstall otsutil

モジュール

以下のモジュールが存在します。

モジュール名	概要
cfg	定数
classes	スレッドセーフなコンテナやタイマーなどのクラス定義
exceptions	例外
funcs	ファイル操作や型判定などの便利な関数定義
types	パッケージ全体で共通利用する型ヒント・ジェネリクス共通定義

cfgモジュール

cfgモジュールでは以下の定数が定義されています。

定数名	概要
JST	日本のタイムゾーン。

classesモジュール

classesモジュールでは以下のクラスが定義されています。

名称	概要
LockableDict	要素の操作時に `threading.RLock` を使用するスレッドセーフな `dict` クラス。 `with obj:` 構文によるコンテキストマネージャに対応し、複数の操作をアトミックに実行可能です。
LockableList	要素の操作時に `threading.RLock` を使用するスレッドセーフな `list` クラス。 `with obj:` 構文によるコンテキストマネージャに対応し、複数の操作をアトミックに実行可能です。
ObjectStore	オブジェクトを `pickle` + `base64` でシリアライズし、ファイルに永続化・管理するクラス。カスタムクラスを保存する場合、そのクラスに `__reduce__` を実装することでリスト内の要素なども含め高度な変換・復元が可能です。
OtsuNone / OtsuNoneType	`None` を返す可能性のある辞書の `get` デフォルト値などに使用するセンチネルオブジェクト。 `bool()` 判定では `False` を返します。
Timer	指定時間の経過判定および待機を行うタイマー。同期的なブロック待機 (`join`) に加え、`asyncio` による非同期待機 (`ajoin`) をサポート。 `for` / `async for` 文で残り時間を `yield` しながら処理を行うイテレータ機能を持ちます。

注意事項・仕様

LockableDict / LockableListのスレッドセーフティ保証範囲

アトミック性の対象: 各々のメソッド呼び出し（append, get, pop等）およびwith obj:ブロック内で行う操作がRLockにより保護されます。
保証対象外:
- with obj:はロック保持範囲を定義するものであり、処理失敗時の自動ロールバック（トランザクション機能）を提供するものではありません。
- コンテナから取り出したミュータブルなオブジェクト（例: dictの値として格納されたlist等）に対する直接変更操作は、コンテナのロック範囲外となります。

ObjectStoreのセキュリティモデル

pickleの性質: ObjectStoreは内部でpickleを使用しています。信頼できない第三者が作成・変更したファイルを読み込むと任意コード実行のリスクが存在します。
使用上の注意: 信頼できるローカルデータや自身が作成したデータの保存・復元用途に限定してご使用ください。外部ネットワーク経由で受信したデータなどの読み込みには利用しないでください。

Timerの待機・インターバル挙動

join / ajoin: span_seconds <= 0の場合は一括スリープ処理を行い、span_seconds > 0の場合はビジーループ防止のため、最小インターバル（0.001秒）を設けてポーリングを行います。
wiggle_join / awiggle_join: 残り時間のyield間隔は最小0.001秒に補正され、ビジーループを防ぎます。

exceptionsモジュール

exceptionsモジュールでは以下の例外が定義されています。

例外名	概要
PathError	パスに関連する例外の基底クラス
PathTypeError	パスの形式や型に関連するエラー（`PathError`を継承）
ObjectStoreError	ObjectStore関連処理で発生する基底例外クラス
ObjectStoreSaveError	オブジェクトの保存に失敗した際に送出される例外（`ObjectStoreError`を継承）
ObjectStoreLoadError	オブジェクトの読み込みに失敗した際に送出される例外（`ObjectStoreError`を継承）

funcsモジュール

funcsモジュールでは以下の関数が定義されています。

関数名	概要
deduplicate	シーケンスから重複を取り除き、順序を保持したまま元の型（`list`/`tuple`）で返す。
get_sub_paths	ディレクトリ内を探索し、ワイルドカードや拡張子による高度なフィルタリングを適用して子パスを一覧取得する。
is_all_type	反復可能オブジェクトの全ての要素が、指定した型であるか判定する。
is_dict_key_type	`dict[K, Any]`か検証する。
is_dict_type	`dict[K, V]`か検証する。
is_dict_value_type	`dict[K, V]`か検証する。
is_type	オブジェクトが指定した型であるか判定する（`None` 許容判定などを含む）。
iter_sub_paths	`get_sub_paths`のイテレータ版。
load_json	`JSON` ファイルを読み込む。親ディレクトリがない場合は作成し、ファイルがない場合はデフォルト値を返します。
read_lines	ファイルを1行ずつ読み出すジェネレータ。改行コードの自動除去やエンコーディング指定が可能です。
same_path	パス群が（相対/絶対に関わらず）物理的に同じ場所を指しているか判定する。
save_json	オブジェクトを `JSON` 形式で保存する。
setup_path	パスを `Path` オブジェクトとして整備し、必要に応じて親ディレクトリを生成して利用可能な状態にする。
str_to_path	文字列を `pathlib.Path` に変換する。
write_lines	反復可能な文字列データを1行ずつファイルに書き出す。

typesモジュール

typesモジュールでは、Python 3.12 のジェネリクス構文に対応した以下の型定義がされています。

名称	概要
ExpectType[T]	`isinstance(obj, ExpectType)`で使用できる型。
FloatInt	`float` または `int` に限定した数値型。
HMSTuple	`(時, 分, 秒)` のタプル。型は `(int, int, float)`。
OptPath	`pathlib.Path` または`None`
OptStr	`str` または`None`。
OptStrPath	`pathlib.Path`または`str`または`None`。
StrPath	`pathlib.Path` または `str`。

Metadata

Release files for otsutil 1.3.12.312

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for otsutil 1.3.12.312
File	Size	Uploaded
otsutil-1.3.12.312.tar.gz	21.1 kB	Oct 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for otsutil 1.3.12.312
File	Interpreter	ABI	Platform	Reset
otsutil-1.3.12.312-py3-none-any.whl 16.8 kB Oct 1, 2026	Python 3	none	any	Details

Total release size: 37.9 kB

Release files / otsutil-1.3.12.312.tar.gz

Download URL	otsutil-1.3.12.312.tar.gz
Size	21.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`b882056db7d8f1a68fb9707cd1bc800553dcf1e3a6146370cde79e0a6d17a55e`
BLAKE2b-256 checksum How to use checksums	`c36b75c91bf0033214b9fac70fe782b8ce6dc4b765e11f20194b512a4f093913`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.15`

Release files / otsutil-1.3.12.312-py3-none-any.whl

Download URL	otsutil-1.3.12.312-py3-none-any.whl
Size	16.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3e17e0b182a41dbdd837019506d6356bc14b05166afe710bd3c37e5203aa3246`
BLAKE2b-256 checksum How to use checksums	`e35182b5df2cce4e18185f3952c53e4eda53ec4fa981875e42f1a1095df323b1`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.15`