Table of Contents

Table of Contents

• Introduction
  • Key Features
  • Library Installation
  • Getting Started
  • Tutorial
  • Source code
  • Dependencies
  • Communication channels
  • Contributing
  • Authors and License
  • Policy for Backward Incompatible Changes
  • Table Of Contents
• Client Usage
  • Make a Request
  • JSON Request
  • Passing Parameters In URLs
  • Response Content
  • Binary Response Content
  • JSON Response Content
  • Streaming Response Content
  • RequestInfo
  • Custom Headers
  • Custom Cookies
  • More complicated POST requests
  • POST a Multipart-Encoded File
  • Streaming uploads
  • Uploading pre-compressed data
  • Keep-Alive, connection pooling and cookie sharing
  • Cookie safety
  • Dummy Cookie Jar
  • Connectors
  • Limiting connection pool size
  • Resolving using custom nameservers
  • SSL control for TCP sockets
  • Unix domain sockets
  • Proxy support
  • Response Status Codes
  • Response Headers
  • Response Cookies
  • Response History
  • WebSockets
  • Timeouts
  • Graceful Shutdown
• Client Reference
  • Client Session
  • Basic API
  • Connectors
    • BaseConnector
    • TCPConnector
    • UnixConnector
    • Connection
  • Response object
  • ClientWebSocketResponse
  • Utilities
    • RequestInfo
    • BasicAuth
    • CookieJar
  • Client exceptions
    • Response errors
    • Connection errors
    • Hierarchy of exceptions
• Server Tutorial
  • Setup your environment
  • Getting started with aiohttp first app
  • Application
  • Views
  • Configuration files
  • Database
    • Setup
    • Database schema
    • Creating connection engine
    • Graceful shutdown
  • Templates
  • Static files
  • Middlewares
• Server Usage
  • Run a Simple Web Server
  • Command Line Interface (CLI)
  • Handler
  • Resources and Routes
    • Variable Resources
    • Reverse URL Constructing using Named Resources
    • Organizing Handlers in Classes
    • Class Based Views
    • Resource Views
  • Alternative ways for registering routes
  • Web Handler Cancellation
  • Custom Routing Criteria
  • Static file handling
  • Template Rendering
  • JSON Response
  • User Sessions
  • HTTP Forms
  • File Uploads
  • WebSockets
  • Exceptions
  • Data Sharing aka No Singletons Please
  • Middlewares
    • Example
    • Old Style Middleware
  • Signals
  • Nested applications
  • Flow control
  • Expect Header
  • Custom resource implementation
  • Graceful shutdown
  • Background tasks
  • Handling error pages
  • Deploying behind a Proxy
  • Swagger support
  • CORS support
  • Debug Toolbar
  • Dev Tools
• Server Reference
  • Request and Base Request
  • Response classes
    • StreamResponse
    • Response
    • WebSocketResponse
    • WebSocketReady
  • json_response
  • Application and Router
    • Application
    • Server
    • Router
    • Resource
    • Route
    • RouteDef
    • RouteTableDef
    • MatchInfo
    • View
  • Utilities
  • Constants
  • Middlewares
    • Normalize path middleware
• Low Level Server
  • Abstract
  • Run a Basic Low-Level Server
• Abstract Base Classes
  • Abstract routing
  • Abstract Class Based Views
  • Abstract Cookie Jar
  • Abstract Abstract Access Logger
• Working with Multipart
  • Reading Multipart Responses
  • Sending Multipart Requests
  • Hacking Multipart
• Streaming API
  • Reading Methods
  • Asynchronous Iteration Support
  • Helpers
• Helpers API
  • WebSocket utilities
  • Signals
  • aiohttp.multipart module
• Logging
  • Access logs
    • Format specification
  • Error logs
• Testing
  • Testing aiohttp web servers
    • Provisional Status
    • The Test Client and Servers
    • Pytest
    • Unittest
  • Faking request object
    • Framework Agnostic Utilities
  • Writing testable services
  • Testing API Reference
    • Test server
    • Test Client
    • Utilities
• Server Deployment
  • Standalone
  • Nginx+supervisord
    • Nginx configuration
    • Supervisord
    • aiohttp server
  • Nginx+Gunicorn
    • Prepare environment
    • Application
    • Start Gunicorn
    • More information
    • Logging configuration
• Frequently Asked Questions
  • Are there any plans for @app.route decorator like in Flask?
  • Has aiohttp the Flask Blueprint or Django App concept?
  • How to create route that catches urls with given prefix?
  • Where to put my database connection so handlers can access it?
  • Why the minimal supported version is Python 3.4.2
  • How a middleware may store a data for using by web-handler later?
  • How to receive an incoming events from different sources in parallel?
  • How to programmatically close websocket server-side?
  • How to make request from a specific IP address?
  • How to use aiohttp test features with code which works with implicit loop?
  • API stability and deprecation policy
  • How to enable gzip compression globally for the whole application?
  • How to manage ClientSession inside web server?
• External resources
  • Third-Party libraries
    • Officially supported
      • aiohttp extensions
      • Database drivers
      • Other tools
    • Approved third-party libraries
      • Database drivers
    • Others
  • Built with aiohttp
  • Powered by aiohttp
• Essays
  • Router refactoring in 0.21
    • Rationale
    • Implementation
    • Backward compatibility
  • What’s new in aiohttp 1.1
    • YARL and URL encoding
      • New API
      • URL encoding
    • Sub-Applications
      • Url reversing
    • Application freezing
  • Migration to 2.x
    • Client
      • chunking
      • compression
      • Client Connector
      • ClientResponse.release
      • Client exceptions
      • Client payload (form-data)
      • Various
    • Server
      • ServerHttpProtocol and low-level details
      • Application
      • WebRequest and WebResponse
      • RequestPayloadError
      • WSGI
