JSON: Et dataformat

💡 Læringsmål: I dette kapittelet lærer du hva JSON er og hvordan formatet er strukturert, samt hvordan man kan lese og skrive JSON til og fra fil.

JSON står for "JavaScript Object Notation" og er et tekstformat som er relativt leselig for mennesker, og enda enklere for maskiner å lese. Det er basert på JavaScript, men er ellers språkuavhengig.

To strukturer danner oppbyggingen til JSON:

En samling av par basert på nøkkel og verdi
En hierarkisk liste med verdier

Disse strukturene er universelle og så å si alle moderne programmeringsspråk støtter disse i en eller annen form. Derfor passer JSON spesielt godt til å overføre data mellom forskjellige tjenester som kan være bygget med forskjellige programmeringsspråk.

Et eksempel på JSON kan for eksempel være:

{
    "id": "12975534035527",
    "product_code": "DVSF65100022",
    "title": "Der ingen skulle tru at nokon kunne bu",
}

Et JSON-objekt kan ha ingen, ett, eller flere "nøkkel-verdi-par", hvor kolon skiller mellom nøkkel og verdi, og komma skiller mellom hvert par. Selve objektet er omgitt av krøllparenteser. Eksemplet over viser ett JSON-objekt med tre nøkkel-verdi-par.

Vi kan utvide eksemplet til inneholde et underobjekt med egne nøkler og verdier:

{
    "id": "12975534035527",
    "product_code": "DVSF65100022",
    "title": "Der ingen skulle tru at nokon kunne bu",
    "additional_metadata": {
        "category": "3.8.7 Personlig / Livsstil / Familie",
        "presentation_format": "2.1.4.99 Dokumentarserie",
        "age_restriction": "A",
        "production_year": 2022
    }
}

I eksemplet over ser vi også at flere datatyper enn strenger støttes for verdier, f.eks. verdien 'production_year' som er et nummer. Datatypene som støttes er strenger, nummer, objekt, lister, boolean, og null.

I eksemplene under vises hvordan disse datatypene kan benyttes i JSON.

Videre kan vi f.eks utvide eksemplet til å inneholde en liste med verdier:

{
    "id": "12975534035527",
    "product_code": "DVSF65100022",
    "title": "Der ingen skulle tru at nokon kunne bu",
    "additional_metadata": {
        "category": "3.8.7 Personlig / Livsstil / Familie",
        "presentation_format": "2.1.4.99 Dokumentarserie",
        "age_restriction": "A",
        "production_year": 2022
    },
    "spoken_languages": ["norsk", "sunnmørsk"]
}

Her er et eksempel hvor et JSON-objekt har en liste med underobjekter (episodes er da en liste med objekter):

{
    "id": "12975534035527",
    "product_code": "DVSF65100022",
    "title": "Der ingen skulle tru at nokon kunne bu",
    "additional_metadata": {
        "category": "3.8.7 Personlig / Livsstil / Familie",
        "presentation_format": "2.1.4.99 Dokumentarserie",
        "age_restriction": "A",
        "production_year": 2022
    },
    "spoken_languages": ["norsk", "sunnmørsk"],
    "episodes" : [
        {
            "id": "12975764507527",
            "title" : "Øvre Brekkebakkane 3",
            "episode_number" : 1,
            "ready_for_broadcast": true,
        },
        {
            "id": "12975764519527",
            "title" : "Øvre Brekkebakkane 4",
            "episode_number" : 2,
            "ready_for_broadcast": false,
        },
    ]
}

Og helt til sist, et eksempel på en lengre liste av JSON-objekter. Slik ser det gjerne ut i en JSON-fil:

[
    {
        "id": "12975534035527",
        "product_code": "DVSF65100022",
        "title": "Der ingen skulle tru at nokon kunne bu",
    },
    {
        "id": "45975588035556",
        "product_code": "MUHU65100022",
        "title": "Der alle skulle tru at nokon kunne bu",
    },
    {
        "id": "78455588067599",
        "product_code": "NNFA65100022",
        "title": "Nyheter om hvor ingen skulle tru at nokon kunne bu",
    }
]

✍️ Oppgave JSON-eksemplet under inneholder en rekke feil og mangler. Klarer du å rette opp slik formateringen blir korrekt?

