Pakkebehandler og pip

Hvorfor skrive egen kode når du kan bruke andres? Velkommen til jungelen av bibliotekspakker!

Åpen kildekode

Når vi programmerer, ender vi ofte opp med å løse problemer som allerede har blitt løst av andre programmerer mange ganger før. For eksempel det å gjøre nettverkskall til en server, tolke et spesielt filformat, ta i mot nettverkskall fra nettlesere med mer. I stedet for at du må løse dette «ferdig løste» problemet enda en gang, kan du gjenbruke løsninger som andre har skrevet før deg.

Opphavsretten setter begrensninger

I utgangspunktet er all koden som du finner på nettet underlagt opphavsretten. Den begrenser deg sånn at du ikke får lov til å kopiere og gjenbruke andres kode uten tillatelse, på samme måte som du ikke kan skrive avskrift av ei bok du har kjøpt. Du kan dog inngå en avtale med forfatteren som slår fast at du har lov til å bruke koden.

Lisenser: Avtaler som gir deg lov til å bruke kode

Kode som er publisert på nettet for å gjenbrukes, blir som regel gjort tilgjengelig under en «åpen kildekode»-lisens. En lisens er en avtale som du kan velge å følge for å få visse rettigheter under bestemte vilkår, uten at du må kontakte forfatteren, besøke et advokatkontor og signere en avtale i tre eksemplarer. Lisenser for «åpen kildekode» vil som regel gi deg rett til å gjenbruke kildekoden, men bare på visse betingelser. Hvis du bryter med betingelsene så har du ikke lenger rett til å bruke koden.

Ulike lisenser og deres bruksvilkår

De aller fleste lisensene har betingelser som er helt greie å oppfylle. Men du bør være obs på at det finnes copyleft-lisenser som stiller krav til at også din kode må være lisensiert med den samme lisensen. Disse lisensene sørger for at en bedrift ikke bare kan nyttiggjøre seg av koden uten å donere forbedringene tilbake til fellesskapet. Motsatt finnes permissive-lisenser som nesten ikke stiller noen krav i det hele tatt.

Nettstedet https://choosealicense.com/ gir en fin introduksjon til hvilken lisens du bør velge hvis du selv ønsker å dele kildekoden din. På undersiden https://choosealicense.com/appendix/ kan du slå opp lisenser som du finner der ute på nettet, for å få oversikt over hvilke rettigheter de gir deg og hvilke betingelser som følger med.

Åpen kildekode på internett

På nettet kan du finne mye åpen kildekode på nettsteder som GitHub.com. Du kan kopiere kode fra prosjekter du finner der og bruke den i ditt eget prosjekt, så lenge koden er lisensiert med en «åpen kildekode»-lisens og du oppfyller lisensens betingelser. Lisensen ligger som regel i ei fil som heter LICENSE eller LICENSE.txt i den øverste mappa i prosjektet, eller den er nevnt øverst i hver enkelt kodefil. Hvis du ikke finner noen lisens så må du bare anta at koden ikke er åpen kildekode.

Åpen kildekode er frivillighetsarbeid

Åpen kildekode utvikles i fellesskap. Hvis du finner en feil eller har forslag til forbedring, kan du som oftest melde dette på prosjektets nettside. Du kan også foreslå endringer i koden og bidra som frivillig.

Det er dessverre et problem i dette økosystemet med at vi har veldig viktige åpne programvarer som store bedrifter har gjort seg helt avhengige av å bruke, som sliter med å holde programvaren oppdatert og fri for feil fordi alle er veldig glade i å bruke koden, men ingen er villige til å legge ned tid og krefter i å vedlikeholde den. Som poengert av XKCD:

Tegneserie der "All modern digital infrastructure" er en høy stabel med esker som balanserer oppå en veldig liten eske kalt "A project some random person in Nebraska has been thanklessly maintaining since 2003"

Pakker

Det å kopiere kode fra andres prosjekter inn i ditt prosjekt har noen svakheter:

  • Du får ikke med oppdateringer som blir gjort på koden du kopierte fra, for eksempel hvis det var en viktig sikkerhetsfeil som ble fikset.
  • Koden du kopierer fra kan gjenbruke andres kode i tur, som gjør at du potensielt må kopiere inn den koden, og så videre.

