1792 lines
77 KiB
HTML
1792 lines
77 KiB
HTML
|
||
<!doctype html>
|
||
<html lang="en" class="no-js">
|
||
<head>
|
||
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
||
<meta name="description" content="A next-generation HTTP client for Python.">
|
||
|
||
|
||
|
||
<link rel="canonical" href="https://www.python-httpx.org/quickstart/">
|
||
|
||
|
||
<link rel="prev" href="..">
|
||
|
||
|
||
<link rel="next" href="../advanced/clients/">
|
||
|
||
|
||
<link rel="icon" href="../assets/images/favicon.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
|
||
|
||
|
||
|
||
<title>QuickStart - HTTPX</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/stylesheets/main.6f8fc17f.min.css">
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../css/custom.css">
|
||
|
||
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
|
||
|
||
|
||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||
<label class="md-overlay" for="__drawer"></label>
|
||
<div data-md-component="skip">
|
||
|
||
|
||
<a href="#quickstart" class="md-skip">
|
||
Skip to content
|
||
</a>
|
||
|
||
</div>
|
||
<div data-md-component="announce">
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<header class="md-header md-header--shadow" data-md-component="header">
|
||
<nav class="md-header__inner md-grid" aria-label="Header">
|
||
<a href=".." title="HTTPX" class="md-header__button md-logo" aria-label="HTTPX" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
|
||
|
||
</a>
|
||
<label class="md-header__button md-icon" for="__drawer">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||
</label>
|
||
<div class="md-header__title" data-md-component="header-title">
|
||
<div class="md-header__ellipsis">
|
||
<div class="md-header__topic">
|
||
<span class="md-ellipsis">
|
||
HTTPX
|
||
</span>
|
||
</div>
|
||
<div class="md-header__topic" data-md-component="header-topic">
|
||
<span class="md-ellipsis">
|
||
|
||
QuickStart
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<form class="md-header__option" data-md-component="palette">
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9z"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="blue" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5"/></svg>
|
||
</label>
|
||
|
||
|
||
</form>
|
||
|
||
|
||
|
||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||
|
||
|
||
|
||
<label class="md-header__button md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
</label>
|
||
<div class="md-search" data-md-component="search" role="dialog">
|
||
<label class="md-search__overlay" for="__search"></label>
|
||
<div class="md-search__inner" role="search">
|
||
<form class="md-search__form" name="search">
|
||
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||
<label class="md-search__icon md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</label>
|
||
<nav class="md-search__options" aria-label="Search">
|
||
|
||
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||
</button>
|
||
</nav>
|
||
|
||
</form>
|
||
<div class="md-search__output">
|
||
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||
<div class="md-search-result" data-md-component="search-result">
|
||
<div class="md-search-result__meta">
|
||
Initializing search
|
||
</div>
|
||
<ol class="md-search-result__list" role="presentation"></ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="md-header__source">
|
||
<a href="https://github.com/encode/httpx/" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
encode/httpx
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
</header>
|
||
|
||
<div class="md-container" data-md-component="container">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<main class="md-main" data-md-component="main">
|
||
<div class="md-main__inner md-grid">
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
<!-- Determine class according to configuration -->
|
||
|
||
|
||
|
||
|
||
<!-- Main navigation -->
|
||
<nav
|
||
class="md-nav md-nav--primary"
|
||
aria-label="nav.title"
|
||
data-md-level="0"
|
||
>
|
||
|
||
<!-- Site title -->
|
||
<label class="md-nav__title" for="__drawer">
|
||
<a
|
||
href=".."
|
||
title="HTTPX"
|
||
class="md-nav__button md-logo"
|
||
aria-label="HTTPX"
|
||
data-md-component="logo"
|
||
>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
|
||
|
||
</a>
|
||
HTTPX
|
||
</label>
|
||
|
||
<!-- Repository information -->
|
||
|
||
<div class="md-nav__source">
|
||
<a href="https://github.com/encode/httpx/" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
encode/httpx
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
|
||
<!-- Navigation list -->
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href=".." class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Introduction
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active">
|
||
|
||
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
QuickStart
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
QuickStart
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#passing-parameters-in-urls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Passing Parameters in URLs
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#response-content" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Response Content
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#binary-response-content" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Binary Response Content
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#json-response-content" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
JSON Response Content
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#custom-headers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Custom Headers
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-form-encoded-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending Form Encoded Data
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-multipart-file-uploads" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending Multipart File Uploads
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-json-encoded-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending JSON Encoded Data
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-binary-request-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending Binary Request Data
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#response-status-codes" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Response Status Codes
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#response-headers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Response Headers
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#streaming-responses" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Streaming Responses
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#cookies" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Cookies
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#redirection-and-history" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Redirection and History
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#timeouts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Timeouts
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#authentication" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Authentication
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#exceptions" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Exceptions
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Advanced
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Advanced
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/clients/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Clients
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/authentication/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Authentication
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/ssl/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
SSL
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/proxies/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Proxies
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/timeouts/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Timeouts
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/resource-limits/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Resource Limits
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/event-hooks/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Event Hooks
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/transports/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Transports
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/text-encodings/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Text Encodings
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../advanced/extensions/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Extensions
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Guides
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Guides
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../async/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Async Support
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../http2/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
HTTP/2 Support
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../logging/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Logging
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../compatibility/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Requests Compatibility
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../troubleshooting/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Troubleshooting
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
API Reference
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_5">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
API Reference
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../api/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Developer Interface
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../exceptions/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Exceptions
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../environment_variables/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Environment Variables
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Community
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_6">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Community
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../third_party_packages/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Third Party Packages
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../contributing/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Contributing
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../code_of_conduct/" class="md-nav__link">
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Code of Conduct
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
|
||
<ul class="md-nav__list" data-md-scrollfix style="padding-top: 15px; padding-left: 10px">
|
||
<div>
|
||
<a href="https://speakeasy.com"><img src="/img/speakeasy.png" width=150px style=></img></a>
|
||
</div>
|
||
</ul>
|
||
</nav>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#passing-parameters-in-urls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Passing Parameters in URLs
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#response-content" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Response Content
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#binary-response-content" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Binary Response Content
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#json-response-content" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
JSON Response Content
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#custom-headers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Custom Headers
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-form-encoded-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending Form Encoded Data
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-multipart-file-uploads" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending Multipart File Uploads
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-json-encoded-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending JSON Encoded Data
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sending-binary-request-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Sending Binary Request Data
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#response-status-codes" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Response Status Codes
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#response-headers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Response Headers
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#streaming-responses" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Streaming Responses
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#cookies" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Cookies
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#redirection-and-history" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Redirection and History
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#timeouts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Timeouts
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#authentication" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Authentication
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#exceptions" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Exceptions
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
<h1 id="quickstart">QuickStart</h1>
|
||
<p>First, start by importing HTTPX:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">httpx</span>
|
||
</code></pre></div>
|
||
|
||
<p>Now, let’s try to get a webpage.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/get'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span>
|
||
<span class="go"><Response [200 OK]></span>
|
||
</code></pre></div>
|
||
|
||
<p>Similarly, to make an HTTP POST request:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">'https://httpbin.org/post'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">'key'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">})</span>
|
||
</code></pre></div>
|
||
|
||
<p>The PUT, DELETE, HEAD, and OPTIONS requests all follow the same style:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s1">'https://httpbin.org/put'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">'key'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">})</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="s1">'https://httpbin.org/delete'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">head</span><span class="p">(</span><span class="s1">'https://httpbin.org/get'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">options</span><span class="p">(</span><span class="s1">'https://httpbin.org/get'</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="passing-parameters-in-urls">Passing Parameters in URLs</h2>
|
||
<p>To include URL query parameters in the request, use the <code>params</code> keyword:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'key1'</span><span class="p">:</span> <span class="s1">'value1'</span><span class="p">,</span> <span class="s1">'key2'</span><span class="p">:</span> <span class="s1">'value2'</span><span class="p">}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/get'</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>To see how the values get encoding into the URL string, we can inspect the
|
||
resulting URL that was used to make the request:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">url</span>
|
||
<span class="go">URL('https://httpbin.org/get?key2=value2&key1=value1')</span>
|
||
</code></pre></div>
|
||
|
||
<p>You can also pass a list of items as a value:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'key1'</span><span class="p">:</span> <span class="s1">'value1'</span><span class="p">,</span> <span class="s1">'key2'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'value2'</span><span class="p">,</span> <span class="s1">'value3'</span><span class="p">]}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/get'</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">url</span>
|
||
<span class="go">URL('https://httpbin.org/get?key1=value1&key2=value2&key2=value3')</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="response-content">Response Content</h2>
|
||
<p>HTTPX will automatically handle decoding the response content into Unicode text.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://www.example.org/'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">text</span>
|
||
<span class="go">'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'</span>
|
||
</code></pre></div>
|
||
|
||
<p>You can inspect what encoding will be used to decode the response.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">encoding</span>
|
||
<span class="go">'UTF-8'</span>
|
||
</code></pre></div>
|
||
|
||
<p>In some cases the response may not contain an explicit encoding, in which case HTTPX
|
||
will attempt to automatically determine an encoding to use.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">encoding</span>
|
||
<span class="go">None</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">text</span>
|
||
<span class="go">'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'</span>
|
||
</code></pre></div>
|
||
|
||
<p>If you need to override the standard behaviour and explicitly set the encoding to
|
||
use, then you can do that too.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="s1">'ISO-8859-1'</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="binary-response-content">Binary Response Content</h2>
|
||
<p>The response content can also be accessed as bytes, for non-text responses:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">content</span>
|
||
<span class="go">b'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'</span>
|
||
</code></pre></div>
|
||
|
||
<p>Any <code>gzip</code> and <code>deflate</code> HTTP response encodings will automatically
|
||
be decoded for you. If <code>brotlipy</code> is installed, then the <code>brotli</code> response
|
||
encoding will be supported. If <code>zstandard</code> is installed, then <code>zstd</code>
|
||
response encodings will also be supported.</p>
|
||
<p>For example, to create an image from binary data returned by a request, you can use the following code:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">PIL</span><span class="w"> </span><span class="kn">import</span> <span class="n">Image</span>
|
||
<span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">io</span><span class="w"> </span><span class="kn">import</span> <span class="n">BytesIO</span>
|
||
<span class="gp">>>> </span><span class="n">i</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">BytesIO</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">content</span><span class="p">))</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="json-response-content">JSON Response Content</h2>
|
||
<p>Often Web API responses will be encoded as JSON.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://api.github.com/events'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
||
<span class="go">[{u'repository': {u'open_issues': 0, u'url': 'https://github.com/...' ... }}]</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="custom-headers">Custom Headers</h2>
|
||
<p>To include additional headers in the outgoing request, use the <code>headers</code> keyword argument:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">url</span> <span class="o">=</span> <span class="s1">'https://httpbin.org/headers'</span>
|
||
<span class="gp">>>> </span><span class="n">headers</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'user-agent'</span><span class="p">:</span> <span class="s1">'my-app/0.0.1'</span><span class="p">}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="sending-form-encoded-data">Sending Form Encoded Data</h2>
|
||
<p>Some types of HTTP requests, such as <code>POST</code> and <code>PUT</code> requests, can include data
|
||
in the request body. One common way of including that is as form-encoded data,
|
||
which is used for HTML forms.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'key1'</span><span class="p">:</span> <span class="s1">'value1'</span><span class="p">,</span> <span class="s1">'key2'</span><span class="p">:</span> <span class="s1">'value2'</span><span class="p">}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
<span class="go">{</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go"> "form": {</span>
|
||
<span class="go"> "key2": "value2",</span>
|
||
<span class="go"> "key1": "value1"</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go">}</span>
|
||
</code></pre></div>
|
||
|
||
<p>Form encoded data can also include multiple values from a given key.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'key1'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'value1'</span><span class="p">,</span> <span class="s1">'value2'</span><span class="p">]}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
<span class="go">{</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go"> "form": {</span>
|
||
<span class="go"> "key1": [</span>
|
||
<span class="go"> "value1",</span>
|
||
<span class="go"> "value2"</span>
|
||
<span class="go"> ]</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go">}</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="sending-multipart-file-uploads">Sending Multipart File Uploads</h2>
|
||
<p>You can also upload files, using HTTP multipart encoding:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'report.xls'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">report_file</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="n">files</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'upload-file'</span><span class="p">:</span> <span class="n">report_file</span><span class="p">}</span>
|
||
<span class="gp">... </span> <span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">files</span><span class="o">=</span><span class="n">files</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
<span class="go">{</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go"> "files": {</span>
|
||
<span class="go"> "upload-file": "<... binary content ...>"</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go">}</span>
|
||
</code></pre></div>
|
||
|
||
<p>You can also explicitly set the filename and content type, by using a tuple
|
||
of items for the file value:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'report.xls'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="n">report_file</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="n">files</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'upload-file'</span><span class="p">:</span> <span class="p">(</span><span class="s1">'report.xls'</span><span class="p">,</span> <span class="n">report_file</span><span class="p">,</span> <span class="s1">'application/vnd.ms-excel'</span><span class="p">)}</span>
|
||
<span class="gp">... </span> <span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">files</span><span class="o">=</span><span class="n">files</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
<span class="go">{</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go"> "files": {</span>
|
||
<span class="go"> "upload-file": "<... binary content ...>"</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go">}</span>
|
||
</code></pre></div>
|
||
|
||
<p>If you need to include non-file data fields in the multipart form, use the <code>data=...</code> parameter:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'message'</span><span class="p">:</span> <span class="s1">'Hello, world!'</span><span class="p">}</span>
|
||
<span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'report.xls'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">report_file</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="n">files</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'file'</span><span class="p">:</span> <span class="n">report_file</span><span class="p">}</span>
|
||
<span class="gp">... </span> <span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">,</span> <span class="n">files</span><span class="o">=</span><span class="n">files</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
<span class="go">{</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go"> "files": {</span>
|
||
<span class="go"> "file": "<... binary content ...>"</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> "form": {</span>
|
||
<span class="go"> "message": "Hello, world!",</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go">}</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="sending-json-encoded-data">Sending JSON Encoded Data</h2>
|
||
<p>Form encoded data is okay if all you need is a simple key-value data structure.
|
||
For more complicated data structures you'll often want to use JSON encoding instead.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'integer'</span><span class="p">:</span> <span class="mi">123</span><span class="p">,</span> <span class="s1">'boolean'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'list'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'a'</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">,</span> <span class="s1">'c'</span><span class="p">]}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
<span class="go">{</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go"> "json": {</span>
|
||
<span class="go"> "boolean": true,</span>
|
||
<span class="go"> "integer": 123,</span>
|
||
<span class="go"> "list": [</span>
|
||
<span class="go"> "a",</span>
|
||
<span class="go"> "b",</span>
|
||
<span class="go"> "c"</span>
|
||
<span class="go"> ]</span>
|
||
<span class="go"> },</span>
|
||
<span class="go"> ...</span>
|
||
<span class="go">}</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="sending-binary-request-data">Sending Binary Request Data</h2>
|
||
<p>For other encodings, you should use the <code>content=...</code> parameter, passing
|
||
either a <code>bytes</code> type or a generator that yields <code>bytes</code>.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">content</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">'Hello, world'</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">"https://httpbin.org/post"</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="n">content</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>You may also want to set a custom <code>Content-Type</code> header when uploading
|
||
binary data.</p>
|
||
<h2 id="response-status-codes">Response Status Codes</h2>
|
||
<p>We can inspect the HTTP status code of the response:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/get'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">status_code</span>
|
||
<span class="go">200</span>
|
||
</code></pre></div>
|
||
|
||
<p>HTTPX also includes an easy shortcut for accessing status codes by their text phrase.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="n">httpx</span><span class="o">.</span><span class="n">codes</span><span class="o">.</span><span class="n">OK</span>
|
||
<span class="go">True</span>
|
||
</code></pre></div>
|
||
|
||
<p>We can raise an exception for any responses which are not a 2xx success code:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">not_found</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/status/404'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">not_found</span><span class="o">.</span><span class="n">status_code</span>
|
||
<span class="go">404</span>
|
||
<span class="gp">>>> </span><span class="n">not_found</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
||
<span class="gt">Traceback (most recent call last):</span>
|
||
File <span class="nb">"/Users/tomchristie/GitHub/encode/httpcore/httpx/models.py"</span>, line <span class="m">837</span>, in <span class="n">raise_for_status</span>
|
||
<span class="w"> </span><span class="k">raise</span> <span class="n">HTTPStatusError</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">response</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
|
||
<span class="gr">httpx._exceptions.HTTPStatusError</span>: <span class="n">404 Client Error: Not Found for url: https://httpbin.org/status/404</span>
|
||
<span class="x">For more information check: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404</span>
|
||
</code></pre></div>
|
||
|
||
<p>Any successful response codes will return the <code>Response</code> instance rather than raising an exception.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
||
</code></pre></div>
|
||
|
||
<p>The method returns the response instance, allowing you to use it inline. For example:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'...'</span><span class="p">)</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'...'</span><span class="p">)</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="response-headers">Response Headers</h2>
|
||
<p>The response headers are available as a dictionary-like interface.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headers</span>
|
||
<span class="go">Headers({</span>
|
||
<span class="go"> 'content-encoding': 'gzip',</span>
|
||
<span class="go"> 'transfer-encoding': 'chunked',</span>
|
||
<span class="go"> 'connection': 'close',</span>
|
||
<span class="go"> 'server': 'nginx/1.0.4',</span>
|
||
<span class="go"> 'x-runtime': '148ms',</span>
|
||
<span class="go"> 'etag': '"e1ca502697e5c9317743dc078f67693f"',</span>
|
||
<span class="go"> 'content-type': 'application/json'</span>
|
||
<span class="go">})</span>
|
||
</code></pre></div>
|
||
|
||
<p>The <code>Headers</code> data type is case-insensitive, so you can use any capitalization.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Content-Type'</span><span class="p">]</span>
|
||
<span class="go">'application/json'</span>
|
||
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'content-type'</span><span class="p">)</span>
|
||
<span class="go">'application/json'</span>
|
||
</code></pre></div>
|
||
|
||
<p>Multiple values for a single response header are represented as a single comma-separated value, as per <a href="https://tools.ietf.org/html/rfc7230#section-3.2">RFC 7230</a>:</p>
|
||
<blockquote>
|
||
<p>A recipient MAY combine multiple header fields with the same field name into one “field-name: field-value” pair, without changing the semantics of the message, by appending each subsequent field-value to the combined field value in order, separated by a comma.</p>
|
||
</blockquote>
|
||
<h2 id="streaming-responses">Streaming Responses</h2>
|
||
<p>For large downloads you may want to use streaming responses that do not load the entire response body into memory at once.</p>
|
||
<p>You can stream the binary content of the response...</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">stream</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"https://www.example.com"</span><span class="p">)</span> <span class="k">as</span> <span class="n">r</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="k">for</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">iter_bytes</span><span class="p">():</span>
|
||
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>Or the text of the response...</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">stream</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"https://www.example.com"</span><span class="p">)</span> <span class="k">as</span> <span class="n">r</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="k">for</span> <span class="n">text</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">iter_text</span><span class="p">():</span>
|
||
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>Or stream the text, on a line-by-line basis...</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">stream</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"https://www.example.com"</span><span class="p">)</span> <span class="k">as</span> <span class="n">r</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">iter_lines</span><span class="p">():</span>
|
||
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>HTTPX will use universal line endings, normalising all cases to <code>\n</code>.</p>
|
||
<p>In some cases you might want to access the raw bytes on the response without applying any HTTP content decoding. In this case any content encoding that the web server has applied such as <code>gzip</code>, <code>deflate</code>, <code>brotli</code>, or <code>zstd</code> will
|
||
not be automatically decoded.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">stream</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"https://www.example.com"</span><span class="p">)</span> <span class="k">as</span> <span class="n">r</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">iter_raw</span><span class="p">():</span>
|
||
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>If you're using streaming responses in any of these ways then the <code>response.content</code> and <code>response.text</code> attributes will not be available, and will raise errors if accessed. However you can also use the response streaming functionality to conditionally load the response body:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">stream</span><span class="p">(</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"https://www.example.com"</span><span class="p">)</span> <span class="k">as</span> <span class="n">r</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Content-Length'</span><span class="p">])</span> <span class="o"><</span> <span class="n">TOO_LONG</span><span class="p">:</span>
|
||
<span class="gp">... </span> <span class="n">r</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
|
||
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="cookies">Cookies</h2>
|
||
<p>Any cookies that are set on the response can be easily accessed:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/cookies/set?chocolate=chip'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="s1">'chocolate'</span><span class="p">]</span>
|
||
<span class="go">'chip'</span>
|
||
</code></pre></div>
|
||
|
||
<p>To include cookies in an outgoing request, use the <code>cookies</code> parameter:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">cookies</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"peanut"</span><span class="p">:</span> <span class="s2">"butter"</span><span class="p">}</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://httpbin.org/cookies'</span><span class="p">,</span> <span class="n">cookies</span><span class="o">=</span><span class="n">cookies</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
||
<span class="go">{'cookies': {'peanut': 'butter'}}</span>
|
||
</code></pre></div>
|
||
|
||
<p>Cookies are returned in a <code>Cookies</code> instance, which is a dict-like data structure
|
||
with additional API for accessing cookies by their domain or path.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">cookies</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Cookies</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">cookies</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'cookie_on_domain'</span><span class="p">,</span> <span class="s1">'hello, there!'</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="s1">'httpbin.org'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">cookies</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'cookie_off_domain'</span><span class="p">,</span> <span class="s1">'nope.'</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="s1">'example.org'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'http://httpbin.org/cookies'</span><span class="p">,</span> <span class="n">cookies</span><span class="o">=</span><span class="n">cookies</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
||
<span class="go">{'cookies': {'cookie_on_domain': 'hello, there!'}}</span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="redirection-and-history">Redirection and History</h2>
|
||
<p>By default, HTTPX will <strong>not</strong> follow redirects for all HTTP methods, although
|
||
this can be explicitly enabled.</p>
|
||
<p>For example, GitHub redirects all HTTP requests to HTTPS.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'http://github.com/'</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">status_code</span>
|
||
<span class="go">301</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">history</span>
|
||
<span class="go">[]</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">next_request</span>
|
||
<span class="go"><Request('GET', 'https://github.com/')></span>
|
||
</code></pre></div>
|
||
|
||
<p>You can modify the default redirection handling with the <code>follow_redirects</code> parameter:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'http://github.com/'</span><span class="p">,</span> <span class="n">follow_redirects</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">url</span>
|
||
<span class="go">URL('https://github.com/')</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">status_code</span>
|
||
<span class="go">200</span>
|
||
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">history</span>
|
||
<span class="go">[<Response [301 Moved Permanently]>]</span>
|
||
</code></pre></div>
|
||
|
||
<p>The <code>history</code> property of the response can be used to inspect any followed redirects.
|
||
It contains a list of any redirect responses that were followed, in the order
|
||
in which they were made.</p>
|
||
<h2 id="timeouts">Timeouts</h2>
|
||
<p>HTTPX defaults to including reasonable timeouts for all network operations,
|
||
meaning that if a connection is not properly established then it should always
|
||
raise an error rather than hanging indefinitely.</p>
|
||
<p>The default timeout for network inactivity is five seconds. You can modify the
|
||
value to be more or less strict:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://github.com/'</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mf">0.001</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>You can also disable the timeout behavior completely...</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://github.com/'</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>For advanced timeout management, see <a href="../advanced/timeouts/#fine-tuning-the-configuration">Timeout fine-tuning</a>.</p>
|
||
<h2 id="authentication">Authentication</h2>
|
||
<p>HTTPX supports Basic and Digest HTTP authentication.</p>
|
||
<p>To provide Basic authentication credentials, pass a 2-tuple of
|
||
plaintext <code>str</code> or <code>bytes</code> objects as the <code>auth</code> argument to the request
|
||
functions:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://example.com"</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="p">(</span><span class="s2">"my_user"</span><span class="p">,</span> <span class="s2">"password123"</span><span class="p">))</span>
|
||
</code></pre></div>
|
||
|
||
<p>To provide credentials for Digest authentication you'll need to instantiate
|
||
a <code>DigestAuth</code> object with the plaintext username and password as arguments.
|
||
This object can be then passed as the <code>auth</code> argument to the request methods
|
||
as above:</p>
|
||
<div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">auth</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">DigestAuth</span><span class="p">(</span><span class="s2">"my_user"</span><span class="p">,</span> <span class="s2">"password123"</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://example.com"</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="n">auth</span><span class="p">)</span>
|
||
<span class="go"><Response [200 OK]></span>
|
||
</code></pre></div>
|
||
|
||
<h2 id="exceptions">Exceptions</h2>
|
||
<p>HTTPX will raise exceptions if an error occurs.</p>
|
||
<p>The most important exception classes in HTTPX are <code>RequestError</code> and <code>HTTPStatusError</code>.</p>
|
||
<p>The <code>RequestError</code> class is a superclass that encompasses any exception that occurs
|
||
while issuing an HTTP request. These exceptions include a <code>.request</code> attribute.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="k">try</span><span class="p">:</span>
|
||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://www.example.com/"</span><span class="p">)</span>
|
||
<span class="k">except</span> <span class="n">httpx</span><span class="o">.</span><span class="n">RequestError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"An error occurred while requesting </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>The <code>HTTPStatusError</code> class is raised by <code>response.raise_for_status()</code> on responses which are not a 2xx success code.
|
||
These exceptions include both a <code>.request</code> and a <code>.response</code> attribute.</p>
|
||
<div class="highlight"><pre><span></span><code><span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://www.example.com/"</span><span class="p">)</span>
|
||
<span class="k">try</span><span class="p">:</span>
|
||
<span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
||
<span class="k">except</span> <span class="n">httpx</span><span class="o">.</span><span class="n">HTTPStatusError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error response </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2"> while requesting </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>There is also a base class <code>HTTPError</code> that includes both of these categories, and can be used
|
||
to catch either failed requests, or 4xx and 5xx responses.</p>
|
||
<p>You can either use this base class to catch both categories...</p>
|
||
<div class="highlight"><pre><span></span><code><span class="k">try</span><span class="p">:</span>
|
||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://www.example.com/"</span><span class="p">)</span>
|
||
<span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
||
<span class="k">except</span> <span class="n">httpx</span><span class="o">.</span><span class="n">HTTPError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error while requesting </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>Or handle each case explicitly...</p>
|
||
<div class="highlight"><pre><span></span><code><span class="k">try</span><span class="p">:</span>
|
||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://www.example.com/"</span><span class="p">)</span>
|
||
<span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
||
<span class="k">except</span> <span class="n">httpx</span><span class="o">.</span><span class="n">RequestError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"An error occurred while requesting </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||
<span class="k">except</span> <span class="n">httpx</span><span class="o">.</span><span class="n">HTTPStatusError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error response </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2"> while requesting </span><span class="si">{</span><span class="n">exc</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<p>For a full list of available exceptions, see <a href="../exceptions/">Exceptions (API Reference)</a>.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||
</div>
|
||
|
||
</main>
|
||
|
||
<footer class="md-footer">
|
||
|
||
<div class="md-footer-meta md-typeset">
|
||
<div class="md-footer-meta__inner md-grid">
|
||
<div class="md-copyright">
|
||
|
||
|
||
Made with
|
||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||
Material for MkDocs
|
||
</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
<div class="md-dialog" data-md-component="dialog">
|
||
<div class="md-dialog__inner md-typeset"></div>
|
||
</div>
|
||
|
||
|
||
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
|
||
|
||
|
||
<script src="../assets/javascripts/bundle.83f73b43.min.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |