Недавно я отвечал на вопрос о Stackoverflow, когда начал думать о коренной причине многих из этих вопросов. Кто -то пытается интегрировать новую библиотеку в свой код, но даже после прочтения документации и соответствующих блогов неясно, как заставить ее работать. Я уверен, что мы все были там!
Когда мы читаем код, мы используем наш мозг для создания ментальной модели того, как работает код. Когда все идет хорошо, это интересно и весело. Но иногда, по какой -то причине, умственная картина просто не собирается вместе. Может быть, база кода огромна, или она написана таким образом, что это особенно сложно понять. В этих ситуациях визуальная карта кода может быть действительно полезна, потому что она уменьшает мою умственную рабочую нагрузку, создавая картинки, которые мой разум пытается создать.
В этом посте я представлю рецепт, который вы можете использовать для визуальной навигации по любой библиотеке Python и получить полное понимание того, как он работает. Для этого мы будем использовать инструмент с открытым исходным кодом под названием Appmap для VSCODE , что я помогаю создавать.
Процедура подобной:
- Установите Appmap для VSCODE.
- Найдите или создайте тестовую программу, которая использует библиотеку.
- Установите
Appmapупаковка. - Запустите тестовую программу с включенной записи Appmap.
- Откройте Appmap в VS -коде.
- Исследуйте и изучите код, используя карту зависимости и трассировку выполнения.
Для целей этого поста скажем, мы используем Paramiko SSH Package, и мы, чтобы лучше понять, как это работает. Пойдем!
Получите Appmap для VSCODE
Во -первых, установите Appmap с рынка VSCODE или используйте Установите расширение команда внутри VSCODE. Так просто.
Выберите тестовую программу
Затем найдите или создайте тестовую программу, которая использует пакет Python. Вы можете написать свой собственный, или вы можете найти его в проекте Repo, или в документации, или вы можете использовать тестовый пример из набора библиотечных тестов. В этом примере я написал тестовую программу под названием sshdemo.py.
Установите пакет Appmap
Этот шаг прост, просто следуйте двум шагам Инструкции по установке для Appmap-Python Анкет
Запишите тестовую программу
Если ваш пример программы представляет собой тестовый пример Pytest или Unittest, просто запустите тестовый пример с Appmap = true Анкет
Если вы написали программу примеров, как я здесь, запустите программу примеров с Appmap. Запись Обернут вокруг него, затем распечатайте файл Appmap.
Будет сгенерирован файл Appmap, который является лишь файлом JSON с расширением appmap.json .
Откройте Appmap в коде VS
Нажмите на файл appmap json. Он открывается в коде VS как красивая диаграмма! На самом деле есть две диаграммы.
Обратите внимание, что в любой момент вы можете нажать на объект на диаграмме, чтобы увидеть детали на левой боковой панели. Оттуда вы можете нажать «Просмотр источника», чтобы открыть файл Python, соответствующий объекту диаграммы. Таким образом, вы можете быстро и легко перемещаться между пакетами и кодом.
Карта зависимости
Карта зависимости Показывает изображение на высоком уровне пакетов кода и то, как они относятся друг к другу.
След
Трассировка Просмотр показывает подробный путь выполнения через код, с параметрами, возвратными значениями, исключениями и т. Д.
Учить больше
Это просто быстрый обзор использования Appmap для изучения и изучения пакета Python. Вы можете посетить Appmap-Python на GitHub Чтобы узнать больше о таких темах, как:
- Создание приложений из
pytestиUnittestтесты. - Картирование приложений Django и Flask.
- Запись внешнего процесса.
Appmap для VS -кода Страница включает в себя больше информации о:
- Как использовать диаграммы.
- Как поделиться приложениями с другими.
- Как использовать Appmap с Ruby и Java.
- Как обрезать большую приложение с помощью списков исключения.
И более! Спасибо за чтение.
Оригинал: “https://dev.to/appland/explore-and-learn-any-python-library-using-interactive-maps-5eef”