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	คำอธิบาย
ความสกปรก	directory	เส้นทางรูทของการทำงาน โดยค่าเริ่มต้นหมายถึงไดเรกทอรีการทำงานปัจจุบัน
stringrep	N/A	ธงบูลีนสำหรับเอาต์พุตคอนโซลโดยตรงหรือการส่งคืนสตริงของเดียวกัน โดยค่าเริ่มต้นจะให้เอาต์พุตคอนโซล
ส่วนหัว	--header	ธงบูลีนสำหรับการแสดงข้อมูล [OS & Directory Path] ในคอนโซล ไม่สามารถใช้ได้ถ้า stringRep=True
maxdepth	-L , --max-depth	ความลึกสูงสุดของต้นไม้ไดเรกทอรี โดยค่าเริ่มต้นจะไปถึงไดเรกทอรี/ไฟล์ที่ลึกที่สุด
ที่แสดงให้เห็น	-a , --show-hidden	ธงบูลีนสำหรับการส่งคืน/แสดงไฟล์/ไดเรกทอรีที่ซ่อนอยู่หากค่าตั้งค่าเป็น True
คนโง่เขลา	-I , --ignore-list	รายการไฟล์และชื่อไดเรกทอรีหรือรูปแบบที่จะละเว้น
ไฟล์เท่านั้น	-f , --only-files	ธงบูลีนเพื่อแสดงเฉพาะไฟล์
OnlyDirs	-d , --only-dirs	ธงบูลีนเพื่อแสดงไดเรกทอรีเท่านั้น
อย่างต่อเนื่อง	--sort-by	ลำดับการเรียงลำดับ ตัวเลือกที่เป็นไปได้: 0 - ค่าเริ่มต้น, 1 - ไฟล์แรก, 2 - ไดเรกทอรีแรก
RaiseException	--raise-exception	ธงบูลีนเพื่อเพิ่มข้อยกเว้น โดยค่าเริ่มต้นจะไม่ยกข้อยกเว้น
เครื่องพิมพ์	--print-error-traceback	ธงบูลีนเพื่อพิมพ์การติดตามข้อผิดพลาด โดยค่าเริ่มต้นจะไม่พิมพ์ข้อผิดพลาด

บรรทัดคำสั่ง

1. การรักษาไดเรกทอรีที่ถูกโคลนเป็นปฏิบัติการ -
   (ใช้งานได้หากคุณโคลนสิทธิ์ แต่ไม่ใช่การติดตั้งคุณสามารถโคลน repo ไปที่รูทและเรียกใช้ด้านล่าง)

python directory_tree

หรือ

python -m directory_tree

ใช้ตัวเลือกแบบอินไลน์สำหรับตัวเลือกบรรทัดคำสั่ง:

 python directory_tree --help

2. การปฏิบัติต่อแพ็คเกจเป็นโมดูล -
   (คุณจะต้องติดตั้ง ( pip ) แพ็คเกจ Python ในระบบของคุณเพื่อให้ด้านล่างทำงาน)

directory_tree

ใช้ตัวเลือกแบบอินไลน์สำหรับตัวเลือกบรรทัดคำสั่ง:

directory_tree --help

เป็นรหัส

ตัวอย่างสคริปต์เพื่อพิมพ์โครงสร้างต้นไม้ของ 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. สำหรับ ไดเรกทอรีที่ระบุผู้ใช้ที่ มีอาร์กิวเมนต์ [string retentation = True แสดง entities hidden = 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 คือ 31 ธันวาคม 2567

ตารางการแมปพารามิเตอร์ -

พารามิเตอร์ใหม่	พารามิเตอร์ที่เลิกใช้
ความสกปรก	dir_path
stringrep	String_rep
maxdepth	max_depth
ที่แสดงให้เห็น	show_hided
คนโง่เขลา	ละเว้น _list
ไฟล์เท่านั้น	only_files
OnlyDirs	only_dirs
อย่างต่อเนื่อง	sort_by
RaiseException	Raise_exception
เครื่องพิมพ์	print_error_traceback

ข้อบกพร่องด้านความปลอดภัยและน่าจะเป็น

• Directory Tree ใช้การเรียกซ้ำ มันจะเพิ่ม RecursionError บนต้นไม้ไดเรกทอรีที่ลึกจริงๆ
• เมื่อต้นไม้ได้รับการประเมินอย่างเกียจคร้านจึงควรประพฤติดีบนต้นไม้ไดเรกทอรีที่กว้างจริงๆ เด็กทันทีของไดเรกทอรีที่กำหนดนั้นไม่ได้รับการประเมินอย่างเกียจคร้าน มันจะได้รับการแจ้งให้เป็นครั้งสุดท้าย
• หากคุณเป็นผู้ใช้ Windows ขอแนะนำให้ใช้ \ แทน ในที่อยู่เสมอว่าใช้ อาจ catchup escape sequences และทำให้สตริงที่อยู่เสียหาย

ติดต่อผู้เขียน

ชื่อ: Rahul Bordoloi
เว็บไซต์: https://rahulbordoloi.me
อีเมล: [email protected]

ทำด้วย ♥ ใน Python!