tagged_directory

外部参照用のモジュール

class tagged_directory.TaggedDirectory(path: str | Path, *, json_filename: str = 'tagudu.json', result_directory_name: str = 'tagudu_result')

ディレクトリ内のファイルに対してタグ管理するためのクラス

path

対象ディレクトリのパス

Type:

pathlib.Path

json_path

jsonファイルのパス

Type:

pathlib.Path

result_path

フィルター結果フォルダのパス

Type:

pathlib.Path

data

タグのデータ。キーがファイル名で、値がタグのリスト

Type:

dict[str, list[str]]

autoremove()

タグが付けられているが実在しないファイルを削除

count_tags(search_word: str = '') → dict[str, int]

タグ数を集計

パラメータ:

search_word (str, optional) -- 検索ワード

戻り値:

集計結果

戻り値の型:

dict[str, int]

filter_by_partial_tags(tags: list[str], *, file_operation: bool = True) → list[str]

部分一致のタグによりファイルを絞り込み

パラメータ:

• tags (list[str]) -- タグのリスト

• file_operation (bool) -- 絞り込み結果を結果ディレクトリに反映させるか。初期値は「True」

戻り値:

絞り込み結果

戻り値の型:

list[str]

filter_by_regular_expression(pattern: str, *, file_operation: bool = True) → list[str]

正規表現によりファイルを絞り込み

パラメータ:

• pattern (str) -- 正規表現

• file_operation (bool) -- 絞り込み結果を結果ディレクトリに反映させるか。初期値は「True」

戻り値:

絞り込み結果

戻り値の型:

list[str]

filter_by_tags(tags: list[str], *, mode: str = 'or', file_operation: bool = True) → list[str]

完全一致のタグによりファイルを絞り込み

パラメータ:

• tags (list[str]) -- タグのリスト

• mode (str, optional) -- 絞り込みモード。「or」か「and」。初期値は「or」

• file_operation (bool) -- 絞り込み結果を結果ディレクトリに反映させるか。初期値は「True」

戻り値:

絞り込み結果

戻り値の型:

list[str]

get_existing_file_list() → list[str]

タグ付け可能な実在するファイルのリストを取得

戻り値:

ファイルのリスト

戻り値の型:

list[str]

get_file_list() → list[str]

タグがつけられているファイルのリストを取得

戻り値:

ファイルのリスト

戻り値の型:

list[str]

get_nonexisting_file_list() → list[str]

タグが付けられているが実在しないファイルのリストを取得

戻り値:

ファイルのリスト

戻り値の型:

list[str]

get_tag_list(filename: str) → list[str]

ファイルに設定されているタグのリストを取得

パラメータ:

filename (str) -- ファイル名

戻り値:

タグのリスト

戻り値の型:

list[str]

get_unregistered_file_list() → list[str]

タグがつけられていないファイルのリストを取得

戻り値:

ファイルのリスト

戻り値の型:

list[str]

remove_all_tags(filename: str)

ファイルからすべてのタグを解除

パラメータ:

filename (str) -- ファイル名

remove_tags(filename: str, tags: list[str])

ファイルからタグを解除

パラメータ:

• filename (str) -- ファイル名

• tags (list[str]) -- タグのリスト

reset_directory_structure()

ディレクトリ内のファイルの配置をリセットする

save_json()

jsonファイルにデータを書き込む

set_tags(filename: str, tags: list[str])

ファイルに対してタグを設定

パラメータ:

• filename (str) -- ファイル名。未登録のものも指定可

• tags (list[str]) -- タグのリスト。設定済みのものも指定可