API reference

Functional Areas

This section of the document groups gevent APIs by functional area. For an alphabetical listing by module, see Module Listing.

High-level concepts

• gevent – common functions
  • Working With Greenlets
    • Creating Greenlets
    • Getting Greenlets
    • Stopping Greenlets
  • Sleeping
  • Switching
  • Waiting
  • Working with multiple processes
  • Signals
  • Timeouts
• Cooperative Timeouts Using gevent.Timeout
• Greenlet Objects
  • Starting Greenlets
  • Waiting For Greenlets
  • Stopping Greenlets
  • Context Managers
  • Subclassing Greenlet
  • Boolean Contexts
  • Raw greenlet Methods

Networking interfaces

• gevent.socket – Cooperative low-level networking interface
  • Standard Library Interface
    • Python 3 interface
    • Python 2 interface
  • Gevent Extensions
    • Waiting
• gevent.ssl – Secure Sockets Layer (SSL/TLS) module
  • Python 3 interface
  • Python 2.7.9 and above interface (including PyPy 2.6.1 and above)
  • Python 2.7.8 and below interface
• gevent.select – Waiting for I/O completion
• gevent.selectors – High-level IO Multiplexing

Synchronization primitives (locks, queues, events)

• gevent.event – Notifications of multiple listeners
• gevent.queue – Synchronized queues
  • Examples
• gevent.local – Greenlet-local objects
• gevent.lock – Locking primitives

Low-level details

• gevent.hub - The Event Loop and the Hub
  • The Event Loop
  • Utilities
  • Exceptions
• gevent.core - (deprecated) event loop abstraction

Module Listing

This section of the document groups gevent APIs by module.

• gevent – common functions
  • Working With Greenlets
    • Creating Greenlets
    • Getting Greenlets
    • Stopping Greenlets
  • Sleeping
  • Switching
  • Waiting
  • Working with multiple processes
  • Signals
  • Timeouts
• gevent.backdoor – Interactive greenlet-based network console that can be used in any process
• gevent.baseserver – Base class for implementing servers
• gevent.builtins – gevent friendly implementations of builtin functions
• gevent.contextvars – Cooperative contextvars
• gevent.core - (deprecated) event loop abstraction
• gevent.event – Notifications of multiple listeners
• gevent.events – Publish/subscribe event infrastructure
• gevent.exceptions – Exceptions
• gevent.fileobject – Wrappers to make file-like objects cooperative
  • Configuration
  • Classes
• gevent.hub - The Event Loop and the Hub
  • The Event Loop
  • Utilities
  • Exceptions
• gevent.local – Greenlet-local objects
• gevent.lock – Locking primitives
• gevent.monkey – Make the standard library cooperative
  • Querying
  • Plugins and Events
  • Use as a module
• gevent.os – Low-level operating system functions from os
  • Cooperative I/O
    • POSIX functions
    • All Platforms
  • Child Processes
• gevent.pool – Managing greenlets in a group
• gevent.pywsgi – A pure-Python, gevent-friendly WSGI server
• gevent.queue – Synchronized queues
  • Examples
• gevent.resolver.ares – c-ares based hostname resolver
• gevent.resolver.blocking – Non-cooperative resolver
• gevent.resolver.dnspython – Pure Python hostname resolver
• gevent.resolver.thread – thread based hostname resolver
• gevent.select – Waiting for I/O completion
• gevent.server – TCP/SSL server
• gevent.signal – Cooperative implementation of special cases of signal.signal()
• gevent.socket – Cooperative low-level networking interface
  • Standard Library Interface
    • Python 3 interface
    • Python 2 interface
  • Gevent Extensions
    • Waiting
• gevent.ssl – Secure Sockets Layer (SSL/TLS) module
  • Python 3 interface
  • Python 2.7.9 and above interface (including PyPy 2.6.1 and above)
  • Python 2.7.8 and below interface
• gevent.subprocess – Cooperative subprocess module
• gevent.thread – Implementation of the standard thread module that spawns greenlets
• gevent.threading – Implementation of the standard threading using greenlets
• gevent.threadpool - A pool of native threads
• gevent.time – Makes sleep gevent aware
• gevent.util – Low-level utilities

Deprecated Modules

These modules are deprecated and should not be used in new code.

• gevent.ares – Backwards compatibility alias for gevent.resolver.cares
• gevent.wsgi – Historical note only; does not exist

Examples

• Examples
  • Example concurrent_download.py
  • Example dns_mass_resolve.py
  • Example echoserver.py
  • Example geventsendfile.py
  • Example portforwarder.py
  • Example processes.py
  • Example psycopg2_pool.py
  • Example threadpool.py
  • Example udp_client.py
  • Example udp_server.py
  • Example unixsocket_client.py
  • Example unixsocket_server.py
  • Example webproxy.py
  • Example webpy.py
  • Example wsgiserver.py
  • Example wsgiserver_ssl.py

Next page: Cooperative Timeouts Using gevent.Timeout