Skip to content
Kursen Python

Installera lintern Ruff

En linter som Ruff kan utföra statisk kodanalys för att hitta problem i din kod, problem som du bör lösa för att förbättra din kod. Denna typen av verktyg, linters och liknande, är bra utvecklingsverktyg som både kan spara din tid, göra din kod mer konsistent och i slutändan höjer du kvaliteten på ditt arbete. Läs mer om Ruff på dess webbplats.

Installera Ruff

Du installera Ruff med hjälp av uv. Källkoden för Ruff är publicerad på PyPi package repository tillsammans med alla andra kodmoduler och verktyg som tillsammans bildar en infrastruktur för Python-projekt. Du kan se projektet för Ruff på PyPi’s webbplats.

Kör följande kommando för att installera senaste versionen av Ruff som är kompatibel med “0.12”.

Installera verktyget Ruff med uv.
uv add "ruff>=0.12"

Efter det kör uv lock för att uppdatera låsfilen uv.lock så att den innehåller den version av Ruff som du just installerade.

Uppdatera uv.lock.
uv lock

Om något blir fel så kör du kommandot igen tills det blir rätt eller avinstallera Ruff versionen du har installerat med uv remove ruff.

git status

Om du nu kör kommandot git status så ser du vilka filer som uppdaterats. Det kan se ut så här.

Image description
Bild: Inspektera vilka filer som uppdaterats.

Du har filer som du behöver lägga till repot och därefter så gör du en commit och en push. Gör det och dubbelkolla att ditt repo på GitHub uppdateras i enlighet med dina lokala ändringar.

Titta gärna i de filer som uppdaterats och försök förstå vad det är som händer. De filer som berördes nu var följande.

  1. Filen pyproject.tom uppdaterades med Ruff och dess version.
  2. Filen uv.lock innehåller alla beroenden Ruff har och deras exakta versioner.

Här är lösningen till hur jag lägger till filerna i mitt repo.

Kommandon för att lägga till i git repot.
Lägg till fil i git repot.
# Add all files that are not part of the repo
git add .


# Commit the changes
git commit -a -m "Installed Ruff"


# Push the changes to the remote
git push

Glöm inte att göra git status och kanske även git lg för att se status på ditt repo.

Uppdatera reglerna för Ruff

Ruff kontrollerar att vi skriver kod som följer vissa regler. Du kan läsa mer om hur du anpassar reglerna i Ruffs dokumentation (det är väldigt många så du behöver inte göra det).

Vi har valt vikla regler vi vill att du ska följa när du skriver din kod. Du behöver en konfigurationsfil som heter ruff.toml i din projektmapp som innehålle de reglerna.

Du kan hämta hem en kopia av konfigurationsfilen med följande kommando.

Hämta kursens version av konfigurationsfilen ruff.toml.
curl -L -o ruff.toml https://raw.githubusercontent.com/bth-python/python-abcd25/refs/heads/main/ruff.toml

Gör commit och push för den uppdaterade konfigurationsfilen.

Kör ruff

När du är klar kan du köra ruff på följande vis.

Kör ruff.
# Ruff kan köras på båda sätten som visas nedan.
uvx ruff check
uv run ruff check

Förhoppningsvis får du inget felmeddelande så här långt. uvx är en förkortning för att exekvera installerade paket.

Avslutningsvis

Det är väldigt många regler som påverkar hur du ska skriva din kod. Vi har krav på att du ska följa alla reglerna i den här kursen. Det är viktigt att du följer dem för att få en jämn och hög kvalitet på koden som du skriver. Det är också viktigt att du lär dig att skriva kod som följer dessa regler, eftersom det är en del av att bli en bra Python-utvecklare.

Det är för många regler för att vi ska kunna gå igenom och lära ut alla. Du kommer att lära dig dem under kursens gång. Det är viktigt att du läser dokumentationen och lär dig reglerna så att du kan följa dem. Därför rekomenderar vi att du kör Ruff ofta när du kodar, så att du kan fånga upp fel och problem tidigt i utvecklingsprocessen.