Directory Tree

Verzeichnisbaumpaket

Um

Möchten Sie Ihr Projekt- / aktuelles Arbeitsverzeichnis als ordentlichen Baum anzeigen? Keine Sorge!

Directory Tree ist ein einfaches Python -Dienstprogrammpaket, das die Baumstruktur eines benutzerdefinierten Verzeichnisses zeigt.

Derzeit für alle Plattformen verfügbar.

Installation

Führen Sie den folgenden Befehl in Ihrem Terminal aus, um directory_tree zu installieren:

1. Installieren des Pakets mit pip :

pip install directory_tree

ODER

pip3 install directory_tree

2. Klonen des Repositorys:

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

Sie können eine der oben genannten Methoden verwenden, um directory_tree zu installieren.

Verwendung

Funktionssignatur

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

Argumente Beschreibung

Parameter	CLI -Parameter	Beschreibung
Dickpath	directory	Wurzelweg der Operation. Bezieht sich standardmäßig auf das aktuelle Arbeitsverzeichnis.
StringRep	N / A	Boolean Flag für die direkte Konsolenausgabe oder eine String -Rückgabe derselben. Standardmäßig gibt es die Konsolenausgabe aus.
Kopfball	--header	Boolesche Flagge zum Anzeigen von [OS & Directory Path] Infos in der Konsole. Nicht anwendbar, wenn stringRep=True .
Maxdepth	-L , --max-depth	Maximale Tiefe des Verzeichnisbaums. Standardmäßig geht es auf das tiefste Verzeichnis/die tiefste Datei.
Showhidden	-a , --show-hidden	Boolean Flag zum Rücksenden/Anzeigen versteckter Dateien/Verzeichnisse, wenn der Wert auf True festgelegt wird.
Ignorelist	-I , --ignore-list	Liste der zu ignorierenden Datei- und Verzeichnisnamen oder Muster.
Nur Dateien	-f , --only-files	Boolesche Flag, um nur Dateien anzuzeigen
Nur Dirs	-d , --only-dirs	Boolesche Flagge, um nur Verzeichnisse anzuzeigen
Sortby	--sort-by	Sortierreihenfolge. Mögliche Optionen: 0 - Standard, 1 - Dateien zuerst, 2 - Verzeichnisse zuerst
Raisexception	--raise-exception	Boolesche Flagge, um Ausnahme zu erhöhen. Standardmäßig erhöht es keine Ausnahme
PrinterrorTraceBack	--print-error-traceback	Boolean Flag zum Druckfehlerverzeichnis. Standardmäßig druckt es keinen Fehler Traceback aus

Befehlszeile

1. Behandlung des geklonten Verzeichnisses als ausführbar -
   (Funktioniert, wenn Sie Privilegien klonen, aber nicht der Installation. Sie können das Repo klonen, zu seiner Wurzel gehen und die unten ausführen)

python directory_tree

ODER

python -m directory_tree

Verwenden Sie die Inline-Hilfe für Befehlszeilenoptionen:

 python directory_tree --help

2. Behandeln Sie das Paket als Modul -
   (Sie müssten ( pip ) das Python -Paket in Ihrem System installieren, damit die unten funktioniert.)

directory_tree

Verwenden Sie die Inline-Hilfe für Befehlszeilenoptionen:

directory_tree --help

Im Code

Beispielskript zum Ausdrucken der Baumstruktur eines benutzerdefinierten directoryPath !

 # Importing Libraries
from directory_tree import DisplayTree

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

• Hier ist der directoryPath standardmäßig das aktuelle Arbeitsverzeichnis (CWD), sofern vom Benutzer nicht angegeben.

Ausgangsbeispiele

Probenverzeichnisbaum -

Hinweis - Hier sind letseee.txt (Datei) und Directory 4/ (Verzeichnis) in der Natur versteckt .

1. Für das aktuelle Arbeitsverzeichnis mit Argument [Header Info = False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. Für den von dem Benutzer angegebenen Verzeichnis mit Argumenten [String Repräsentation = True , zeigen Sie versteckte Entitäten = 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. Für das aktuelle Arbeitsverzeichnis mit Argument [maxe Tiefe = 2 ]

 from directory_tree import DisplayTree

DisplayTree ( maxDepth = 2 )

Directory Tree entwickeln

Um directory_tree zu installieren, verwenden Sie zusammen mit den Tools, die Sie für die Entwicklung und Ausführung von Tests benötigen, eine der folgenden Befehle in Ihrem Virtualenv:

pip install -e .[dev]

ODER

pip install -e " .[dev] " 

Bekanntmachung von Abwertung

Die Funktion display_tree ist veraltet und wird in einer zukünftigen Version entfernt. Bitte verwenden Sie stattdessen DisplayTree . Das Datum am Lebensende für display_tree ist der 31. Dezember 2024 .

Parameter Mapping -Tabelle -

Neue Parameter	Veraltete Parameter
Dickpath	Dir_Path
StringRep	String_rep
Maxdepth	max_depth
Showhidden	show_hidden
Ignorelist	Ignore_List
Nur Dateien	nur_files
Nur Dirs	nur_dirs
Sortby	sort_by
Raisexception	Raise_Exception
PrinterrorTraceBack	print_error_traceback

Sicherheit & wahrscheinliche Fehler

• Directory Tree verwendet Rekursion. Es wird einen RecursionError auf wirklich tiefen Verzeichnisbäumen erhöhen.
• Wenn der Baum faul bewertet wird, sollte er sich auf wirklich breiten Verzeichnisbäumen gut verhalten. Sofortige Kinder eines bestimmten Verzeichnisses werden jedoch nicht faul bewertet. Es würde zum letzten aufgefordert werden.
• Wenn Sie ein Windows -Benutzer sind, wird immer empfohlen \ anstelle von in der Adresse zu verwenden, wie Mai -Escape Escape -Sequenzen zu verwenden und die Adresszeichenfolge zu beschädigen.

Wenden Sie sich an Autor

Name: Rahul Bordoloi
Website: https://rahulbordoloi.me
E -Mail: [email protected]

Hergestellt mit ♥ in Python!