Рекомендации и упражнения по созданию пакета в Python

[epogrebnyak]

Как сделать свой пакет (Python)

Прочитать:

• [1] https://docs.python.org/3/tutorial/modules.html#packages
• [2] https://docs.python.org/3/installing/index.html
• [3] https://docs.python.org/3/tutorial/venv.html

Уметь объяснить:

• что такое модуль
• что такое пакет
• как инсталлировать произвольный пакет пакет через pip
• как питон понимает откуда импортировать конкретный пакет (import foo), какие пути просматривает
• что такое виртуальное окружение, для чего нужно, как создается, какие есть инструменты и команды
• в чем отличие setup.py и pyproject.toml
• что такое переменная path, как она изменяется на Windows/Linux
• что такое PyPI, какие аналоги PyPI есть в других языков программирования

Команды из упражнений выполняются в командной строке.

Упражнение 1:

• создать пакет izy
• показать что работает команда import izy

Упражнение 2:

• написать тест pytest к пакету izy
• запустить тест

Упражнение 3:

• подготовить пакет к дистрибуции (https://packaging.python.org/en/latest/tutorials/packaging-projects/)
• что для этого нужно поменять в папке с пакетом izy?
• создать файлы .whl и tar.gz

Упражнение 4:

• создать виртулаьное окружение env1
• инсталлирвать пакет izy в env 1 из локальной директории

Упражнение 5:

• зарегистрироваться на pipy
• загрузить пакет на testpypi
• создать новое окружение env2 - инсталлировать туда пакет izy c testpypi

Упражнение 6:

• создать пакет izy с помощью poetry ()
• запустить poetry run pytest
• объяснить, где poetry создает виртуальное окружение, найти путь к нему
• удалить папку с виртуальным окружением,
• повторить poetry run pytest
• как в виртуальное поставить другие пакеты
• добавить в зависимости пакета izy пакет pandas
• изменить тесты, чтобы задействовать pandas
• какие альтернативы poetry существуют?

Упражнение 7:

• придумайте несколкьо варианатов названия своего пакета
• обоснуйте какое название лучше и почему
• убедитесь, что название не занято

Упражнение 8 - умеете ли вы следующее:

• обновлять версии пакетов?
• тестируете ли ваш код непрерывно (Github Actions)?
• используете ли автоматическое форматирование и линтеры?
• какие подходы к качеству кода?
• написали ли качественный README.md?
• как ведете и где публикуете документацию проекта?
• представляете ли потребности пользователей вашего пакета?
• понятен ли API пакета, удобный ли он, простой?
• какие артефакты может выдавать пакет?

Записать, что основное выучили в упражнениях, в чем были наибольшие сложности, на что нужно обратить внимание в начале.

Дополнительное чтение:

• https://cjolowicz.github.io/posts/hypermodern-python-01-setup/
• https://packaging.python.org/en/latest/tutorials/packaging-projects/
• https://stackoverflow.com/questions/41535915/python-pip-install-from-local-dir
• https://github.com/jlevy/the-art-of-command-line

Пример модуля izy.py

def izy_func():
   return "This function will plot!"

[epogrebnyak]

Если все выше непонятно, начинаем с Упражнения 0:

• найдите и запустить консоль (терминал) - окно с черным экраном и приглашением типа C:/folder
• запустите python.exe, в разных режимах :
  • python.exe # выйдите из интерпретатора с помощью Сtrl-D или exit()
  • echo print(12345) > foo.py
  • python.exe foo.py
  • python.exe -i foo.py
  • python.exe -c "print(12345)"
  • найдите команду, которая покажет путь к исполняемому файлу в вашей операционной системе (which на linux, where на винде)
• какой путь к python.exe (which python или where python)
• какой путь к pip (which pip или where python)
• python -с "import pandas" (как это работает?, что такое флаг -с)
• создать виртуальное окружение с помощью venv и войти в него
• повторить команды выше (о, проблема, ругается нет pandas, как его установить?)
• чем отличается пути к python.exe в глобальном и в виртуальном окружении?
• найдите где находится код pandas в глобальном и в виртуальном окружении (важно понимать,что это разные директории)
• pandas одной или разных версий?
• если одинаковых, для тренировки измените версию pandas в локальном окружении (зачем это может быть нужно в реальной работе?)

Для обсуждения:

• с каким библиотеками будет установлен питон с Python.org
• что такое сборка анаконда, зачем она нужна?
• какие еще сборки Python бывают?

[IzyGolstein]

Упражнение 0 - хорошее введение, только мне пришлось немного помучиться с изменением PATH для перменных сред. Также я пока не понял суть вопроса: "чем отличается пути к python.exe в глобальном и в виртуальном окружении?", потому что у меня совпадают версии и пути:

import pandas print(pandas.file) C:\Users\mrale\anaconda3\lib\site-packages\pandas__init__.py

и

(base) C:\Users\mrale>python -c "import pandas; print(pandas.file)" C:\Users\mrale\anaconda3\lib\site-packages\pandas__init__.py

И я, возможно, неправильно понял и суть заключалась в том, чтобы я вставлял ответы, но пока я плохо представляю, как должен выглядеть эта ишью, но мне понравилось)

[epogrebnyak]

Упражнение 0 - хорошее введение, только мне пришлось немного помучиться с изменением PATH для перменных сред. Также я пока не понял суть вопроса: "чем отличается пути к python.exe в глобальном и в виртуальном окружении?", потому что у меня совпадают версии и пути:

import pandas print(pandas.file) C:\Users\mrale\anaconda3\lib\site-packages\pandasinit.py

и

(base) C:\Users\mrale>python -c "import pandas; print(pandas.file)" C:\Users\mrale\anaconda3\lib\site-packages\pandasinit.py

@IzyGolstein - скорее всего base и есть глобльное окружение, судя по пути, вам нужно сделать другое, свое окружение env1

Но возможно в задании что-то надо поменять (я не был готов к base)

[epogrebnyak]

@IzyGolstein могли бы упражнение в отельный файл маркдаун перенести? #4

[IzyGolstein]

@epogrebnyak По мере прохождения первого задания встретился с следующей проблемой: изменение версии библиотеки в виртуальном окружении приводило к изменению версии библиотеки в глобальном окружении и наоборот. Также я заметил, что в виртуальном окружении продублированы все библиотеки глобального окружения. Проблема решилась, когда я просто создал новое виртуальное окружение, но к моему сожалению на следующий день это виртуальное окружение исчезло. Продолжаю разбираться)

[epogrebnyak]

@IzyGolstein виртуальное окружение это просто папка - https://docs.python.org/3/library/venv.html#creating-virtual-environments