6 stvari, ki bi jih morali vedeti o datoteki Python requirements.txt

requirement.txt je ključno orodje v Pythonu za upravljanje odvisnosti projektov in zagotavljanje nemotenega sodelovanja med razvijalci. Omogoča vam, da kadar koli v prihodnosti znova ustvarite točno razvojno okolje, ki se uporablja za projekt. Zagotavlja tudi, da vaš projekt ostane aktualen s popravki napak in novimi funkcijami, ko ga posodobite.

Razumevanje, kako zahteve.txt deluje, bo poenostavilo postopek nastavitve vašega razvojnega okolja in vam tako prihranilo čas. Prav tako bo preprečil težave z združljivostjo med sodelovanjem.

1. Izkoriščanje virtualnih okolij Python za requirements.txt

Virtualna okolja so sestavni del učinkovite uporabe requirement.txt. Omogočajo vam namestitev paketov neodvisno od sistemske namestitve Python. To nato poveča zanesljivost in obvladljivost vašega projekta s preprečevanjem konfliktov in zagotavljanjem združljivosti različic.

Določanje odvisnosti v datoteki requirements.txt v virtualnem okolju zagotavlja enkapsulacijo zahtev vašega projekta. Tako je lažje reproducirati isto okolje na različnih strojih. To je zato, ker izolacija zagotavlja, da vaš projekt ostane samostojen in ne posega v druge projekte Python ali pakete na ravni sistema.

Če želite ustvariti virtualno okolje, ki ga povezuje z vašim projektom, se pomaknite do imenika vašega projekta na terminalu in uporabite naslednji ukaz:

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

Zdaj lahko nadaljujete z upravljanjem odvisnosti vašega projekta v aktivnem virtualnem okolju. Upravljanje vašega virtualnega okolja je veščina, ki bo koristna za uporabo datoteke requirements.txt.

2. Generiranje requirements.txt s Pip Freeze

Čeprav je mogoče ročno ustvariti in vzdrževati a zahteve.txt je lahko ta metoda nagnjena k napakam in zamudna. To se bo pojavilo zlasti, ko bo vaš projekt rasel in odvisnosti se spremenile. Na srečo Python ponuja avtomatiziran način za ustvarjanje datoteke requirements.txt. To je z uporabo pip zamrznitev ukaz. Ta ukaz zahteva namestitev Pip v vaš sistem če ga še niste namestili.

Ukaz pip freeze skenira trenutno aktivno virtualno okolje. Nato prikaže seznam vseh nameščenih paketov in njihovih različic. Ta izhod lahko nato preusmerite v datoteko requirements.txt. To vam prihrani trud pri ročnem sledenju in posodabljanju odvisnosti.

Za samodejno ustvarjanje a zahteve.txt uporabo datoteke pip zamrznitev, aktivirajte svoje virtualno okolje in zaženite naslednji ukaz:

pip freeze > requirements.txt

Ta ukaz bo ustvaril datoteko requirements.txt s trenutnim stanjem vašega virtualnega okolja. Datoteka bo shranjena v vaš trenutni delovni imenik. Če že imate datoteko requirements.txt, bo prepisala odvisnosti s posodobljenimi. To je preprost način za posodabljanje odvisnosti vašega projekta, ne da bi morali ročno posodabljati datoteko.

3. Prilagajanje imen datotek: Moč Zahteve.txt

Datoteka, ki navaja odvisnosti projekta, je poimenovana zahteve.txt privzeto. Vendar pa se lahko odločite, da tej datoteki daste bolj opisno ime, ki je v skladu z namenom vašega projekta. To se izkaže za uporabnega, ko delate na več projektih hkrati.

Pomenljivo ime poveča jasnost projekta. Tako vi in ​​vaši sodelavci lažje razumete njegov namen. Na primer, ko delate na projektu spletne aplikacije, lahko datoteko poimenujete webapp-requirements.txt oz flask-project-requirements.txt. To odpravi zmedo, ko imate več datotek requirements.txt v različnih imenikih projekta.

Če želite ustvariti datoteko requirements.txt po meri, uporabite naslednji ukaz.

