6 неща, които трябва да знаете за файла requirements.txt на Python

requirement.txt е ключов инструмент в Python за управление на зависимостите на проекти и осигуряване на гладко сътрудничество между разработчиците. Тя ви позволява да пресъздадете точната среда за разработка, използвана за проекта във всеки един момент в бъдещето. Той също така гарантира, че вашият проект остава актуален, като се възползва от корекции на грешки и нови функции, когато го актуализирате.

Разбирането как работи requirements.txt ще опрости процеса на настройка на вашата среда за разработка, като по този начин ще ви спести време. Освен това ще предотврати проблеми със съвместимостта по време на сътрудничество.

1. Използване на виртуални среди на Python за requirements.txt

Виртуалните среди са неразделна част от ефективното използване на requirement.txt. Те ви позволяват да инсталирате пакети независимо от инсталацията на Python за цялата система. Това от своя страна подобрява надеждността и управляемостта на вашия проект чрез предотвратяване на конфликти и осигуряване на съвместимост на версиите.

Указването на зависимостите във файл requirements.txt във виртуална среда гарантира капсулиране на изискванията на вашия проект. Това улеснява възпроизвеждането на една и съща среда на различни машини. Това е така, защото изолацията гарантира, че вашият проект остава самостоятелен и не пречи на други проекти на Python или пакети на системно ниво.

За да създадете виртуална среда, която да я асоциира с вашия проект, отидете до директорията на вашия проект на терминала и използвайте следната команда:

python -m venv myenv
# On Windows, use: myenv\Scripts\activate
source myenv/bin/activate 

Вече можете да продължите да управлявате зависимостите на вашия проект в активната виртуална среда. Управление на вашата виртуална среда е умение, което ще бъде полезно за използването на файла requirements.txt.

2. Генериране на requirements.txt с Pip Freeze

Въпреки че е възможно ръчно генериране и поддържане на a изисквания.txt файл, този метод може да бъде податлив на грешки и да отнеме много време. Това ще възникне особено когато вашият проект расте и зависимостите се променят. За щастие, Python предоставя автоматизиран начин за генериране на файл requirements.txt. Това е с помощта на пип замразяване команда. Тази команда изисква инсталиране на Pip във вашата система ако още не сте го инсталирали.

Командата pip freeze сканира текущо активната виртуална среда. След това изброява всички инсталирани пакети и техните версии. След това можете да пренасочите този изход към файл requirements.txt. Това ви спестява усилията за ръчно проследяване и актуализиране на зависимости.

За автоматично генериране на a изисквания.txt използване на файл пип замразяване, активирайте вашата виртуална среда и изпълнете следната команда:

pip freeze > requirements.txt

Тази команда ще създаде файла requirements.txt с текущото състояние на вашата виртуална среда. Файлът ще бъде записан във вашата текуща работна директория. Ако вече имате файл requirements.txt, той ще презапише зависимостите с актуализираните. Това е лесен начин да поддържате зависимостите на вашия проект актуални, без да се налага ръчно да актуализирате файла.

3. Персонализиране на имена на файлове: Силата на requirements.txt

Файлът, който изброява зависимостите на проекта, е наименуван изисквания.txt по подразбиране. Можете обаче да изберете да дадете на този файл по-описателно име, което съответства на целта на вашия проект. Това се оказва полезно, когато работите върху няколко проекта едновременно.

Смисленото име подобрява яснотата на проекта. Това улеснява вас и вашите сътрудници да разберете неговата цел. Например, когато работите върху проект за уеб приложение, можете да наименувате файла webapp-requirements.txt или flask-project-requirements.txt. Това елиминира объркването, когато имате множество файлове requirements.txt в различни директории на проекта.

За да генерирате персонализиран файл requirements.txt, използвайте следната команда.

pip freeze > webapp-requirements.txt

Уверете се, че сте заменили уеб приложение с желаното персонализирано име.

4. Работа с различни среди

Разработката на Python често включва работа по множество проекти. Всеки от тези проекти има свой уникален набор от зависимости и изисквания. Ефективното управление на тези разнообразни среди е от решаващо значение за гарантиране, че вашите проекти остават изолирани и поддържаеми. The изисквания.txt файлът играе жизненоважна роля в този процес. Тя ви позволява да документирате и управлявате специфични за проекта зависимости за различни среди.

Това означава, че можете да създавате, активирате и деактивирате виртуални среди за различни проекти. Гарантиране, че всяка среда има свой собствен файл requirements.txt, който посочва специфичните за проекта зависимости. Това поддържа вашите проектни зависимости добре организирани и намалява риска от конфликти между различни проекти.

5. Гъвкаво управление на зависимости: Пропускане на библиотечни версии

В типичен изисквания.txt файл, ще намерите всяка библиотека в списъка с конкретен номер на версия. Има обаче някои сценарии, при които посочването на точна версия може да не е най-добрият подход. Някои от тези сценарии са:

Непрекъсната интеграция и внедряване (CI/CD): В CI/CD конвейери трябва да се уверите, че вашият проект работи с най-новата съвместима версия на зависимост. Посочването на точна версия заключва вашия проект към конкретна версия. Това възпрепятства процесите на автоматизирано тестване и внедряване. Пропускането на версията ви позволява автоматично да актуализирате до най-новата съвместима версия по време на CI/CD.

# Instead of specifying an exact version
requests==2.26.0
# Omit the version to use the latest compatible version during CI/CD
requests

Библиотеки с чести актуализации: Някои библиотеки имат чести актуализации, корекции на грешки и корекции за сигурност. В такива случаи посочването на точна версия води до използване на остаряла или уязвима версия. Пропускането на версията гарантира, че получавате най-новата стабилна версия всеки път, когато пресъздавате вашата среда.

Сътрудничество по проекти с отворен код: Кога сътрудничество по проекти с отворен код с множество сътрудници, указването на точни версии за всяка зависимост може да направи файла requirements.txt податлив на конфликти. Пропускането на версии насърчава сътрудничеството, като дава на сътрудниците свободата да работят със съвместими версии на зависимости.

Пропускането на конкретни номера на версии във вашия файл requirements.txt дава възможност за повече гъвкавост при управлението на зависимостите. Когато пропуснете версии, pip ще се опита да инсталира най-новата съвместима версия на всяка библиотека. Това е полезно, ако искате да сте сигурни, че вашият проект винаги използва най-новата съвместима версия, без да се налага ръчно да актуализирате файла requirements.txt.

6. Инсталиране на библиотеки от requirements.txt

Инсталиране на библиотеки от a изисквания.txt файл е фундаментална стъпка в разработката на Python. Той гарантира, че вашият проект разполага с всички необходими зависимости. След като имате добре поддържан файл requirements.txt, е лесно да инсталирате всички зависимости на проекта на нова система.

Използвайте следната команда, за да инсталирате необходимите зависимости във вашата среда.

pip install -r requirements.txt

Понякога може да получите грешка, показваща, че файлът не е намерен. Това е така, защото може да сте предположили, че файлът се казва requirements.txt, но проектът, върху който работите, използва персонализиран. Винаги проверявайте името, свързано с този файл, преди да опитате да инсталирате зависимостите.

Поддържане на вашия файл requirements.txt

Не забравяйте, че файлът requirements.txt не е втвърден в камък. Той трябва да се развива, докато вашият проект расте и зависимостите се променят. Не забравяйте редовно да го актуализирате и преглеждате. Това е, за да се гарантира, че вашите Python проекти остават здрави и поддържаеми.