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	Логический флаг для отображения информации [ОС и каталогов] в консоли. Не применимо, если stringRep=True .
Максдепт	-L , --max-depth	Максимальная глубина дерева каталогов. По умолчанию он идет в самый глубокий каталог/файл.
Showhidden	-a , --show-hidden	Логический флаг для возврата/отображения скрытых файлов/каталогов, если значение установлено в True .
Неуверенник	-I , --ignore-list	Список имен или шаблонов файлов и каталогов, чтобы игнорировать.
Только файлы	-f , --only-files	Логический флаг для отображения только файлов
Только диды	-d , --only-dirs	Логический флаг отображает только каталоги
Сортировать по	--sort-by	Порядок сортировки. Возможные параметры: 0 - по умолчанию, 1 - Files First, 2 - Сначала каталоги
raiseexception	--raise-exception	Логический флаг, чтобы поднять исключение. По умолчанию это не поднимает исключение
Printerrortraceback	--print-error-traceback	Логический флаг, чтобы распечатать ошибку Traceback. По умолчанию он не печатает ошибку Traceback

Командная строка

1. Обработка клонированного каталога как исполняемого -
   (Работает, если вы клонируете привилегии, но не установку. Вы можете клонировать репо, перейти к его корню и запустить ниже)

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. Для текущего рабочего каталога с аргументом [Header info = False ]

 from directory_tree import DisplayTree

DisplayTree ( header = True )

2. Для указанного пользовательского каталога с аргументами [String preventation = True , показать Hidden entities = 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 декабря 2024 года .

Таблица отображения параметров -

Новые параметры	Устаревшие параметры
Дирпат	dir_path
StringRep	string_rep
Максдепт	max_depth
Showhidden	show_hidden
Неуверенник	игнорировать
Только файлы	только_филс
Только диды	только_дирс
Сортировать по	Сортировать по
raiseexception	Raise_Exception
Printerrortraceback	print_error_traceback

Безопасность и вероятные ошибки

• Directory Tree использует рекурсию. Это поднимет RecursionError на действительно глубоких каталогах.
• Поскольку дерево лениво оценивается, оно должно вести себя хорошо на действительно широких деревьях каталогов. Однако непосредственные дети данного каталога не оцениваются лениво. Это будет предложено до последнего.
• Если вы пользователь Windows, всегда рекомендуется использовать \ вместо в адресе, так как использование может догнать последовательности побега и повредить строку адреса.

Контактный автор

Имя: Рахул Бордолой
Веб -сайт: https://rahulbordoloi.me
Электронная почта: [email protected]

Сделано с ♥ в Python!