• Contributing
  • Instructions for contributors
  • Preconditions for running aiohttp test suite
  • Run aiohttp test suite
  • Tests coverage
  • Documentation
  • Spell checking
  • Changelog update
  • The End
• Changelog
  • 2.3.7 (2017-12-27)
  • 2.3.6 (2017-12-04)
  • 2.3.5 (2017-11-30)
  • 2.3.4 (2017-11-29)
  • 2.3.3 (2017-11-17)
  • 2.3.2 (2017-11-01)
  • 2.3.1 (2017-10-18)
  • 2.3.0 (2017-10-18)
    • Features
    • Bugfixes
    • Improved Documentation
    • Deprecations and Removals
    • Misc
  • 2.2.5 (2017-08-03)
  • 2.2.4 (2017-08-02)
  • 2.2.3 (2017-07-04)
  • 2.2.2 (2017-07-03)
  • 2.2.1 (2017-07-02)
  • 2.2.0 (2017-06-20)
  • 2.1.0 (2017-05-26)
  • 2.0.7 (2017-04-12)
  • 2.0.6 (2017-04-04)
  • 2.0.5 (2017-03-29)
  • 2.0.4 (2017-03-27)
  • 2.0.3 (2017-03-24)
  • 2.0.2 (2017-03-21)
  • 2.0.1 (2017-03-21)
  • 2.0.0 (2017-03-20)
  • 2.0.0rc1 (2017-03-15)
  • 1.3.5 (2017-03-16)
  • 1.3.4 (2017-03-14)
  • 1.3.3 (2017-02-19)
  • 1.3.2 (2017-02-16)
  • 1.3.1 (2017-02-09)
  • 1.3.0 (2017-02-08)
  • 1.2.0 (2016-12-17)
  • 1.1.6 (2016-11-28)
  • 1.1.5 (2016-11-16)
  • 1.1.4 (2016-11-14)
  • 1.1.3 (2016-11-10)
  • 1.1.2 (2016-11-08)
  • 1.1.1 (2016-11-04)
  • 1.1.0 (2016-11-03)
  • 1.0.5 (2016-10-11)
  • 1.0.4 (2016-09-22)
  • 1.0.2 (2016-09-22)
  • 1.0.1 (2016-09-16)
  • 1.0.0 (2016-09-16)
  • 0.22.5 (08-02-2016)
  • 0.22.3 (07-26-2016)
  • 0.22.2 (07-23-2016)
  • 0.22.1 (07-16-2016)
  • 0.22.0 (07-15-2016)
  • 0.21.6 (05-05-2016)
  • 0.21.5 (03-22-2016)
  • 0.21.4 (03-12-2016)
  • 0.21.2 (02-16-2016)
  • 0.21.1 (02-10-2016)
  • 0.21.0 (02-04-2016)
  • 0.20.2 (01-07-2016)
  • 0.20.1 (12-30-2015)
  • 0.20.0 (12-28-2015)
  • 0.19.0 (11-25-2015)
  • 0.18.4 (13-11-2015)
  • 0.18.3 (25-10-2015)
  • 0.18.2 (22-10-2015)
  • 0.18.1 (20-10-2015)
  • 0.18.0 (19-10-2015)
  • 0.17.4 (09-29-2015)
  • 0.17.3 (08-28-2015)
  • 0.17.2 (08-11-2015)
  • 0.17.1 (08-10-2015)
  • 0.17.0 (08-04-2015)
  • 0.16.6 (07-15-2015)
  • 0.16.5 (06-13-2015)
  • 0.16.4 (06-13-2015)
  • 0.16.3 (05-30-2015)
  • 0.16.2 (05-27-2015)
  • 0.16.1 (05-27-2015)
  • 0.16.0 (05-26-2015)
  • 0.15.3 (04-22-2015)
  • 0.15.2 (04-19-2015)
  • 0.15.1 (03-31-2015)
  • 0.15.0 (03-27-2015)
  • 0.14.4 (01-29-2015)
  • 0.14.3 (01-28-2015)
  • 0.14.2 (01-23-2015)
  • 0.14.1 (01-15-2015)
  • 0.13.1 (12-31-2014)
  • 0.13.0 (12-29-2014)
  • 0.12.0 (12-12-2014)
  • 0.11.0 (11-29-2014)
  • 0.10.2 (11-19-2014)
  • 0.10.1 (11-17-2014)
  • 0.10.0 (11-13-2014)
  • 0.9.3 (10-30-2014)
  • 0.9.2 (10-16-2014)
  • 0.9.1 (08-30-2014)
  • 0.9.0 (07-08-2014)
  • 0.8.4 (07-04-2014)
  • 0.8.3 (07-03-2014)
  • 0.8.2 (06-22-2014)
  • 0.8.1 (06-18-2014)
  • 0.8.0 (06-06-2014)
  • 0.7.3 (05-20-2014)
  • 0.7.2 (05-14-2014)
  • 0.7.1 (04-28-2014)
  • 0.7.0 (04-16-2014)
  • 0.6.5 (03-29-2014)
  • 0.6.4 (02-27-2014)
  • 0.6.3 (02-27-2014)
  • 0.6.2 (02-18-2014)
  • 0.6.1 (02-17-2014)
  • 0.6.0 (02-12-2014)
  • 0.5.0 (01-29-2014)
  • 0.4.4 (11-15-2013)
  • 0.4.3 (11-15-2013)
  • 0.4.2 (11-14-2013)
  • 0.4.1 (11-12-2013)
  • 0.4 (11-06-2013)
  • 0.3 (11-04-2013)
  • 0.2
• Glossary
• Sitemap

Indices and tables

• Index
• Module Index
• Search Page