Avouch tjekker kun ændret Python-kode før push for at fange fejl hurtigt

Avouch er et værktøj, der hurtigt analyserer kun den nye Python-kode, man har ændret. Det betyder, at udviklere kun ser fejl i deres egne rettelser fremfor i hele projektet. Programmet kører lokalt og bruger fejlkoder til at fortælle, om koden er godkendt.

Avouch er et værktøj, der tjekker kode skrevet i programmeringssproget Python. I stedet for at gennemse hele projektet, kigger det kun på de ændringer, udvikleren lige har lavet. Det svarer til en korrekturlæser, der kun tjekker de nye afsnit, du har tilføjet til en bog, fremfor at læse hele historien forfra hver gang. Gennemgangen tager kun få sekunder og sker lige før, koden sendes videre til resten af holdet via en såkaldt »git push«. Det betyder, at udvikleren kun får besked om fejl i sin egen nye kode.

For at forstå koden bruger Avouch et »Abstract Syntax Tree« (et abstrakt syntakstræ). Hvor nogle værktøjer blot leder efter mønstre i teksten, fungerer et syntakstræ som et kort, der viser, hvordan koden faktisk er bygget op. Det gør det muligt at måle præcis, hvor kompleks koden er, for eksempel hvor mange lag af logik der er indlejret. Grænserne for, hvad der er for komplekst, er defineret i en indstillingsfil, der hedder `avouch.toml`.

Værktøjet kører helt lokalt på computeren uden brug af internet eller et program, der kører konstant i baggrunden (en dæmon). Det benytter standardfunktioner i Python og et system kaldet Git til at finde ud af, hvilke filer der er ændret eller nye. Hvis Avouch finder en fejl i kodens grammatik, kaldet syntaks, bliver det blot noteret i rapporten. En fil, der ikke kan læses, stopper ikke processen for resten af koden.

Avouch fortæller resultatet via såkaldte »exit-koder«, som er simple tal. En nul betyder, at koden er ren, en 1 betyder, at der er fundet fejl, og en 2 betyder, at der er sket en fejl i selve Avouch. Programmet kræver Python version 3.10 eller nyere. Man kan styre resultatet med forskellige kommandoer, herunder en mulighed for at få data i formatet »JavaScript Object Notation« (JSON), som er let for andre computere at læse, eller kun tjekke filer, der er gjort klar til at blive gemt.

Vil du have, at jeg forklarer nærmere, hvordan et »abstrakt syntakstræ« fungerer i praksis?