Å la deg inspirere av andres åpne kildekode eller kopiere én funksjon eller noen få kodelinjer pleier å gå greit, men det øyeblikket du vil gjenbruke mer så bør du gjøre det i mer ordna former.

For å gjøre det lettere å gjenbruke andres kode, organiserer vi gjenbrukbar kode i pakker. Ei pakke har et pakkenavn og kan også ha flere versjoner, der hver versjon er identifisert med et versjonsnummer. Ei pakke består av ei samling med kodefiler som er pakket sammen i én fil. Disse pakkene kan installeres, litt på samme måte som du installerer et dataprogram på maskinen din. Hver pakke kan også ha avhengigheter (dependencies) til andre pakker, som må installeres for at pakken skal fungere.

For å installere, avinstallere og holde styr på installerte pakker bruker vi en pakkebehandler. I Python er det en innebygd pakkebehandler ved navn pip, men den har ikke noen god innebygd funksjonalitet for å holde styr på hvilke pakker prosjektet ditt krever er installert. Vi skal derfor bruke en pakkebehandler som heter Poetry.

Installere Poetry

Poetry har et eget Python-skript du kan kjøre for å installere det. Følg installasjonsveiledningen til Poetry.

Hvordan legge til Poetry i $PATH?

Installasjonen nevner at du må ha en viss mappe i $PATH. Oppsettet til $PATH bestemmer hvilke mapper terminalen/skallet skal lete i når du bare skriver navnet på en kommando, for eksempel poetry. Hvis ikke mappa som poetry ligger i er satt opp i $PATH, vil aldri terminalen finne den kjørbare fila som heter poetry med mindre du skriver hele filstien dens manuelt hver gang du vil kjøre Poetry.

På Windows kan du legge til denne mappa ved å:

  1. Trykk på Windows-ikonet
  2. Søk etter «Rediger miljøvariabler for kontoen din» og kjør den
  3. Dobbelttrykk på den som heter Path i den øverste lista
  4. Trykk «Ny» og skriv inn stien til mappa. Denne stien blir skrevet til terminalen når du installerer Poetry
  5. Trykk «OK» og «OK»
  6. Åpne terminalen på nytt for at de nye innstillingene skal tre i kraft

På Unix og Linux er det typisk en fil som blir kjørt av skallet ditt ved oppstart som setter innholdet av $PATH-variabelen. Nøyaktig hvilken fil det er, kommer an på hvilket skall du bruker. For Bash (default i Ubuntu og eldre Mac OS X) er det .bashrc i hjemmemappa di, for ZSH (default i nyere Mac OS X) er det .zshrc i hjemmemappa. Lag fila hvis den ikke finnes, og legg til ei linje på formatet:

export PATH="/sti/til/mappe/med/poetry:$PATH"

Akkurat hvilken sti du skal legge til før kolonet blir skrevet til terminalen når du installerer Poetry.

Dobbeltsjekke at Poetry er installert

Når du har installert Poetry, skal du kunne kjøre poetry --version i terminalen.

kurs $> poetry --version
Poetry (version 1.3.1)

Din versjon vil sannsynligvis være nyere enn 1.3.1 som er vist ovenfor, men det gjør ingenting.

Sette opp Python-prosjektet ditt

Før du kan begynne å installere pakker, må du sette opp et Python-prosjekt. Et Python-prosjekt er ei mappe med Python-filer som utgjør en logisk enhet. EPG-innleseren fra del 2 er et typisk eksempel på et Python-prosjekt, og hvis du skulle lagd en tale-til-tekst-tjeneste så ville den vært et annet Python-prosjekt.

Alle Python-filene i et Python-prosjekt deler de samme avhengighetene.

For hvert Python-prosjekt hører det til ei pyproject.toml-fil. Den inneholder informasjon om prosjektet, hvilken Python-versjon prosjektet krever, og hvilke pakker som må installeres for at prosjektet kan kjøres.

Bruk Poetry til å lage denne fila for deg med hjelp av poetry init:

kurs $> poetry init

This command will guide you through creating your pyproject.toml config.

