logo

Hur man skapar filen Requirements.txt i Python

Om du är en utvecklare kanske du vet att när du arbetar med alla Python-projekt eller datavetenskapsprojekt är det viktigt att alltid arbeta i en miljö som gör ditt projekt återanvändbart och repeterbart utan att skapa ett problem för någon som tar upp ditt projekt. Så innan du diskuterar hur man skapar en krav-.txt-fil i Python, låt oss veta vad requirement.txt är och varför vi behöver den.

Vad är filen requirement.txt i Python?

I Pytonorm requirement.txt fil är en typ av fil som vanligtvis lagrar information om alla bibliotek, moduler och paket i sig som används när man utvecklar ett visst projekt. Den lagrar också alla filer och paket som projektet är beroende av eller måste köras av. Vanligtvis lagras (eller finns) den här filen 'requirement.txt' i dina projekts rotkatalog. Här uppstår en annan viktig fråga varför vi behöver den här typen av filer i våra projekt.

Varför behöver vi requirement.txt?

Det hjälper oss på flera sätt, även när vi återbesöker vårt projekt i framtiden, eftersom det löser nästan alla kompatibilitetsproblem. Om du någonsin arbetar med något Python-projekt eller utvecklat något projekt, vet du säkert att vi vanligtvis kräver flera antal paket. Men när vi utvecklade ett projekt använde vi vanligtvis en viss version av paket. Senare kan pakethanteraren eller underhållaren göra vissa ändringar, och dessa ändringar kan lätt bryta hela din applikation. Därför är det för mycket arbete att hålla reda på varje modifiering i paketen. Specifikt, där projektet är alldeles för stort, är det viktigt att hålla reda på varje paket vi använder för att undvika oväntade överraskningar.

Ett av de vanliga sätten att lösa den här typen av problem är att använda en virtuell miljö. Anledningen är att det finns två huvudtyper av paket och platser där Python-biblioteken vanligtvis lagras, och vi behöver vanligtvis inte alla typer av dessa paket när vi arbetar med ett visst projekt; därför krävs det att veta vilken som krävs per projekt för att göra det lättare för reproducerbarheten.

java öppna en fil

Det involverar vanligtvis följande filer:

  • Systempaket som utgör en del av Standard Python Library
  • Webbplatspaket (tredjepartspaket) som du installerar med pip.

Vad är en virtuell miljö?

En virtuell miljö är en typ av isolerad eller konstgjord arbetsyta som håller användarens paket åtskilda från den lokala (eller huvud) systeminstallationen. Det tillåter oss att skapa en 'virtuell' isolerad miljö för varje Python-projekt. Detta gör det lättare för varje projekt att vara oberoende av det andra projektet, särskilt där de delar samma beroenden. Det finns olika paket tillgängliga som kan användas för att skapa en virtuell miljö. Några av grundpaketen är följande:

  • virtualenv
  • pipenv

Så när den virtuella miljön har skapats för vårt projekt, låt oss se hur man installerar paketen och biblioteken. Det är väldigt enkelt att få alla nödvändiga paket vi behöver använda i vårt projekt med den virtuella miljön. Låt oss först se hur man använder 'virtualenv.'

A. virtualenv

Det är en typ av bibliotek som gör att vi kan skapa en virtuell miljö och använda den. För att installera virtualenv kan du följa instruktionerna:

1. Öppna Cmd, skriv följande kommando och tryck på enter-knappen som visas i nedanstående bild:

Kommando

 pip install virtualenv 

Produktion

Hur man skapar filen Requirements.txt i Python

2. Skapa den nya arbetskatalogen för projektet

Skapa nu en ny virtuell miljö i projektets katalog för att undvika onödiga problem.

Kommando

 Python3 -m venv name_of_env 

Produktion

Hur man skapar filen Requirements.txt i Python

3. Nu för att använda denna nyskapade virtuella miljö behöver vi bara aktivera den. För att aktivera denna isolerade miljö, skriv följande givna kommando och tryck på enter-knappen som visas nedan:

Kommando

 name_of_envirnmentScriptsactivate 

Produktion

Hur man skapar filen Requirements.txt i Python

För att verifiera att vår nya virtuella miljö har skapats kan du se i prompten att prefixet ändras med namnet på din nya virtuella miljö, som i vårt fall har vi döpt vår virtuella miljö till 'name_of_envirnmnet'. Du kan också verifiera det genom att öppna projektets katalog eller mappen där en ny katalog med det angivna namnet kommer att skapas.

4. Låt oss nu se hur du skapar filen requirement.txt

För att skapa filen requirement.txt är det bra att veta vad den innehåller.

