Directory Tree

Paket Pohon Direktori

Tentang

Ingin menampilkan proyek Anda / direktori kerja saat ini sebagai pohon yang rapi? Jangan khawatir!

Directory Tree adalah paket utilitas Python sederhana yang menampilkan struktur pohon direktori yang ditentukan pengguna.

Saat ini tersedia untuk semua platform.

Instalasi

Jalankan perintah berikut di terminal Anda untuk menginstal directory_tree :

1. Menginstal paket menggunakan pip :

pip install directory_tree

ATAU

pip3 install directory_tree

2. Mengkloning repositori:

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

Anda dapat menggunakan salah satu metode di atas untuk menginstal directory_tree .

Penggunaan

Tanda Tangan Fungsi

 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 ]:

Deskripsi Argumen

Parameter	Parameter CLI	Keterangan
Dirpath	directory	Jalur operasi akar. Secara default, mengacu pada direktori kerja saat ini.
StringRep	N/a	Bendera boolean untuk output konsol langsung atau pengembalian string yang sama. Secara default, itu memberikan output konsol.
header	--header	Bendera Boolean untuk menampilkan info [OS & Directory Path] di konsol. Tidak berlaku jika stringRep=True .
MaxDepth	-L , --max-depth	Kedalaman maksimal pohon direktori. Secara default, itu naik ke direktori/file terdalam.
Tampik	-a , --show-hidden	Bendera boolean untuk mengembalikan/menampilkan file/direktori tersembunyi jika nilai diatur ke True .
DISTERLIST	-I , --ignore-list	Daftar nama file dan direktori atau pola yang harus diabaikan.
Onlyfiles	-f , --only-files	Bendera boolean hanya untuk menampilkan file
OnlyDirs	-d , --only-dirs	Bendera boolean hanya untuk menampilkan direktori
sortby	--sort-by	Pesanan penyortiran. Opsi yang mungkin: 0 - Default, 1 - File Pertama, 2 - Direktori Pertama
Raiseexception	--raise-exception	Bendera Boolean untuk mengumpulkan pengecualian. Secara default, itu tidak meningkatkan pengecualian
Printerrortraceback	--print-error-traceback	Bendera Boolean untuk mencetak Traceback kesalahan. Secara default, itu tidak mencetak Traceback kesalahan

Baris perintah

1. Memperlakukan direktori yang dikloning sebagai yang dapat dieksekusi -
   (Bekerja jika Anda telah mengkloning hak istimewa tetapi tidak dari instalasi. Anda dapat mengkloning repo, pergi ke root dan jalankan di bawah)

python directory_tree

ATAU

python -m directory_tree

Gunakan bantuan inline untuk opsi baris perintah:

 python directory_tree --help

2. Memperlakukan paket sebagai modul -
   (Anda perlu menginstal ( pip ) paket Python di sistem Anda agar di bawah ini berfungsi)

directory_tree

Gunakan bantuan inline untuk opsi baris perintah:

directory_tree --help

Dalam kode

Contoh skrip untuk mencetak struktur pohon directoryPath yang ditentukan pengguna!

 # Importing Libraries
from directory_tree import DisplayTree

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

• Di sini secara default, directoryPath adalah direktori kerja saat ini (CWD) kecuali ditentukan oleh pengguna.

Contoh output

Contoh Pohon Direktori -

CATATAN - Di sini, letseee.txt (file) dan Directory 4/ (direktori) tersembunyi di alam.

1. Untuk direktori kerja saat ini dengan argumen [header info = False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. Untuk direktori yang ditentukan pengguna dengan argumen [representasi string = True , tunjukkan entitas tersembunyi = 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. Untuk direktori kerja saat ini dengan argumen [kedalaman maks = 2 ]

 from directory_tree import DisplayTree

DisplayTree ( maxDepth = 2 )

Mengembangkan Directory Tree

Untuk menginstal directory_tree , bersama dengan alat yang Anda butuhkan untuk mengembangkan dan menjalankan tes, gunakan salah satu perintah berikut di VirtualEnv Anda:

pip install -e .[dev]

ATAU

pip install -e " .[dev] " 

Pemberitahuan Deprecation

Fungsi display_tree sudah usang dan akan dihapus dalam rilis mendatang. Harap gunakan DisplayTree sebagai gantinya. Tanggal akhir kehidupan untuk display_tree adalah 31 Desember 2024 .

Tabel pemetaan parameter -

Parameter baru	Parameter yang sudah usang
Dirpath	dir_path
StringRep	string_rep
MaxDepth	MAX_DEPTH
Tampik	show_hidden
DISTERLIST	abaikan_list
Onlyfiles	Only_files
OnlyDirs	Only_dirs
sortby	sort_by
Raiseexception	raise_exception
Printerrortraceback	print_error_traceback

Bug Keamanan & Kemungkinan

• Directory Tree menggunakan rekursi. Ini akan meningkatkan RecursionError pada pohon -pohon direktori yang sangat dalam.
• Karena pohon dievaluasi dengan malas, ia harus berperilaku baik di pohon -pohon direktori yang sangat luas. Namun, anak -anak langsung dari direktori yang diberikan tidak dievaluasi dengan malas. Itu akan diminta hingga yang terakhir.
• Jika Anda seorang pengguna Windows, selalu disarankan untuk menggunakan \ alih -alih di alamat karena menggunakan mungkin menangkap urutan pelarian dan merusak string alamat.

Hubungi Penulis

Nama: Rahul Bordoloi
Situs web: https://rahulbordoloi.me
Email: [email protected]

Dibuat dengan ♥ di Python!