Package name [kurs]:  epg-innleser
Version [0.1.0]:  1.0.0
Description []:  Analyseverktøy for EPG
Author [Kari Nordmann <kari.nordmann@nrk.no>, n to skip]:
License []:
Compatible Python versions [^3.8]:

Would you like to define your main dependencies interactively? (yes/no) [yes] no
Would you like to define your development dependencies interactively? (yes/no) [yes] no
Generated file

[tool.poetry]
name = "epg-innleser"
version = "1.0.0"
description = "Analyseverktøy for EPG"
authors = ["Kari Nordmann <kari.nordmann@nrk.no>"]
readme = "README.md"
packages = [{include = "epg_innleser"}]

[tool.poetry.dependencies]
python = "^3.8"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"


Do you confirm generation? (yes/no) [yes]

Fordi vi bare har tenkt å bruke dette Python-prosjektet lokalt så spiller det ikke så stor rolle akkurat hva du putter i de ulike feltene. Navn, versjon, beskrivelse, forfattere og lisens er dog veldig nyttig hvis du skal publisere prosjektet ditt som en pakke andre kan laste ned.

Legge til avhengigheter

Vi bruker kommandoen poetry add <pakkenavn...> for å legge til en avhengighet. Når vi gjør det, laster Poetry ned pakken fra en sentral pakkebrønn kalt "The Python Package Index" (PyPI) som er drevet av "Python Software Foundation", som er de samme som vedlikeholder selve Python-språket.

Før du laster ned ei pakke, bør du søke den opp på https://pypi.org. Der kan du lese hva pakken gjør, hvordan du bruker den og klikke deg inn på nettsida til prosjektet.

Eksempel: La oss legge til cowsay som en avhengighet.

kurs $> poetry add cowsay
Creating virtualenv epg-innleser-ZMuqz6FV-py3.8 in /home/n123456/.cache/pypoetry/virtualenvs
Using version ^5.0 for cowsay

Updating dependencies
Resolving dependencies... (7.4s)

Writing lock file

Package operations: 1 install, 0 updates, 0 removals

  • Installing cowsay (5.0)
kurs $>

Hvordan kjøre program med Poetry?

Avhengighetene som Poetry installerer for oss blir installert på en sånn måte at de hører til Python-prosjektet vårt. Det betyr at du må gjøre et ekstra steg for å «tre inn i» Python-prosjektet, sånn at du kan få tak i de installerte pakkene.

Hvis du prøver å kjøre cowsay-pakken som vi installerte i stad, vil vi få en feil:

kurs $> python -m cowsay Dette er kuuuuult
/usr/bin/python: No module named cowsay

Du har to alternativer for å tre inn i Python-prosjektet:

  • Kjør én kommando inni Python-prosjektet: poetry run <kommando>
  • Åpne en terminalsesjon inni Python-prosjektet: poetry shell. Da kan du kjøre flere kommandoer uten å bruke poetry run foran. Når du er ferdig kjører du exit.

Eksempel på å kjøre én kommando med poetry run:

kurs $> poetry run python -m cowsay -t "Dette er kuuuuult"
  _________________
| Dette er kuuuuult |
  =================
                 \
                  \
                    ^__^
                    (oo)\_______
                    (__)\       )\/\
                        ||----w |
                        ||     ||

Eksempel på å kjøre flere kommandoer med poetry shell:

kurs $> poetry shell
Spawning shell within /home/n123456/.cache/pypoetry/virtualenvs/epg-innleser-ZMuqz6FV-py3.8
. /home/n123456/.cache/pypoetry/virtualenvs/epg-innleser-ZMuqz6FV-py3.8/bin/activate
(epg-innleser-py3.8) kurs $> python -m cowsay -t "Dette var litt møøøøe"
  _____________________
| Dette var litt møøøøe |
  =====================
                     \
                      \
                        ^__^
                        (oo)\_______
                        (__)\       )\/\
                            ||----w |
                            ||     ||
(epg-innleser-py3.8) kurs $> exit
exit
kurs $>

❌ Mulige løsninger hvis poetry shell gir feilmelding på Windows

