requests — HTTP-asiakas

requests-moduuli tarjoaa minimaalisen HTTP/HTTPS-asiakasrajapinnan, joka muistuttaa Python requests -kirjastoa. Jokainen pyyntöfunktio palauttaa requests.Response-olion.

Esimerkki:

import requests

# GET a JSON resource.
r = requests.get("https://httpbin.org/get")
print(r.status_code, r.reason)
print(r.json())

# POST JSON.
r = requests.post(
    "https://httpbin.org/post",
    json={"id": 1, "value": 42},
    headers={"X-Source": "openmv"},
)
print(r.json())

Response-luokka

class requests.Response(code: int, reason: str, headers: bytes = None, content: bytes = None)

Edustaa HTTP-vastausta. Ilmentymiä palauttavat requests.request ja metodikohtaiset apufunktiot.

status_code: int

Palvelimen palauttama kokonaislukumuotoinen HTTP-tilakoodi.

reason: str

Palvelimen palauttama syylause (puretaan tyyppiin str).

encoding: str

Merkkijonokoodaus, jota käytetään purkamaan requests.Response.headers ja requests.Response.content. Oletusarvo "utf-8".

headers: str

Vastauksen otsakkeet purettuna koodauksella requests.Response.encoding ja palautettuna tyyppinä str.

content: str

Vastauksen runko purettuna koodauksella requests.Response.encoding ja palautettuna tyyppinä str.

json() → dict

Jäsentää requests.Response.content-sisällön JSON-muodossa ja palauttaa tuloksena syntyvän olion.

Funktiot

requests.request(method: str, url: str, data: bytes | None = None, json: Any | None = None, files: dict | None = None, headers: dict = {}, auth: tuple | None = None, stream: Any | None = None) → Response

Lähettää HTTP-pyynnön osoitteeseen url ja palauttaa requests.Response-olion.

  • method — HTTP-metodi tyyppinä str (esim. "GET", "POST").

  • url — Kohdeosoite. Alettava merkeillä http:// tai https://.

  • data — Raaka pyyntörunko. Jos asetettu, Content-Length lisätään automaattisesti.

  • json — Olio, joka sarjallistetaan JSON-muotoon ja lähetetään runkona. Asettaa Content-Type: application/json.

  • files — Sanakirja, joka kuvaa kentän nimen monikkoon (filename, fileobj). Lähetetään muodossa multipart/form-data.

  • headers — Sanakirja lisäpyyntöotsakkeita.

  • auth — (username, password)-monikko HTTP Basic -todennusta varten.

  • stream — Hyväksytään API-yhteensopivuuden vuoksi; ei käytössä.

requests.head(url: str, **kw: Any) → Response

Lähettää HTTP-pyynnön HEAD ja palauttaa Response-olion.

HEAD on identtinen metodin GET kanssa paitsi että palvelin vastaa vain tilarivillä ja otsakkeilla; runko on tyhjä. Käytä sitä tarkistaaksesi, onko resurssi olemassa, tarkastellaksesi arvoja Content-Length / Content-Type lataamatta hyötykuormaa tai luodataksesi osoitetta ennen raskaamman GET-pyynnön tekemistä.

Argumentit:

  • url – kohdeosoite; alettava merkeillä http:// tai https://.

  • headers (avainsana) – sanakirja lisäpyyntöotsakkeita.

  • auth (avainsana) – (username, password)-monikko HTTP Basic -todennusta varten.

data / json / files / stream funktiosta request() hyväksytään täydellisyyden vuoksi, mutta ne ovat harvoin järkeviä metodin HEAD kanssa.

requests.get(url: str, **kw: Any) → Response

Lähettää HTTP-pyynnön GET ja palauttaa Response-olion.

GET on standardiverbi osoitteen url tunnistaman resurssin esityksen hakemiseen. Se on turvallinen (ei aiheuta palvelinpuolen tilamuutosta) ja idempotentti.

Argumentit:

  • url – kohdeosoite; alettava merkeillä http:// tai https://.

  • headers (avainsana) – sanakirja lisäpyyntöotsakkeita (esimerkiksi Authorization tai Accept).

  • auth (avainsana) – (username, password)-monikko HTTP Basic -todennusta varten.