En requirement.txt-filer innehåller alla typer av standardpaket och bibliotek som används i det specifika projektet. Därför spelar denna requirement.txt-fil en viktig roll vid utveckling av små eller större projekt. Det hjälper oss också att göra våra projekt mer portabla.

Med hjälp av filen 'requirement.txt' kan flera stora problem lätt undvikas. För att förstå det mer detaljerat kan du överväga följande exempel:

Exempel:

Anta att du har skapat ett nytt projekt, till exempel en applikation som är kompatibel med den specifika versionen av biblioteket och paketen. Av någon anledning vidarebefordrar du därför denna ansökan till din vän.

Eftersom du inte har använt filen requirement.txt kan det vara möjligt att din applikation inte kommer att köras korrekt eller till och med inte kommer igång på din väns system. Den främsta anledningen till detta är att alla användare inte använder samma version av bibliotek och paket. Men om du använde filen requirement.txt kan vem som helst köra och använda ditt projekt eller program eftersom alla nödvändiga eller använda paket och bibliotek också anges i form av en fil (requirement.txt) med ditt projekt.

I denna krav-.txt-fil kan användaren enkelt välja, lagra och underhålla de nödvändiga filerna enligt deras krav.

Hur man hämtar filen Requirements.txt: Använda Virtualenv

Här kan vi hämta filen requirements.txt. För att skapa filen requirement.txt kan vi använda följande kommando:

Kommando

 pip3 freeze > requirements.txt 

Produktion

Hur man skapar filen Requirements.txt i Python

Hur man hämtar filen Requirements.txt: Använda Pipenv

Pipenv är också ett utmärkt biblioteksverktyg för skapande av virtuell miljö som har några coola funktioner. Du kan använda följande givna instruktion för att hämta filen requirement.txt.

1. Skriv följande kommando för att installera pipenv

Kommando

 pip install pipenv 

Produktion

Hur man skapar filen Requirements.txt i Python

2. Skriv nu följande kommando och tryck på enter-knappen.

Kommando

 pipenv install mypackage 

Kommandot ovan används för att installera de paket som krävs för projekten.

Produktion

Hur man skapar filen Requirements.txt i Python
  • Efter att ha installerat paketen för projektet måste vi aktivera den virtuella miljön. Därför kan du använda följande kommandon för att aktivera den virtuella miljön:

Kommando

 pipenv shell 

Eller

 pipenv run 

Dessa kommandon kan användas för att aktivera den nyskapade virtuella miljön, som visas nedan:

Produktion

Hur man skapar filen Requirements.txt i Python

Skriv nu följande kommando för att köra skriptet i den virtuella miljön.

Kommando

 pipenv run Python myscript.py 

Förklaring

Detta kommando används för att köra det angivna skriptet i den virtuella miljön som visas nedan:

Produktion

Hur man skapar filen Requirements.txt i Python

Eftersom det är enklare, och det också automatiskt håller reda på alla bibliotek som används för projektet i en pipfil och en pipfil. lås fil. Dessa filer spelar samma roll precis som en requirements.txt och lagrar även ytterligare information om flera saker som inte ingår i requirement.txt.

Du kan alltså använda den här pipfilen som alternativ till filen requirements.txt. Men om du fortfarande vill använda filen requirements.txt kan du använda följande kommando:

 pipenv -r lock >> requirements.txt 

Produktion

Hur man skapar filen Requirements.txt i Python

Hur man hämtar filen Requirements.txt: Utan Virtualenv med Pipreqs

Pipreqs är ett av de mest effektiva och enkla verktygen att använda, som inte kräver att du skapar någon virtuell miljö. Därför är det ganska användbart om en användare bara behöver de paket och bibliotek som används i en applikation eller projektet.

En av de viktigaste sakerna är att den automatiskt skannar skripten eller Python-filerna efter deras importerade bibliotek och genererar en requirements.txt.

Låt oss se hur det fungerar:

1. Först och främst måste du installera 'pipreqs', så för att ladda ner det skriv följande givna kommando i cmd och tryck på enter-knappen:

Kommando

 pip install pipreqs 

Produktion

Hur man skapar filen Requirements.txt i Python

2. När installationen är klar kan du starta 'pipreqs' för att hämta filen requirement.txt genom att peka ut den till platsen där din projektmapp finns.

Kommando

 pipreqs /path/to/project 

Produktion

Hur man skapar filen Requirements.txt i Python

För att verifiera att filen requirement.txt har skapats kan du se i ditt projekts mapp att en ny fil 'requirement.txt' kommer att skapas, som visas nedan:

Hur man skapar filen Requirements.txt i Python