12. Środowiska wirtualne i pakiety

12.1. Wprowadzenie

Aplikacje Pythonowe często używają pakietów oraz modułów które nie są dołączone do standardowej biblioteki. Potrzebują one czasami konkretnej wersji biblioteki, ponieważ mogą wymagać naprawionego określonego błędu lub mogą być napisane przy użyciu przestarzałej wersji interfejsu biblioteki.

Oznacza to, że może nie być możliwe aby jedna instalacja Pythona spełniała wymagania każdej aplikacji. Jeżeli aplikacja A potrzebuje wersji 1.0 danego modułu, a aplikacja B potrzebuje wersji 2.0, wtedy wymagania są sprzeczne i zainstalowanie wersji 1.0 lub 2.0 uniemożliwi uruchomienie którejś z aplikacji.

Rozwiązaniem tego problemu jest stworzenie środowiska wirtualnego, samodzielnej struktury katalogów, które zawierają instalację Pythona dla określonej wersji oraz dodatkowych pakietów.

Różne aplikacje mogą wtedy używać różnych środowisk wirtualnych. Aby rozwiązać wcześniej przytoczony przykład konfliktujących wymagań, aplikacja A może mieć swoje własne środowisko wirtualne z zainstalowaną wersją 1.0 w momencie gdy aplikacja B ma inne środowisko wirtualne z zainstalowaną wersją 2.0. Jeżeli w pewnym momencie aplikacja B będzie wymagała zaktualizowania modułu do wersji 3.0, nie wpłynie to na środowisko aplikacji A.

12.2. Tworzenie Środowisk Wirtualnych

The module used to create and manage virtual environments is called venv. venv will install the Python version from which the command was run (as reported by the --version option). For instance, excuting the command with python3.12 will install version 3.12.

Aby stworzyć środowisko wirtualne, wybierz katalog, w którym chcesz je umieścić i uruchom moduł venv jako skrypt ze ścieżką do katalogu:

python -m venv tutorial-env

Spowoduje to utworzenie katalogu tutorial-env, jeśli nie istnieje, a także utworzy w nim katalogi zawierające kopię interpretera Pythona i różne pliki pomocnicze.

Popularną lokalizacją katalogu dla środowiska wirtualnego jest .venv. Nazwa ta sprawia, że katalog jest zwykle ukryty, a więc nie wchodzi w drogę, jednocześnie nadając mu nazwę, która wyjaśnia, po co dany katalog istnieje. Zapobiega to również kolizji z plikami .env definicji zmiennych środowiskowych, które są obsługiwane przez niektóre narzędzia.

Po utworzeniu środowiska wirtualnego możesz go aktywować.

Na systemie Windows, uruchom:

tutorial-env\Scripts\activate

Na systemie Unix albo MacOS, uruchom:

source tutorial-env/bin/activate

(Ten skrypt jest napisany dla powłoki bash. Jeżeli używasz powłok csh albo fish, istnieją skrypty activate.csh i activate.fish których powinieneś użyć.)

Uruchomienie środowiska wirtualnego zmieni wygląd powłoki tak aby pokazywała z którego środowiska wirtualnego aktualnie korzystasz, oraz zmieni parametry środowiska tak że uruchomienie python wywoła określoną wersję i instalacje Pythona. Dla przykładu:

$ source ~/envs/tutorial-env/bin/activate
(tutorial-env) $ python
Python 3.5.1 (default, May  6 2016, 10:59:36)
  ...
>>> import sys
>>> sys.path
['', '/usr/local/lib/python35.zip', ...,
'~/envs/tutorial-env/lib/python3.5/site-packages']
>>>

Aby deaktywować środowisko wirtualne, wpisz:

deactivate

w terminalu.

12.3. Zarządzanie pakietami używając pip

Możesz instalować, aktualizować oraz usuwać pakiety korzystając z pragramu nazywanego pip. Domyślnie pip zainstaluje pakiety z Python Package Index. Możesz przeglądać dostępne tam pakiety wchodząc na ich stronę internetową.

pip ma kilka podkomend: „install”, „uninstall”, „freeze” itp. (Zapoznaj się z przewodnikiem Instalacja modułów Pythona, aby uzyskać pełną dokumentację dotyczącą pip.)

Możesz zainstalować najnowszą wersję pakietu, podając jego nazwę:

(tutorial-env) $ python -m pip install novas
Collecting novas
  Downloading novas-3.1.1.3.tar.gz (136kB)
Installing collected packages: novas
  Running setup.py install for novas
Successfully installed novas-3.1.1.3

Możesz również zainstalować konkretną wersję pakietu, podajac jego nazwę z dopiskiem == oraz numerem wersji:

(tutorial-env) $ python -m pip install requests==2.6.0
Collecting requests==2.6.0
  Using cached requests-2.6.0-py2.py3-none-any.whl
Installing collected packages: requests
Successfully installed requests-2.6.0

Jeśli ponownie uruchomisz to polecenie, pip zauważy, że żądana wersja jest już zainstalowana i nic nie zrobi. Możesz podać inny numer wersji, aby pobrać tę wersję, lub uruchomić python -m pip install --upgrade, aby zaktualizować pakiet do najnowszej wersji:

(tutorial-env) $ python -m pip install --upgrade requests
Collecting requests
Installing collected packages: requests
  Found existing installation: requests 2.6.0
    Uninstalling requests-2.6.0:
      Successfully uninstalled requests-2.6.0
Successfully installed requests-2.7.0

Wpisanie python -m pip uninstall, a następnie jednej lub więcej nazw pakietów, usunie te pakiety ze środowiska wirtualnego.

python -m pip show wyświetli informacje na temat określonego pakietu:

(tutorial-env) $ python -m pip show requests
---
Metadata-Version: 2.0
Name: requests
Version: 2.7.0
Summary: Python HTTP for Humans.
Home-page: http://python-requests.org
Author: Kenneth Reitz
Author-email: me@kennethreitz.com
License: Apache 2.0
Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
Requires:

python -m pip list wyświetli listę wszystkich pakietów zainstalowanych w środowisku wirtualnym:

(tutorial-env) $ python -m pip list
novas (3.1.1.3)
numpy (1.9.2)
pip (7.0.3)
requests (2.7.0)
setuptools (16.0)

python -m pip freeze wygeneruje podobną listę zainstalowanych pakietów, ale dane wyjściowe będą miały format, którego oczekuje python -m pip install. Powszechną konwencją jest umieszczenie tej listy w pliku requirements.txt:

(tutorial-env) $ python -m pip freeze > requirements.txt
(tutorial-env) $ cat requirements.txt
novas==3.1.1.3
numpy==1.9.2
requests==2.7.0

Plik requirements.txt można następnie przekazać do systemu kontroli wersji i wysłać jako część aplikacji. Użytkownicy mogą następnie zainstalować wszystkie niezbędne pakiety za pomocą install -r:

(tutorial-env) $ python -m pip install -r requirements.txt
Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
  ...
Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
  ...
Collecting requests==2.7.0 (from -r requirements.txt (line 3))
  ...
Installing collected packages: novas, numpy, requests
  Running setup.py install for novas
Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0

pip ma o wiele więcej opcji. Zapoznaj się z przewodnikiem Instalacja modułów Pythona, aby uzyskać pełną dokumentację dotyczącą pip. Kiedy napiszesz pakiet i będziesz chciał udostępnić go w indeksie pakietów Pythona, zapoznaj się z Python packaging user guide.