Directory Tree

Package d'arbre d'annuaire

À propos

Vous souhaitez afficher votre projet / répertoire de travail actuel comme un arbre soigné? Pas de soucis!

Directory Tree est un simple package d'utilité Python qui affiche la structure de l'arborescence d'un répertoire défini par l'utilisateur.

Actuellement disponible pour toutes les plateformes.

Installation

Exécutez la commande suivante sur votre terminal pour installer directory_tree :

1 et 1 Installation du package à l'aide de pip :

pip install directory_tree

OU

pip3 install directory_tree

2 Clonage du référentiel:

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

Vous pouvez utiliser l'une des méthodes ci-dessus pour installer directory_tree .

Usage

Signature de la fonction

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

Description des arguments

Paramètres	Paramètres CLI	Description
dirpath	directory	Chemin de fonctionnement racine. Par défaut, fait référence au répertoire de travail actuel.
stringrep	N / A	Indicateur booléen pour la sortie de la console directe ou un retour de chaîne de la même chose. Par défaut, il donne la sortie de la console.
tête	--header	Indicateur booléen pour afficher les informations [OS & Directory Path] dans la console. Non applicable si stringRep=True .
maxydepth	-L , --max-depth	Profondeur maximale de l'arbre d'annuaire. Par défaut, il monte jusqu'au répertoire / fichier le plus profond.
showhidden	-a , --show-hidden	Indicateur booléen pour le retour / affichage des fichiers / répertoires cachés si la valeur définit sur True .
ignoreliste	-I , --ignore-list	Liste des noms ou modèles de fichiers et de répertoires à ignorer.
unique	-f , --only-files	Flag booléen pour afficher uniquement les fichiers
OnlyDirs	-d , --only-dirs	Flag booléen pour afficher uniquement les répertoires
Trier par	--sort-by	Ordre de tri. Options possibles: 0 - par défaut, 1 - Fichiers d'abord, 2 - Répertoires d'abord
Raisiexception	--raise-exception	Flag booléen pour lever des exceptions. Par défaut, il ne soulève pas l'exception
priterrortraceback	--print-error-traceback	Flag booléen pour imprimer l'erreur Traceback. Par défaut, il n'imprime pas l'erreur Traceback

Ligne de commande

1. Traiter le répertoire cloné comme exécutable -
   (Fonctionne si vous avez des privilèges de clonage mais pas de l'installation. Vous pouvez cloner le repo, aller à sa racine et exécuter ce qui est ci-dessous)

python directory_tree

OU

python -m directory_tree

Utilisez l'aide en ligne pour les options de ligne de commande:

 python directory_tree --help

2. Traiter le package comme un module -
   (Vous devrez installer ( pip ) le package Python de votre système pour que ce ci-dessous fonctionne)

directory_tree

Utilisez l'aide en ligne pour les options de ligne de commande:

directory_tree --help

En code

Exemple de script pour imprimer la structure de l'arborescence d'un directoryPath défini par l'utilisateur!

 # Importing Libraries
from directory_tree import DisplayTree

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

• Ici, par défaut, le directoryPath est le répertoire de travail actuel (CWD) sauf si spécifié par l'utilisateur.

Exemples de sortie

Exemple d'arbre d'annuaire -

Remarque - Ici, letseee.txt (fichier) et Directory 4/ (répertoire) sont de nature cachée .

1. Pour le répertoire de travail actuel avec l'argument [En-tête info = False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. Pour le répertoire spécifié par l'utilisateur avec des arguments [String Représentation = True , affichez des entités cachées = 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. Pour le répertoire de travail actuel avec argument [max profondeur = 2 ]

 from directory_tree import DisplayTree

DisplayTree ( maxDepth = 2 )

Directory Tree en développement

Pour installer directory_tree , ainsi que les outils dont vous avez besoin pour développer et exécuter des tests, utilisez l'une des commandes suivantes dans votre VirtualEnv:

pip install -e .[dev]

OU

pip install -e " .[dev] " 

Avis de dépréciation

La fonction display_tree est obsolète et sera supprimée dans une version future. Veuillez utiliser DisplayTree à la place. La date de fin de vie de display_tree est le 31 décembre 2024 .

Tableau de cartographie des paramètres -

Nouveaux paramètres	Paramètres obsolètes
dirpath	dir_path
stringrep	string_rep
maxydepth	max_depth
showhidden	show_hidden
ignoreliste	ignorer_list
unique	seul_files
OnlyDirs	Only_Dirs
Trier par	Trier par
Raisiexception	race_exception
priterrortraceback	print_error_traceback

Bogues de sécurité et probable

• Directory Tree utilise la récursivité. Il augmentera une RecursionError sur des arbres d'annuaire vraiment profonds.
• Comme l'arbre est évalué paresseusement, il devrait se comporter bien sur des arbres d'annuaire très larges. Les enfants immédiats d'un répertoire donné ne sont cependant pas évalués paresseusement. Il serait invité à la dernière.
• Si vous êtes un utilisateur de Windows, il est toujours conseillé d'utiliser \ au lieu de dans l'adresse car utiliser pourrait rattraper des séquences d'échappement et corrompre la chaîne d'adresse.

Auteur de contact

Nom: Rahul Bordoloi
Site Web: https://rahulbordoloi.me
Courriel: [email protected]

Fait avec ♥ en python!