Directory Tree

Paquete de árbol de directorio

Acerca de

¿Desea mostrar su proyecto / directorio de trabajo actual como un árbol ordenado? ¡No hay problema!

Directory Tree es un simple paquete de utilidad de Python que muestra la estructura del árbol de un directorio definido por el usuario.

Actualmente disponible para todas las plataformas.

Instalación

Ejecute el siguiente comando en su terminal para instalar directory_tree :

1. Instalación del paquete con pip :

pip install directory_tree

O

pip3 install directory_tree

2. Clonación del repositorio:

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

Puede usar cualquiera de los métodos anteriores para instalar directory_tree .

Uso

Firma de función

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

Descripción de los argumentos

Parámetros	Parámetros CLI	Descripción
dirpath	directory	Ruta de la raíz de operación. Por defecto, se refiere al directorio de trabajo actual.
StringRep	N / A	Bandera booleana para la salida de consola directa o una devolución de cadena de la misma. Por defecto, da salida de consola.
encabezamiento	--header	Flagal booleano para mostrar información [ruta de directorio y directorio] en la consola. No aplicable si stringRep=True .
maxdeph	-L , --max-depth	Profundidad máxima del árbol de directorio. Por defecto, sube al directorio/archivo más profundo.
showhidden	-a , --show-hidden	BOOLEAN BLACK para devolver/mostrar archivos/directorios ocultos si el valor se establece en True .
ignorante	-I , --ignore-list	Lista de nombres o patrones de archivos y directorio para ignorar.
Onlyfiles	-f , --only-files	Bandera booleana para mostrar solo archivos
solo dirs	-d , --only-dirs	Bandera booleana para mostrar solo directorios
Ordenar por	--sort-by	Orden de clasificación. Opciones posibles: 0 - predeterminado, 1 - archivos primero, 2 - directorios primero
RaiseException	--raise-exception	Bandera booleana para elevar la excepción. Por defecto, no recauda la excepción
imprinterraceback	--print-error-traceback	Bandera booleana para imprimir traza de error. De forma predeterminada, no imprime el rastreo de errores

Línea de comando

1. Tratar el directorio clonado como ejecutable -
   (Funciona si tiene privilegios de clonación pero no de instalación. Puede clonar el repositorio, ir a su raíz y ejecutar lo siguiente)

python directory_tree

O

python -m directory_tree

Use la ayuda en línea para las opciones de línea de comandos:

 python directory_tree --help

2. Tratar el paquete como módulo -
   (Debería instalar ( pip ) el paquete Python en su sistema para que el siguiente funcione)

directory_tree

Use la ayuda en línea para las opciones de línea de comandos:

directory_tree --help

En el código

¡Ejemplo de script para imprimir la estructura de árbol de un directoryPath de directorio definido por el usuario, Path!

 # Importing Libraries
from directory_tree import DisplayTree

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

• Aquí de forma predeterminada, el directoryPath es el directorio de trabajo actual (CWD) a menos que el usuario especifique.

Ejemplos de salida

Árbol de directorio de muestra -

Nota: aquí, letseee.txt (archivo) y Directory 4/ (directorio) están ocultos en naturaleza.

1. Para el directorio de trabajo actual con argumento [encabezado info = False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. Para el directorio especificado por el usuario con argumentos [representante de cadena = True , muestre entidades ocultas = 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. Para el directorio de trabajo actual con argumento [profundidad máxima = 2 ]

 from directory_tree import DisplayTree

DisplayTree ( maxDepth = 2 )

Desarrollo Directory Tree

Para instalar directory_tree , junto con las herramientas que necesita para desarrollar y ejecutar pruebas, use cualquiera de los siguientes comandos en su VirtualEnv:

pip install -e .[dev]

O

pip install -e " .[dev] " 

Aviso de deprecación

La función display_tree está en desuso y se eliminará en una versión futura. Utilice DisplayTree en su lugar. La fecha de fin de vida para display_tree es el 31 de diciembre de 2024 .

Tabla de mapeo de parámetros -

Nuevos parámetros	Parámetros desactivados
dirpath	Dir_path
StringRep	string_rep
maxdeph	max_depth
showhidden	show_hidden
ignorante	ignorar_list
Onlyfiles	solo_files
solo dirs	solo_dirs
Ordenar por	Ordenar por
RaiseException	Raise_Exception
imprinterraceback	print_error_traceback

Seguridad y errores probables

• Directory Tree utiliza la recursión. Levantará un RecursionError en árboles de directorio realmente profundos.
• Como el árbol se evalúa perezosamente, debería comportarse bien en árboles de directorio realmente anchos. Sin embargo, los niños inmediatos de un directorio dado no se evalúan perezosamente. Se le pediría al último.
• Si es un usuario de Windows, siempre se recomienda usar \ en lugar de en la dirección, ya que usar podría acumular secuencias de escape y corromper la cadena de dirección.

Contactor del autor

Nombre: Rahul Bordoloi
Sitio web: https://rahulbordoloi.me
Correo electrónico: [email protected]

¡Hecho con ♥ en Python!