httpx/exceptions/index.html
2024-12-06 15:37:25 +00:00

1285 lines
40 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/exceptions/">
<link rel="prev" href="../api/">
<link rel="next" href="../environment_variables/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.47">
<title>Exceptions - 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="#exceptions" 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">
Exceptions
</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">
<a href="../quickstart/" class="md-nav__link">
<span class="md-ellipsis">
QuickStart
</span>
</a>
</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--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<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="true">
<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 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">
Exceptions
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Exceptions
</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="#the-exception-hierarchy" class="md-nav__link">
<span class="md-ellipsis">
The exception hierarchy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#exception-classes" class="md-nav__link">
<span class="md-ellipsis">
Exception classes
</span>
</a>
</li>
</ul>
</nav>
</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="#the-exception-hierarchy" class="md-nav__link">
<span class="md-ellipsis">
The exception hierarchy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#exception-classes" class="md-nav__link">
<span class="md-ellipsis">
Exception classes
</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="exceptions">Exceptions</h1>
<p>This page lists exceptions that may be raised when using HTTPX.</p>
<p>For an overview of how to work with HTTPX exceptions, see <a href="../quickstart/#exceptions">Exceptions (Quickstart)</a>.</p>
<h2 id="the-exception-hierarchy">The exception hierarchy</h2>
<ul>
<li>HTTPError<ul>
<li>RequestError<ul>
<li>TransportError<ul>
<li>TimeoutException<ul>
<li>ConnectTimeout</li>
<li>ReadTimeout</li>
<li>WriteTimeout</li>
<li>PoolTimeout</li>
</ul>
</li>
<li>NetworkError<ul>
<li>ConnectError</li>
<li>ReadError</li>
<li>WriteError</li>
<li>CloseError</li>
</ul>
</li>
<li>ProtocolError<ul>
<li>LocalProtocolError</li>
<li>RemoteProtocolError</li>
</ul>
</li>
<li>ProxyError</li>
<li>UnsupportedProtocol</li>
</ul>
</li>
<li>DecodingError</li>
<li>TooManyRedirects</li>
</ul>
</li>
<li>HTTPStatusError</li>
</ul>
</li>
<li>InvalidURL</li>
<li>CookieConflict</li>
<li>StreamError<ul>
<li>StreamConsumed</li>
<li>ResponseNotRead</li>
<li>RequestNotRead</li>
<li>StreamClosed</li>
</ul>
</li>
</ul>
<hr />
<h2 id="exception-classes">Exception classes</h2>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>HTTPError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Base class for <code>RequestError</code> and <code>HTTPStatusError</code>.</p>
<p>Useful for <code>try...except</code> blocks when issuing a request,
and then calling <code>.raise_for_status()</code>.</p>
<p>For example:</p>
<div class="highlight"><pre><span></span><code><span class="k">try</span><span class="o">:</span>
<span class="w"> </span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">httpx</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="s2">&quot;https://www.example.com&quot;</span><span class="o">)</span>
<span class="w"> </span><span class="n">response</span><span class="o">.</span><span class="na">raise_for_status</span><span class="o">()</span>
<span class="n">except</span><span class="w"> </span><span class="n">httpx</span><span class="o">.</span><span class="na">HTTPError</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">exc</span><span class="o">:</span>
<span class="w"> </span><span class="n">print</span><span class="o">(</span><span class="n">f</span><span class="s2">&quot;HTTP Exception for {exc.request.url} - {exc}&quot;</span><span class="o">)</span>
</code></pre></div></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>RequestError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Base class for all exceptions that may occur when issuing a <code>.request()</code>.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>TransportError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Base class for all exceptions that occur at the level of the Transport API.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>TimeoutException</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>The base class for timeout errors.</p>
<p>An operation has timed out.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ConnectTimeout</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Timed out while connecting to the host.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ReadTimeout</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Timed out while receiving data from the host.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>WriteTimeout</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Timed out while sending data to the host.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>PoolTimeout</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Timed out waiting to acquire a connection from the pool.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>NetworkError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>The base class for network-related errors.</p>
<p>An error occurred while interacting with the network.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ConnectError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Failed to establish a connection.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ReadError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Failed to receive data from the network.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>WriteError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Failed to send data through the network.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>CloseError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Failed to close a connection.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ProtocolError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>The protocol was violated.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>LocalProtocolError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>A protocol was violated by the client.</p>
<p>For example if the user instantiated a <code>Request</code> instance explicitly,
failed to include the mandatory <code>Host:</code> header, and then issued it directly
using <code>client.send()</code>.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>RemoteProtocolError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>The protocol was violated by the server.</p>
<p>For example, returning malformed HTTP.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ProxyError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>An error occurred while establishing a proxy connection.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>UnsupportedProtocol</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Attempted to make a request to an unsupported protocol.</p>
<p>For example issuing a request to <code>ftp://www.example.com</code>.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>DecodingError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Decoding of the response failed, due to a malformed encoding.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>TooManyRedirects</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request=None</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Too many redirects.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>HTTPStatusError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">*</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">request</em><span class="autodoc-punctuation">, </span><em class="autodoc-param">response</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>The response had an error HTTP status of 4xx or 5xx.</p>
<p>May be raised when calling <code>response.raise_for_status()</code></p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>InvalidURL</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>URL is improperly formed or cannot be parsed.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>CookieConflict</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Attempted to lookup a cookie by name, but multiple cookies existed.</p>
<p>Can occur when calling <code>response.cookies.get(...)</code>.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>StreamError</strong></code><span class="autodoc-punctuation">(</span><em class="autodoc-param">message</em><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>The base class for stream exceptions.</p>
<p>The developer made an error in accessing the request stream in
an invalid way.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>StreamConsumed</strong></code><span class="autodoc-punctuation">(</span><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Attempted to read or stream content, but the content has already
been streamed.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>StreamClosed</strong></code><span class="autodoc-punctuation">(</span><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Attempted to read or stream response content, but the request has been
closed.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>ResponseNotRead</strong></code><span class="autodoc-punctuation">(</span><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Attempted to access streaming response content, without having called <code>read()</code>.</p></div>
</div>
<div class="autodoc">
<div class="autodoc-signature"><em>class </em><code>httpx.<strong>RequestNotRead</strong></code><span class="autodoc-punctuation">(</span><span class="autodoc-punctuation">)</span></div>
<div class="autodoc-docstring"><p>Attempted to access streaming request content, without having called <code>read()</code>.</p></div>
</div>
</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>