requests — HTTP-kliens

A requests modul egy minimális HTTP/HTTPS kliens API-t biztosít, amely hasonló a Python requests könyvtárhoz. Minden kérésfüggvény egy requests.Response objektumot ad vissza.

Példa:

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 osztály

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

Egy HTTP-választ képvisel. A példányokat a requests.request és a metódusonkénti segédfüggvények adják vissza.

status_code: int

A kiszolgáló által visszaadott egész HTTP-állapotkód.

reason: str

A kiszolgáló által visszaadott indoklási szöveg (dekódolt str).

encoding: str

A requests.Response.headers és a requests.Response.content dekódolásához használt karakterlánc-kódolás. Alapértelmezése "utf-8".

headers: str

A requests.Response.encoding segítségével dekódolt és str formában visszaadott válaszfejlécek.

content: str

A requests.Response.encoding segítségével dekódolt és str formában visszaadott választörzs.

json() → dict

A requests.Response.content JSON-ként történő elemzése és a kapott objektum visszaadása.

Függvények

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

HTTP-kérés küldése a url címre, és egy requests.Response visszaadása.

  • method — HTTP-metódus str formában (pl. "GET", "POST").

  • url — Cél-URL. http:// vagy https:// előtaggal kell kezdődnie.

  • data — Nyers kéréstörzs. Ha be van állítva, a Content-Length automatikusan hozzáadódik.

  • json — JSON-ba sorosított és a törzsként elküldött objektum. Beállítja a Content-Type: application/json fejlécet.

  • files — A mezőnevet egy (filename, fileobj) rekordhoz rendelő szótár. multipart/form-data formában küldve.

  • headers — További kérésfejlécek szótára.

  • auth — (username, password) rekord a HTTP Basic hitelesítéshez.

  • stream — API-kompatibilitás miatt elfogadott; nincs használatban.

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

HTTP HEAD kérés küldése és egy Response visszaadása.

A HEAD megegyezik a GET kéréssel, kivéve hogy a kiszolgáló csak az állapotsort és a fejléceket küldi vissza; a törzs üres. Használd annak ellenőrzésére, hogy létezik-e egy erőforrás, a Content-Length / Content-Type megvizsgálására a hasznos adat letöltése nélkül, vagy egy URL kipróbálására egy nagyobb GET kiadása előtt.

Argumentumok:

  • url – cél-URL; http:// vagy https:// előtaggal kell kezdődnie.

  • headers (kulcsszó) – további kérésfejlécek szótára.

  • auth (kulcsszó) – (username, password) rekord a HTTP Basic hitelesítéshez.

A request() függvény data / json / files / stream paraméterei a teljesség kedvéért elfogadottak, de HEAD esetén ritkán van értelmük.

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

HTTP GET kérés küldése és egy Response visszaadása.

A GET a szabványos ige a url által azonosított erőforrás reprezentációjának lekérésére. Biztonságos (nem okoz kiszolgálóoldali állapotváltozást) és idempotens.

Argumentumok:

  • url – cél-URL; http:// vagy https:// előtaggal kell kezdődnie.

  • headers (kulcsszó) – további kérésfejlécek szótára (például Authorization vagy Accept).

  • auth (kulcsszó) – (username, password) rekord a HTTP Basic hitelesítéshez.

A mögöttes request() engedélyezi a data / json kéréstörzset, de a legtöbb kiszolgáló figyelmen kívül hagyja.

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

HTTP POST kérés küldése és egy Response visszaadása.

A POST adatot küld a url címre, jellemzően egy új alárendelt erőforrást létrehozva, egy űrlapbeküldést kiváltva, vagy egy műveletet meghívva. Sem nem biztonságos, sem nem idempotens: az ismételt hívások duplikált erőforrásokat hozhatnak létre.

Argumentumok:

  • url – cél-URL; http:// vagy https:// előtaggal kell kezdődnie.

  • data (kulcsszó) – nyers kéréstörzs (bytes-szerű). Automatikusan elküld egy Content-Length fejlécet.

  • json (kulcsszó) – JSON-ba sorosított és a törzsként elküldött objektum. Beállítja a Content-Type: application/json fejlécet.

  • files (kulcsszó) – a mezőnevet egy (filename, fileobj) rekordhoz rendelő szótár. multipart/form-data formában küldve.

  • headers (kulcsszó) – további kérésfejlécek szótára.

  • auth (kulcsszó) – (username, password) rekord a HTTP Basic hitelesítéshez.

Legfeljebb egyet adj át a data / json / files közül.

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

HTTP PUT kérés küldése és egy Response visszaadása.

A PUT a url címen lévő erőforrást a megadott reprezentációval helyettesíti, és létrehozza, ha még nem létezik. Idempotens: egy azonos PUT megismétlése ugyanazt a végállapotot eredményezi.

Argumentumok:

  • url – cél-URL; http:// vagy https:// előtaggal kell kezdődnie.

  • data (kulcsszó) – nyers helyettesítő törzs (bytes-szerű).

  • json (kulcsszó) – JSON-ba sorosított és helyettesítő törzsként elküldött objektum. Beállítja a Content-Type: application/json fejlécet.

  • headers (kulcsszó) – további kérésfejlécek szótára.

  • auth (kulcsszó) – (username, password) rekord a HTTP Basic hitelesítéshez.

Add át a data vagy a json valamelyikét az új reprezentáció hordozásához.

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

HTTP PATCH kérés küldése és egy Response visszaadása.

A PATCH részleges módosítást alkalmaz a url címen lévő erőforrásra – csak a kéréstörzsben szereplő mezők változnak. A PUT kéréstől eltérően nem kötelező idempotensnek lennie (bár sok API azzá teszi).

Argumentumok:

  • url – cél-URL; http:// vagy https:// előtaggal kell kezdődnie.

  • data (kulcsszó) – nyers különbség-törzs (bytes-szerű). A formátum a kiszolgálótól függ (pl. JSON Patch, JSON Merge Patch).

  • json (kulcsszó) – JSON-ba sorosított különbség-objektum. Beállítja a Content-Type: application/json fejlécet.

  • headers (kulcsszó) – további kérésfejlécek szótára.

  • auth (kulcsszó) – (username, password) rekord a HTTP Basic hitelesítéshez.

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

HTTP DELETE kérés küldése és egy Response visszaadása.

A DELETE a url címen lévő erőforrás eltávolítását kéri. Idempotens: egy már törölt erőforrás törlése nem hiba (a kiszolgáló jellemzően 404-et ad vissza, de a végállapot ugyanaz).

Argumentumok:

  • url – cél-URL; http:// vagy https:// előtaggal kell kezdődnie.

  • headers (kulcsszó) – további kérésfejlécek szótára.

  • auth (kulcsszó) – (username, password) rekord a HTTP Basic hitelesítéshez.

A mögöttes request() engedélyez egy data / json törzset, de DELETE esetén ritkán használatos.