{
    "id": "43905584095567",
    "product_code" = "MUHU65100022",
    "title"; "Nytt på nytt",
	"medvirkende": (
		"Bård Tufte Johansen",
		"Isalill Kolpus,
		Johan Golden,
	)
	"metadata": {
		"category" "3.5.7.4 Satire".
		"presentation_format": 2.0.8 "Talkshow",
		"age_restriction": "9+",
		"production_year" - 2023,
	}

I Python får man støtte for JSON gjennom standardbiblioteket json. Det er fire funksjoner i dette biblioteket som du kommer til å benytte mye når du arbeider med JSON i Python:
load(), dump(), loads(), og dumps(). Merk den lille forskjellen mellom de to første funksjonene og de to siste funksjonene, nemlig 's'-endelsen. Kort forklart så benyttes funksjonene uten 's' når man skal lese eller skrive til en fil, mens funksjonene med 's' benyttes når man skal lese elle skrive til en streng. Disse funksjonene konverterer henholdsvis JSON fra og til en Python-oppslagstabell.

Det første eksemplet vårt kan for eksempel se slikt ut når man konverterer en JSON-streng til en Python-oppslagstabell:

import json

product_json = '{"id": "12975534035527", "product_code": "DVSF65100022", "title": "Der ingen skulle tru at nokon kunne bu"}'

product = json.loads(product_json)
print(product["title"])

Og omvendt når man konverterer fra en Python oppslags-tabell til en JSON-string:

import json

product = {
    "id": "12975534035527", 
    "product_code": "DVSF65100022", 
    "title": "Der ingen skulle tru at nokon kunne bu"
}

json_string = json.dumps(product)
print(json_string)

I eksempelet over bruker vi altså funksjonene loads() og dumps() fordi vi konverterer JSON fra og til en streng.

I de aller fleste tilfeller der man arbeider med JSON kommer man ikke til å belage seg på at dataen er hardkodet i scriptet sitt. Man ønsker nok heller å hente dataen fra et eksternt sted, f.eks. en fil eller et API.

Vi har tidligere sett på hvordan man kan lese innhold fra en fil, så nå skal vi se videre på hvordan man kan lese JSON fra en fil for deretter å benytte det innebygde json-biblioteket i Python til å konvertere innholdet i fila til en oppslagstabell.

Hvis f.eks. fila inneholder kun ett JSON-objekt

{
    "id": "12975534035527",
    "product_code": "DVSF65100022",
    "title": "Der ingen skulle tru at nokon kunne bu",
}

Så kan man lese hele innholdet av fila som beskrevet i kapittel 2.1, for deretter å benytte det innebygde json-biblioteket i Python for å konvertere slik at det kan legges i en oppslagstabell:

import json

with open("data.json", "r", encoding="utf-8") as fil:
    json_data = json.load(fil)

Selv om fila med JSON-data inneholder flere objekter i en liste, f.eks. slik:

[
    { "id": "12975534035527", "product_code": "DVSF65100022", "title": "Der ingen skulle tru at nokon kunne bu"},
    { "id": "13158833767527", "product_code": "NNFA21000023", "title": "Dagsrevyen 21"},
    { "id": "13272583632527", "product_code": "DVFJ20000023", "title": "Norge i dag"}
]

Så kan man lese inn json på samme måte som før, siden en liste av JSON-objekter fortsatt er et gyldig JSON-format.

import json

with open("data.json", "r", encoding="utf-8") as fil:
    json_liste = json.load(fil)

Lista kalt json_liste vil da inneholde en lista av de JSON-objektene du leste inn fra fila, konvertert til oppslagstabeller.

For å kunne skrive JSON til en fil benytter vi oss av nesten samme kode som beskrevet i kapittel 2.2, men istedet for write() benytter vi json.dump():

import json

product = {
    "id": "12975534035527", 
    "product_code": "DVSF65100022", 
    "title": "Der ingen skulle tru at nokon kunne bu"
}

with open("data.json", "w", encoding="utf-8") as fil:
    json.dump(product, fil)

Merk at i eksemplet over så overskriver vi innholdet i fila data.json, men i enkelte tilfeller ønsker vi kanskje å tilføye data til en allerede eksisterende JSON-struktur. Det kan tenkes at å kun erstatte w med a er nok for å kunne legge til innhold i fila, men dette kan tukle med JSON-strukturen som allerede finnes i fila. Det beste er derfor å lese inn hele innholdet i fila for deretter å legge til ønsket JSON-objekt før man til slutt skriver innholdet til fila på nytt igjen:

import json

with open("data.json", "r", encoding="utf-8") as fil:
    json_data = json.load(fil)

new_product = {
    "id": "98975534655545", 
    "product_code": "MUHU65100022", 
    "title": "Der alle skulle tru at nokon kunne bu"
}

json_data.append(new_product)

with open("data.json", "w", encoding="utf-8") as fil:
    json.dump(json_data, fil, indent=2)

⚠️ Obs! I eksemplet over tar vi høyde for at innholdet i data.json er strukturert som en liste av JSON-objekter

Resultatet av koden over er at JSON-fila nå ser slik ut.

[
  {
    "id": "12975534035527",
    "product_code": "DVSF65100022",
    "title": "Der ingen skulle tru at nokon kunne bu"
  },
  {
    "id": "98975534655545",
    "product_code": "MUHU65100022",
    "title": "Der alle skulle tru at nokon kunne bu"
  }
]

✍️ Oppgave Prøv deg frem! Ta utgangspunkt i JSON-eksemplene nevnt over, eller lag helt nye strukturer, og gjør et forsøk på å både lese og skrive til fil. Klarer du å f.eks. å lese inn en JSON, gjøre endringer og så skrive den til samme eller ny fil?

Programmeringskurs

JSON: Et dataformat