Path Kit¤

用來補充 python-fsutil 不足的路徑庫，使用方式應該是先看他有沒有再看我的。

path_kit ¤

FUNCTION	DESCRIPTION
`mkdir`	建立目錄，若已存在則跳過
`mv_dir`	安全移動目錄，若同名則自動重命名
`mv_file`	安全移動檔案，若同名則自動重命名
`is_system_file`	判斷檔案是否為系統檔案
`count_file`	計算目錄中檔案數量，可排除系統檔案
`resolve_abs_path`	解析相對路徑為絕對路徑
`gen_unique_path`	生成唯一路徑，使用二分法找可用名稱
`get_system_config_dir`	取得系統設定目錄
`get_file_dest`	組合路徑並清理非法字元
`get_ext`	從回應中取得檔案副檔名，若無法判斷則回傳預設值

mkdir ¤

mkdir(folder_path: strPath) -> None

建立目錄，若已存在則跳過

PARAMETER	DESCRIPTION
`folder_path`	目錄路徑 TYPE: `strPath`

RETURNS	DESCRIPTION
`None`	None

mv_dir ¤

mv_dir(source: strPath, destination: strPath, delimiter: str = '_') -> Path

安全移動目錄，若同名則自動重命名

PARAMETER	DESCRIPTION
`source`	來源目錄路徑 TYPE: `strPath`
`destination`	目標目錄路徑 TYPE: `strPath`
`delimiter`	當名稱衝突時的分隔符，預設為 '_' TYPE: `str` DEFAULT: `'_'`

RETURNS	DESCRIPTION
`Path`	移動後的目標目錄路徑 TYPE: `Path`

mv_file ¤

mv_file(source: strPath, destination: strPath, delimiter: str = '_') -> Path

安全移動檔案，若同名則自動重命名

PARAMETER	DESCRIPTION
`source`	來源檔案路徑 TYPE: `strPath`
`destination`	目標檔案路徑 TYPE: `strPath`
`delimiter`	當名稱衝突時的分隔符，預設為 '_' TYPE: `str` DEFAULT: `'_'`

RETURNS	DESCRIPTION
`Path`	移動後的目標檔案路徑 TYPE: `Path`

is_system_file ¤

is_system_file(file_path: strPath) -> bool

判斷檔案是否為系統檔案

PARAMETER	DESCRIPTION
`file_path`	檔案路徑 TYPE: `strPath`

RETURNS	DESCRIPTION
`bool`	是否為系統檔案 TYPE: `bool`

count_file ¤

count_file(folder_path: str, exclude_system: bool = True) -> int

計算目錄中檔案數量，可排除系統檔案

PARAMETER	DESCRIPTION
`folder_path`	目錄路徑 TYPE: `str`
`exclude_system`	是否排除系統檔案，預設為 True TYPE: `bool` DEFAULT: `True`

RETURNS	DESCRIPTION
`int`	目錄中檔案數量 TYPE: `int`

resolve_abs_path ¤

resolve_abs_path(relative_path: str) -> Path

解析相對路徑為絕對路徑

解析相對路徑並擴展 ~ 為使用者主目錄

PARAMETER	DESCRIPTION
`relative_path`	相對路徑 TYPE: `str`

RETURNS	DESCRIPTION
`Path`	絕對路徑 TYPE: `Path`

Example

resolve_abs_path('~') -> /home/user resolve_abs_path('data/file.txt') -> /home/user/data/file.txt resolve_abs_path('/data/file.txt') -> /data/file.txt resolve_abs_path('~/data/file.txt') -> /home/user/data/file.txt

gen_unique_path ¤

gen_unique_path(path: strPath, delimiter: str = '_') -> Path

生成唯一路徑，使用二分法找可用名稱

PARAMETER	DESCRIPTION
`path`	路徑 TYPE: `strPath`
`delimiter`	當名稱衝突時的分隔符，預設為 '_' TYPE: `str` DEFAULT: `'_'`

RETURNS	DESCRIPTION
`Path`	唯一路徑 TYPE: `Path`

get_system_config_dir ¤

get_system_config_dir() -> Path

取得系統設定目錄

RETURNS	DESCRIPTION
`Path`	系統設定目錄路徑 TYPE: `Path`

get_file_dest ¤

get_file_dest(root: strPath, category: str, filename: str, ext: str = '') -> Path

組合路徑並清理非法字元

PARAMETER	DESCRIPTION
`root`	下載根目錄 TYPE: `strPath`
`category`	類別資料夾名稱 TYPE: `str`
`filename`	檔案名稱 TYPE: `str`
`ext`	檔案副檔名，預設為空 TYPE: `str` DEFAULT: `''`

RETURNS	DESCRIPTION
`Path`	完整的檔案路徑 TYPE: `Path`

get_ext ¤

get_ext(response: Response, default_ext: str = 'jpg') -> str

從回應中取得檔案副檔名，若無法判斷則回傳預設值

PARAMETER	DESCRIPTION
`response`	HTTP 回應物件 TYPE: `Response`
`default_ext`	預設副檔名，預設為 'jpg' TYPE: `str` DEFAULT: `'jpg'`

RETURNS	DESCRIPTION
`str`	檔案副檔名 TYPE: `str`