Taustalla oleva request() sallii pyyntörungon parametrein data / json, mutta useimmat palvelimet jättävät sen huomiotta.

requests.post(url: str, **kw: Any) → Response

Lähettää HTTP-pyynnön POST ja palauttaa Response-olion.

POST lähettää dataa osoitteeseen url, tyypillisesti luoden uuden alisteisen resurssin, käynnistäen lomakkeen lähetyksen tai suorittaen toiminnon. Se ei ole turvallinen eikä idempotentti: toistuvat kutsut voivat luoda päällekkäisiä resursseja.

Argumentit:

  • url – kohdeosoite; alettava merkeillä http:// tai https://.

  • data (avainsana) – raaka pyyntörunko (bytes-tyyppinen). Lähettää Content-Length-otsakkeen automaattisesti.

  • json (avainsana) – olio, joka sarjallistetaan JSON-muotoon ja lähetetään runkona. Asettaa Content-Type: application/json.

  • files (avainsana) – sanakirja, joka kuvaa kentän nimen monikkoon (filename, fileobj). Lähetetään muodossa multipart/form-data.

  • headers (avainsana) – sanakirja lisäpyyntöotsakkeita.

  • auth (avainsana) – (username, password)-monikko HTTP Basic -todennusta varten.

Anna enintään yksi parametreista data / json / files.

requests.put(url: str, **kw: Any) → Response

Lähettää HTTP-pyynnön PUT ja palauttaa Response-olion.

PUT korvaa resurssin osoitteessa url annetulla esityksellä luoden sen, jos sitä ei ole olemassa. Se on idempotentti: identtisen PUT-pyynnön toistaminen tuottaa saman lopputilan.

Argumentit:

  • url – kohdeosoite; alettava merkeillä http:// tai https://.

  • data (avainsana) – raaka korvaava runko (bytes-tyyppinen).

  • json (avainsana) – olio, joka sarjallistetaan JSON-muotoon ja lähetetään korvaavana runkona. Asettaa Content-Type: application/json.

  • headers (avainsana) – sanakirja lisäpyyntöotsakkeita.

  • auth (avainsana) – (username, password)-monikko HTTP Basic -todennusta varten.

Anna joko data tai json kuljettamaan uutta esitystä.

requests.patch(url: str, **kw: Any) → Response

Lähettää HTTP-pyynnön PATCH ja palauttaa Response-olion.

PATCH soveltaa osittaisen muutoksen resurssiin osoitteessa url – vain pyyntörungossa sisältyvät kentät muuttuvat. Toisin kuin PUT, sen ei vaadita olevan idempotentti (vaikka monet API:t tekevät siitä sellaisen).

Argumentit:

  • url – kohdeosoite; alettava merkeillä http:// tai https://.

  • data (avainsana) – raaka deltarunko (bytes-tyyppinen). Muoto riippuu palvelimesta (esim. JSON Patch, JSON Merge Patch).

  • json (avainsana) – deltaolio, joka sarjallistetaan JSON-muotoon. Asettaa Content-Type: application/json.

  • headers (avainsana) – sanakirja lisäpyyntöotsakkeita.

  • auth (avainsana) – (username, password)-monikko HTTP Basic -todennusta varten.

requests.delete(url: str, **kw: Any) → Response

Lähettää HTTP-pyynnön DELETE ja palauttaa Response-olion.

DELETE pyytää resurssin poistamista osoitteessa url. Se on idempotentti: jo poistetun resurssin poistaminen ei ole virhe (palvelin palauttaa tyypillisesti 404:n, mutta lopputila on sama).

Argumentit:

  • url – kohdeosoite; alettava merkeillä http:// tai https://.

  • headers (avainsana) – sanakirja lisäpyyntöotsakkeita.

  • auth (avainsana) – (username, password)-monikko HTTP Basic -todennusta varten.

Taustalla oleva request() sallii rungon parametrein data / json, mutta sitä käytetään harvoin metodin DELETE kanssa.