Directory Tree

ディレクトリツリーパッケージ

について

プロジェクト /現在の作業ディレクトリをきちんとしたツリーとして表示したいですか？心配ない！

Directory Treeは、ユーザー定義ディレクトリのツリー構造を表示するシンプルなPythonユーティリティパッケージです。

現在、すべてのプラットフォームで利用可能です。

インストール

端末で次のコマンドを実行して、 directory_treeをインストールします。

1。 pipを使用してパッケージのインストール：

pip install directory_tree

または

pip3 install directory_tree

2。リポジトリのクローニング：

git clone https://github.com/rahulbordoloi/Directory-Tree/
cd Directory-Tree
pip install -e .

上記の方法のいずれかを使用して、 directory_treeをインストールできます。

使用法

関数の署名

 DisplayTree (
    dirPath : str = '' ,
    stringRep : bool = False ,
    header : bool = False ,
    maxDepth : float = float ( 'inf' ),
    showHidden : bool = False ,
    ignoreList : List [ str ] = None ,
    onlyFiles : bool = False ,
    onlyDirs : bool = False ,
    sortBy : int = 0
) - > Union [ str , None ]:

引数の説明

パラメーター	CLIパラメーター	説明
dirpath	directory	操作のルートパス。デフォルトでは、現在の作業ディレクトリを参照してください。
stringrep	n/a	直接コンソール出力またはその弦の返品用のブールフラグ。デフォルトでは、コンソール出力を提供します。
ヘッダ	--header	コンソールに[OS＆ディレクトリパス]情報を表示するためのブールフラグ。 stringRep=Trueの場合は該当しません。
MaxDepth	-L 、 --max-depth	ディレクトリツリーの最大深さ。デフォルトでは、最も深いディレクトリ/ファイルになります。
showhidden	-a 、 --show-hidden	価値に設定Trueれている場合、非表示ファイル/ディレクトリを返す/表示するためのブールフラグ。
無知	-I 、 --ignore-list	無視するファイルおよびディレクトリ名またはパターンのリスト。
唯一のファイル	-f 、 --only-files	ブールフラグはファイルのみを表示します
onlydirs	-d 、 --only-dirs	ディレクトリのみを表示するブールフラグ
並べ替え	--sort-by	並べ替え順序。可能なオプション：0-デフォルト、1-最初のファイル、2-ディレクトリファースト
RaiseException	--raise-exception	例外を提起するためのブールフラグ。デフォルトでは、例外を提起するわけではありません
PrinterRortraceback	--print-error-traceback	エラートレースバックを印刷するためのブールフラグ。デフォルトでは、エラートレースバックを印刷しません

コマンドライン

1. クローン化されたディレクトリを実行可能ファイルとして扱う-
   （特権をクローニングしているが、インストールではない場合は機能します。リポジトリをクリックして、そのルートに移動して、以下を実行できます）

python directory_tree

または

python -m directory_tree

コマンドラインオプションにはインラインヘルプを使用します。

 python directory_tree --help

2. パッケージをモジュールとして扱う-
   （以下が機能するために、システムにPythonパッケージをインストール（ pip ）する必要があります）

directory_tree

コマンドラインオプションにはインラインヘルプを使用します。

directory_tree --help

コードで

ユーザー定義のDirectory directoryPathのツリー構造を印刷するためのスクリプトの例！

 # Importing Libraries
from directory_tree import DisplayTree

# Main Method
if __name__ == '__main__' :
    DisplayTree ( directoryPath )

• ここでは、デフォルトでは、ユーザーが指定しない限り、 directoryPathは現在の作業ディレクトリ（CWD）です。

出力の例

サンプルディレクトリツリー -

注 - ここでは、 letseee.txt （ファイル）とDirectory 4/ （ディレクトリ）が本質的に隠されています。

1. 引数を持つ現在の作業ディレクトリの場合[ヘッダー情報= False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. 引数があるユーザー指定ディレクトリの場合[文字列表現= True 、show hidden entities = True ]

 from directory_tree import DisplayTree

customPath : str = 'Users/rahulbordoloi/Work/Python Packages Maintainence/Directory-Tree/Test/Main Directory'
stringRepresentation : str = DisplayTree ( customPath , stringRep = True , showHidden = True )
print ( stringRepresentation )

3. 引数を持つ現在の作業ディレクトリの場合[最大深さ= 2 ]

 from directory_tree import DisplayTree

DisplayTree ( maxDepth = 2 )

Directory Treeの開発

directory_treeをインストールするには、テストを開発および実行するために必要なツールとともに、Virtualenvで次のコマンドのいずれかを使用します。

pip install -e .[dev]

または

pip install -e " .[dev] " 

非推奨通知

display_tree関数は非推奨であり、将来のリリースで削除されます。代わりにDisplayTreeを使用してください。 display_treeの終了日は2024年12月31日です。

パラメーターマッピングテーブル-

新しいパラメーター	非推奨パラメーター
dirpath	dir_path
stringrep	string_rep
MaxDepth	max_depth
showhidden	show_hidden
無知	Ingrore_list
唯一のファイル	only_files
onlydirs	only_dirs
並べ替え	並べ替え
RaiseException	Raise_exception
PrinterRortraceback	print_error_traceback

セキュリティと可能性のあるバグ

• Directory Tree再帰を使用します。本当に深いディレクトリツリーでRecursionErrorを上げます。
• ツリーが怠lazに評価されているため、非常に広いディレクトリツリーでうまく動作するはずです。ただし、特定のディレクトリの直接の子供はゆっくりと評価されていません。それは最後に促されるでしょう。
• Windowsユーザーの場合は、を使用しての代わりに\使用してを使用して、逃げ出しのシーケンスを使用してアドレス文字列を破損することをお勧めします。

著者に連絡してください

名前： Rahul Bordoloi
ウェブサイト：https：//rahulbordoloi.me
メール：[email protected]

Pythonで♥で作られています！