Jobbmaskiner kan ofte være sperret ned for å beskytte deg fra å kjøre ondsinnet programvare ved et uhell. Men denne beskyttelsen kan også hindre deg i å kjøre skript som du faktisk har lyst til å kjøre. Du risikerer derfor at poetry shell gir deg en feil om at den ikke får lov til å kjøre skript.

Hvordan løse:

  1. Kjør exit for å gå ut av skallet som ble opprettet av poetry shell
  2. Kjør poetry run powershell i stedet for poetry shell
  3. Nå kan du kjøre python og andre kjørbare filer som er installert i prosjektet, som for eksempel cowsay, uten å ta med poetry run foran

Hver gang du ville ha kjørt poetry shell, kjører du poetry run powershell i stedet. De to skal fungere likt.

Alternativt kan du velge å bare bruke den første metoden med poetry run foran hver kommando.

Hvordan bruke en pakke i Python-kode

Som oftest ønsker vi å bruke pakka vi har installert i et Python-program. En pakke kan gi både nye kjørbare program, importerbare moduler, eller begge deler. Vi skal se på hvordan vi kan bruke en importerbar modul fra en pakke.

Siden vi alt har cowsay-pakka installert, bruker vi denne i eksempelet. Vi starter med å få kua til å si det samme som fra terminalen. Lag en ny Python-fil innenfor samme mappe som prosjektfila pyproject.toml, og kopier inn linjene under. Den første linja med import er for at vi skal få tilgang til funksjonene i cowsay-modulen. Deretter kaller vi cow-funksjonen med teksten vi vil at kua skal si som parameter.

import cowsay

cowsay.cow("Dette er kuuuuult")

For å kjøre programmet fra terminalen brukes poetry ganske likt som terminaleksempelet over.

poetry run python <filnavn>.py

Få Poetry til å fungere med VS Code

Hvis vi fortsatt vil kjøre programmer fra VS Code ved å trykke på "play"-knappen, må vi fortelle VS Code hvilken Python-fortolker den nå skal bruke. Det er fordi Poetry lager en egen folder for prosjektet med en Python-fortolker og pakkene vi installerer, så om vi ikke bruker samme fortolker vil VS Code ikke finne pakkene vi har installert.

For å finne stien til Python-fortolkeren til Poetry kan man kjøre følgende kommando i terminalen.

poetry env info

Det vil da listes opp miljøer tilsvarende bildet under. Kopier ut stien som er i executable under virtualenv.

Skjermbilde av det som skrives ut når man kjører

For å sette Python-fortolker i VS Code, kan du gå til View i toppmenyen i VS Code, og deretter velge Command Palette.... Begynn å skrive python: select interpreter i kommandofeltet, og klikk på samme tekst når det kommer som valg i nedtrekkslista.

Da har du forhåpentligvis kommet til noe som ligner på bildet under, klikk på Enter interpreter path, og lim inn stien du kopierte fra terminalen.

Meny i VS Code for å velge Pyton-fortolker

Om du har valgt riktig fortolker bør det stå noe om Poetry i menylinja helt i bunnen av VS Code, ved siden av versjonsnummeret for Python.

Kjør programmet

Kjør programmet og se at kua dukker opp i terminalen!

✍️ Oppgave Det finnes andre innebygde figurer enn ku, for eksempel dragon, fox, octopus, stegosaurus og turtle. Disse finnes også som funksjoner, så test å bytte ut kall til cow() i programmet med en av de andre figurene.

✍️ Ekstraoppgave cowsay har også funksjonen draw(), som i tillegg til tekst, lar deg sende inn en streng for figuren man vil skal tegnes under snakkebobla. For eksempel:

fisk = r"""
\
 \  
        /`·.¸
     /¸...¸`:·
 ¸.·´  ¸   `·.¸.·´)
: © ):´;      ¸  {
 `·.¸ `·  ¸.·´\`·¸)
     `\\´´\¸.·´
"""

Bruk funksjonen draw for å få fisken til å snakke. Eller søk etter ascii art på nettet, asciiart.eu er en nettside med mange små kunstverk i ascii. Eller kanskje du vil lage en figur helt selv?

Andre ting du kan gjøre

Vi har sett på disse Poetry-kommandoene allerede:

Her er et par andre Poetry-kommandoer du kan bruke:

Videre lesning