6 saker du bör veta om Pythons requirements.txt-fil

requirement.txt är ett avgörande verktyg i Python för att hantera projektberoenden och säkerställa smidigt samarbete mellan utvecklare. Det låter dig återskapa den exakta utvecklingsmiljön som används för projektet när som helst i framtiden. Det säkerställer också att ditt projekt förblir aktuellt och dra nytta av buggfixar och nya funktioner när du uppdaterar det.

Att förstå hur requirements.txt fungerar förenklar processen med att ställa in din utvecklingsmiljö och sparar därmed tid. Det kommer också att förhindra kompatibilitetsproblem under samarbete.

1. Utnyttja Python Virtual Environments för requirements.txt

Virtuella miljöer är en integrerad del av ett effektivt utnyttjande av requirement.txt. De gör att du kan installera paket oberoende av den systemomfattande Python-installationen. Detta förbättrar i sin tur ditt projekts tillförlitlighet och hanterbarhet genom att förhindra konflikter och säkerställa versionskompatibilitet.

Att specificera beroenden i en requirements.txt-fil i en virtuell miljö säkerställer inkapsling av ditt projekts krav. Detta gör det lättare att återskapa samma miljö på olika maskiner. Detta beror på att isoleringen säkerställer att ditt projekt förblir fristående, och det stör inte andra Python-projekt eller paket på systemnivå.

För att skapa en virtuell miljö som associerar den med ditt projekt, navigera till ditt projekts katalog på terminalen och använd följande kommando:

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

Du kan nu fortsätta att hantera ditt projekts beroenden inom den aktiva virtuella miljön. Hantera din virtuella miljö är en färdighet som kommer att vara användbar för att använda filen requirements.txt.

2. Genererar requirements.txt med Pip Freeze

Även om det är möjligt att manuellt generera och underhålla en krav.txt fil, kan denna metod vara felbenägen och tidskrävande. Detta kommer att uppstå särskilt när ditt projekt växer och beroenden förändras. Lyckligtvis tillhandahåller Python ett automatiskt sätt att generera en requirements.txt-fil. Detta är genom att använda pip frysa kommando. Detta kommando kräver installation av Pip i ditt system om du inte redan har installerat det.

Kommandot pip freeze skannar den för närvarande aktiva virtuella miljön. Den listar sedan alla installerade paket och deras versioner. Du kan sedan omdirigera denna utdata till en requirements.txt-fil. Detta sparar dig ansträngningen att manuellt spåra och uppdatera beroenden.

För att automatiskt generera en krav.txt fil med hjälp av pip frysa, aktivera din virtuella miljö och kör följande kommando:

pip freeze > requirements.txt

Det här kommandot skapar filen requirements.txt med det aktuella tillståndet för din virtuella miljö. Filen kommer att sparas i din nuvarande arbetskatalog. Om du redan har en requirements.txt-fil kommer den att skriva över beroenden med de uppdaterade. Det är ett enkelt sätt att hålla ditt projekts beroenden uppdaterade utan att behöva uppdatera filen manuellt.

3. Personifiera filnamn: Kraften med requirements.txt

Filen som listar projektberoenden heter krav.txt som standard. Du kan dock välja att ge den här filen ett mer beskrivande namn som stämmer överens med ditt projekts syfte. Detta visar sig vara användbart när du arbetar med flera projekt samtidigt.

Det meningsfulla namnet förstärker projektets tydlighet. Detta gör det lättare för dig och dina medarbetare att förstå syftet. När du till exempel arbetar med ett webbapplikationsprojekt kan du namnge filen webapp-requirements.txt eller flask-project-requirements.txt. Detta eliminerar förvirring när du har flera requirements.txt-filer i olika projektkataloger.

Använd följande kommando för att skapa en anpassad requirements.txt-fil.

pip freeze > webapp-requirements.txt

Se till att du byter ut webbapp med ditt önskade anpassade namn.

4. Hantera olika miljöer

Python-utveckling innebär ofta att man arbetar med flera projekt. Vart och ett av dessa projekt har sin unika uppsättning av beroenden och krav. Att hantera dessa olika miljöer effektivt är avgörande för att säkerställa att dina projekt förblir isolerade och underhållsbara. De krav.txt fil spelar en viktig roll i denna process. Det låter dig dokumentera och hantera projektspecifika beroenden för olika miljöer.

Detta innebär att du kan skapa, aktivera och avaktivera virtuella miljöer för olika projekt. Se till att varje miljö har sin egen requirements.txt-fil som anger de projektspecifika beroenden. Detta håller dina projektberoenden snyggt organiserade och minskar risken för konflikter mellan olika projekt.

5. Flexibel beroendehantering: Utelämna biblioteksversioner

I en typisk krav.txt fil, hittar du varje bibliotek listat med ett specifikt versionsnummer. Det finns dock vissa scenarier där det kanske inte är det bästa sättet att ange en exakt version. Några av dessa scenarier är:

Kontinuerlig integration och distribution (CI/CD): I CI/CD-pipelines bör du se till att ditt projekt fungerar med den senaste kompatibla versionen av ett beroende. Genom att ange en exakt version låses ditt projekt till en specifik version. Detta hindrar automatiska test- och distributionsprocesser. Om du utelämnar versionen kan du automatiskt uppdatera till den senaste kompatibla versionen under 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

Bibliotek med frekventa uppdateringar: Vissa bibliotek har frekventa uppdateringar, buggfixar och säkerhetskorrigeringar. I sådana fall leder angivande av en exakt version till att man använder en föråldrad eller sårbar version. Att utelämna versionen säkerställer att du får den senaste stabila versionen varje gång du återskapar din miljö.

Samarbete kring öppen källkodsprojekt: När samarbeta i projekt med öppen källkod med flera bidragsgivare kan specificera exakta versioner för varje beroende göra filen requirement.txt utsatt för konflikter. Att utelämna versioner uppmuntrar till samarbete genom att ge bidragsgivarna friheten att arbeta med kompatibla versioner av beroenden.

Om du utelämnar specifika versionsnummer i din requirements.txt-fil får du mer flexibilitet i beroendehanteringen. När du utelämnar versioner kommer pip att försöka installera den senaste kompatibla versionen av varje bibliotek. Detta är användbart om du vill säkerställa att ditt projekt alltid använder den senaste kompatibla versionen utan att behöva uppdatera filen requirement.txt manuellt.

6. Installera bibliotek från requirements.txt

Installera bibliotek från en krav.txt fil är ett grundläggande steg i Python-utvecklingen. Det säkerställer att ditt projekt har alla nödvändiga beroenden på plats. När du väl har en välskött requirements.txt-fil är det enkelt att installera alla projektberoenden på ett nytt system.

Använd följande kommando för att installera nödvändiga beroenden i din miljö.

pip install -r requirements.txt

Ibland kan du få ett felmeddelande som indikerar att filen inte hittas. Detta beror på att du kanske har antagit att filen heter requirements.txt men projektet du arbetar med använder en anpassad. Kontrollera alltid namnet som är associerat med den här filen innan du försöker installera beroenden.

Underhålla din requirements.txt-fil

Kom ihåg att filen requirements.txt inte är hugget i sten. Det bör utvecklas i takt med att ditt projekt växer och beroenden förändras. Se till att regelbundet uppdatera och granska den. Detta för att säkerställa att dina Python-projekt förblir robusta och underhållsbara.