Directory Tree

Pacote de árvore de diretório

Sobre

Deseja exibir seu diretório de trabalho do projeto / atual como uma árvore elegante? Sem problemas!

Directory Tree é um pacote simples de utilitário python que exibe a estrutura da árvore de um diretório definido pelo usuário.

Atualmente disponível para todas as plataformas.

Instalação

Execute o seguinte comando no seu terminal para instalar directory_tree :

1. Instalando o pacote usando pip :

pip install directory_tree

OU

pip3 install directory_tree

2. Clonando o repositório:

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

Você pode usar qualquer um dos métodos acima para instalar directory_tree .

Uso

Assinatura da função

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

Descrição dos argumentos

Parâmetros	Parâmetros da CLI	Descrição
Dirpath	directory	Caminho da operação raiz. Por padrão, refere -se ao diretório de trabalho atual.
StringRep	N / D	Bandeira booleana para saída direta do console ou um retorno da string do mesmo. Por padrão, ele fornece saída do console.
cabeçalho	--header	Bandeira booleana para exibir informações [SO e Directory Path] no console. Não aplicável se stringRep=True .
MaxDepth	-L , --max-depth	Profundidade máxima da árvore do diretório. Por padrão, ele subir no diretório/arquivo mais profundo.
exibido	-a , --show-hidden	Sinalizador booleano para retornar/exibir arquivos/diretórios ocultos se o valor definido como True .
ignorante	-I , --ignore-list	Lista de nomes ou padrões de arquivo e diretório a serem ignorados.
Somente arquivos	-f , --only-files	Bandeira booleana para exibir apenas arquivos
SOMEDDIRS	-d , --only-dirs	Bandeira booleana para exibir apenas diretórios
ordenar por	--sort-by	Ordem de classificação. Opções possíveis: 0 - Padrão, 1 - Arquivos Primeiro, 2 - Diretórios primeiro
Raisexception	--raise-exception	Bandeira booleana para aumentar a exceção. Por padrão, não levanta exceção
PrinterRortraceback	--print-error-traceback	Bandeira booleana para imprimir traceback de erro. Por padrão, ele não imprime o Traceback de erro

Linha de comando

1. Tratar o diretório clonado como executável -
   (Funciona se você tiver privilégios de clonagem, mas não de instalação. Você pode clonar o repositório, vá para sua raiz e execute o abaixo)

python directory_tree

OU

python -m directory_tree

Use a ajuda embutida para opções de linha de comando:

 python directory_tree --help

2. Tratando o pacote como módulo -
   (Você precisaria instalar ( pip ) o pacote Python em seu sistema para que o abaixo funcione)

directory_tree

Use a ajuda embutida para opções de linha de comando:

directory_tree --help

No código

Exemplo de script para imprimir a estrutura da árvore de um directoryPath diretório definido pelo usuário!

 # Importing Libraries
from directory_tree import DisplayTree

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

• Aqui, por padrão, o directoryPath é o diretório de trabalho atual (CWD), a menos que especificado pelo usuário.

Exemplos de saída

Diretório de amostra - árvore -

NOTA - Aqui, letseee.txt (arquivo) e Directory 4/ (diretório) estão ocultos na natureza.

1. Para o diretório de trabalho atual com argumento [Informações do cabeçalho = False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. Para o diretório especificado pelo usuário com argumentos [representação da string = True , mostre 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 o diretório de trabalho atual com argumento [profundidade máxima = 2 ]

 from directory_tree import DisplayTree

DisplayTree ( maxDepth = 2 )

Desenvolvendo Directory Tree

Para instalar directory_tree , juntamente com as ferramentas que você precisa desenvolver e executar testes, use qualquer um dos seguintes comandos em seu VirtualEnv:

pip install -e .[dev]

OU

pip install -e " .[dev] " 

Aviso de depreciação

A função display_tree é descontinuada e será removida em uma versão futura. Por favor, use DisplayTree . A data de final de vida para display_tree é 31 de dezembro de 2024 .

Tabela de mapeamento de parâmetros -

Novos parâmetros	Parâmetros descontinuados
Dirpath	DIR_PATH
StringRep	string_rep
MaxDepth	max_depth
exibido	show_hidden
ignorante	ignore_list
Somente arquivos	somente_files
SOMEDDIRS	somente_dirs
ordenar por	ordenar por
Raisexception	Raise_Exception
PrinterRortraceback	print_error_traceback

Segurança e bugs prováveis

• Directory Tree usa recursão. Ele aumentará um RecursionError em árvores de diretório realmente profundas.
• Como a árvore é preguiçosamente avaliada, ela deve se comportar bem em árvores de diretório realmente amplo. Os filhos imediatos de um determinado diretório não são avaliados preguiçosamente. Seria solicitado ao último.
• Se você é um usuário do Windows, ele sempre é aconselhado a usar \ em vez de no endereço como o uso de pode capturar sequências de escape e corromper a sequência de endereço.

Autor de contato

Nome: Rahul Bordoloi
Site: https://rahulbordoloi.me
E -mail: [email protected]

Feito com ♥ em Python!