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.

Ruff är redan installerat i ditt repo.

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 vilka regler vi vill att du ska följa när du skriver din kod. Det finns en konfigurationsfil som heter ruff.toml i din projektmapp som innehåller de reglerna.

Note

Om du inte håller med oss om vissa av reglerna som du upplever under kursensgång får du gärna ta upp det med oss. Vi är öppna för att diskutera reglerna och ändra dem om det är motiverat.

Kör ruff

Du kan 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.