pip freeze > webapp-requirements.txt

Zagotovite zamenjavo spletna aplikacija z želenim imenom po meri.

4. Ravnanje z različnimi okolji

Razvoj Pythona pogosto vključuje delo na več projektih. Vsak od teh projektov ima svoj edinstven niz odvisnosti in zahtev. Učinkovito upravljanje teh raznolikih okolij je ključnega pomena za zagotovitev, da vaši projekti ostanejo izolirani in vzdržljivi. The zahteve.txt datoteka ima ključno vlogo v tem procesu. Omogoča vam dokumentiranje in upravljanje projektno specifičnih odvisnosti za različna okolja.

To pomeni, da lahko ustvarite, aktivirate in deaktivirate virtualna okolja za različne projekte. Zagotavljanje, da ima vsako okolje lastno datoteko requirements.txt, ki določa odvisnosti, specifične za projekt. To ohranja vaše projektne odvisnosti lepo organizirane in zmanjšuje tveganje za navzkrižja med različnimi projekti.

5. Prilagodljivo upravljanje odvisnosti: izpuščanje različic knjižnice

V tipičnem zahteve.txt datoteko, boste našli vsako knjižnico, navedeno z določeno številko različice. Vendar pa obstajajo nekateri scenariji, kjer določanje natančne različice morda ni najboljši pristop. Nekateri od teh scenarijev so:

Nenehna integracija in uvajanje (CI/CD): V cevovodih CI/CD morate zagotoviti, da vaš projekt deluje z najnovejšo združljivo različico odvisnosti. Če navedete natančno različico, vaš projekt zaklene na določeno različico. To ovira avtomatizirane postopke testiranja in uvajanja. Če izpustite različico, vam omogoča samodejno posodobitev na najnovejšo združljivo različico med 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

Knjižnice s pogostimi posodobitvami: Nekatere knjižnice imajo pogoste posodobitve, popravke napak in varnostne popravke. V takih primerih navedba točne različice vodi do uporabe zastarele ali ranljive različice. Če izpustite različico, zagotovite, da dobite najnovejšo stabilno različico vsakič, ko znova ustvarite svoje okolje.

Sodelovanje pri odprtokodnih projektih: Kdaj sodelovanje pri odprtokodnih projektih z več sodelujočimi lahko navedba natančnih različic za vsako odvisnost povzroči konflikte v datoteki requirements.txt. Izpuščanje različic spodbuja sodelovanje, saj daje sodelujočim svobodo dela z združljivimi različicami odvisnosti.

Izpuščanje določenih številk različic v datoteki requirements.txt omogoča večjo prilagodljivost pri upravljanju odvisnosti. Ko izpustite različice, bo pip poskušal namestiti najnovejšo združljivo različico vsake knjižnice. To je uporabno, če želite zagotoviti, da vaš projekt vedno uporablja najnovejšo združljivo različico, ne da bi morali ročno posodobiti datoteko requirements.txt.

6. Namestitev knjižnic iz requirements.txt

Namestitev knjižnic iz a zahteve.txt je temeljni korak v razvoju Pythona. Zagotavlja, da ima vaš projekt vzpostavljene vse potrebne odvisnosti. Ko imate dobro vzdrževano datoteko requirements.txt, je preprosto namestiti vse odvisnosti projekta v nov sistem.

Uporabite naslednji ukaz za namestitev zahtevanih odvisnosti v vaše okolje.

pip install -r requirements.txt

Včasih se lahko prikaže napaka, ki kaže, da datoteke ni mogoče najti. To je zato, ker ste morda domnevali, da se datoteka imenuje requirements.txt, vendar projekt, na katerem delate, uporablja datoteko po meri. Preden poskušate namestiti odvisnosti, vedno preverite ime, povezano s to datoteko.

Vzdrževanje vaše datoteke requirements.txt

Ne pozabite, da datoteka requirements.txt ni vtisnjena v kamen. Moral bi se razvijati, ko vaš projekt raste in se spreminjajo odvisnosti. Ne pozabite ga redno posodabljati in pregledovati. To zagotavlja, da vaši projekti Python ostanejo robustni in vzdržljivi.