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
  • __version__
  • Working With Greenlets
    • Creating Greenlets
      • spawn()
      • spawn_later()
      • spawn_raw()
    • Getting Greenlets
      • getcurrent()
    • Stopping Greenlets
      • kill()
      • killall()
  • Sleeping
    • sleep()
    • idle()
  • Switching
    • getswitchinterval()
    • setswitchinterval()
  • Waiting
    • wait()
    • iwait()
    • joinall()
  • Working with multiple processes
    • fork()
    • reinit()
  • Signals
    • signal_handler()
  • Timeouts
    • with_timeout()
• Cooperative Timeouts Using gevent.Timeout
  • Timeout
    • Timeout.__enter__()
    • Timeout.__exit__()
    • Timeout.cancel()
    • Timeout.close()
    • Timeout.start()
    • Timeout.start_new()
    • Timeout.pending
• Greenlet Objects
  • Starting Greenlets
  • Waiting For Greenlets
  • Stopping Greenlets
  • Context Managers
  • Subclassing Greenlet
  • Boolean Contexts
    • GreenletExit
    • Greenlet
      • Greenlet.__init__()
      • Greenlet.exception
      • Greenlet.minimal_ident
      • Greenlet.name
      • Greenlet.dead
      • Greenlet.value
      • Greenlet.spawn_tree_locals
      • Greenlet.spawning_greenlet
      • Greenlet.spawning_stack
      • Greenlet.spawning_stack_limit
      • Greenlet.spawn()
      • Greenlet.ready()
      • Greenlet.successful()
      • Greenlet.start()
      • Greenlet.start_later()
      • Greenlet.join()
      • Greenlet.get()
      • Greenlet.kill()
      • Greenlet.link()
      • Greenlet.link_value()
      • Greenlet.link_exception()
      • Greenlet.rawlink()
      • Greenlet.unlink()
      • Greenlet.__str__()
      • Greenlet.add_spawn_callback()
      • Greenlet.remove_spawn_callback()
  • Raw greenlet Methods
    • greenlet.greenlet

Networking interfaces

• gevent.socket – Cooperative low-level networking interface
  • Standard Library Interface
    • gethostbyname()
    • socket
    • Python 3 interface
      • SocketType
      • socket
        • socket.accept()
        • socket.bind()
        • socket.connect()
        • socket.connect_ex()
        • socket.detach()
        • socket.dup()
        • socket.fileno()
        • socket.get_inheritable()
        • socket.getblocking()
        • socket.getpeername()
        • socket.getsockname()
        • socket.getsockopt()
        • socket.gettimeout()
        • socket.listen()
        • socket.makefile()
        • socket.recv()
        • socket.recv_into()
        • socket.recvfrom()
        • socket.recvfrom_into()
        • socket.send()
        • socket.sendall()
        • socket.sendfile()
        • socket.sendto()
        • socket.set_inheritable()
        • socket.setblocking()
        • socket.setsockopt()
        • socket.settimeout()
        • socket.shutdown()
        • socket.family
        • socket.proto
        • socket.type
      • create_connection()
      • fromfd()
      • getaddrinfo()
      • getfqdn()
      • gethostbyaddr()
      • gethostbyname()
      • gethostbyname_ex()
      • getnameinfo()
      • socketpair()
    • Python 2 interface
      • error
      • gaierror
        • gaierror.add_note()
        • gaierror.with_traceback()
        • gaierror.errno
        • gaierror.filename
        • gaierror.filename2
        • gaierror.strerror
      • herror
        • herror.add_note()
        • herror.with_traceback()
        • herror.errno
        • herror.filename
        • herror.filename2
        • herror.strerror
      • timeout
      • SocketType
      • socket
        • socket.bind()
        • socket.connect()
        • socket.connect_ex()
        • socket.dup()
        • socket.fileno()
        • socket.getblocking()
        • socket.getpeername()
        • socket.getsockname()
        • socket.getsockopt()
        • socket.gettimeout()
        • socket.listen()
        • socket.recv()
        • socket.recv_into()
        • socket.recvfrom()
        • socket.recvfrom_into()
        • socket.send()
        • socket.sendall()
        • socket.sendto()
        • socket.setblocking()
        • socket.setsockopt()
        • socket.settimeout()
        • socket.shutdown()
        • socket.family
        • socket.proto
        • socket.type
      • create_server()
      • getaddrinfo()
      • getdefaulttimeout()
      • getfqdn()
      • gethostbyaddr()
      • gethostbyname()
      • gethostbyname_ex()
      • gethostname()
      • getnameinfo()
      • getprotobyname()
      • getservbyname()
      • getservbyport()
      • has_dualstack_ipv6()
      • htonl()
      • htons()
      • inet_aton()
      • inet_ntoa()
      • inet_ntop()
      • inet_pton()
      • ntohl()
      • ntohs()
      • recv_fds()
      • send_fds()
      • setdefaulttimeout()
      • sethostname()
  • Gevent Extensions
    • Waiting
      • wait_read()
      • wait_write()
      • wait_readwrite()
      • wait()
      • cancel_wait()
• gevent.ssl – Secure Sockets Layer (SSL/TLS) module
  • SSLObject
  • Python 3 interface
    • CertificateError
    • SSLCertVerificationError
    • SSLEOFError
    • SSLError
    • SSLSyscallError
    • SSLWantReadError
    • SSLWantWriteError
    • SSLZeroReturnError
    • socket_error
    • AlertDescription
    • DefaultVerifyPaths
      • DefaultVerifyPaths.cafile
      • DefaultVerifyPaths.capath
      • DefaultVerifyPaths.openssl_cafile
      • DefaultVerifyPaths.openssl_cafile_env
      • DefaultVerifyPaths.openssl_capath
      • DefaultVerifyPaths.openssl_capath_env
    • Options
    • Purpose
    • SSLContext
      • SSLContext.sslsocket_class
      • SSLContext.sni_callback
    • SSLErrorNumber
    • SSLObject
      • SSLObject.cipher()
      • SSLObject.compression()
      • SSLObject.do_handshake()
      • SSLObject.get_channel_binding()
      • SSLObject.getpeercert()
      • SSLObject.pending()
      • SSLObject.read()
      • SSLObject.selected_alpn_protocol()
      • SSLObject.selected_npn_protocol()
      • SSLObject.shared_ciphers()
      • SSLObject.unwrap()
      • SSLObject.version()
      • SSLObject.write()
      • SSLObject.context
      • SSLObject.server_hostname
      • SSLObject.server_side
      • SSLObject.session
      • SSLObject.session_reused
    • SSLSocket
      • SSLSocket.accept()
      • SSLSocket.connect()
      • SSLSocket.connect_ex()
      • SSLSocket.do_handshake()
      • SSLSocket.dup()
      • SSLSocket.get_channel_binding()
      • SSLSocket.getpeercert()
      • SSLSocket.read()
      • SSLSocket.recv()
      • SSLSocket.recv_into()
      • SSLSocket.recvfrom()
      • SSLSocket.recvfrom_into()
      • SSLSocket.send()
      • SSLSocket.sendall()
      • SSLSocket.sendto()
      • SSLSocket.shared_ciphers()
      • SSLSocket.shutdown()
      • SSLSocket.version()
      • SSLSocket.write()
      • SSLSocket.session
      • SSLSocket.session_reused
    • TLSVersion
    • VerifyFlags
    • VerifyMode
    • DER_cert_to_PEM_cert()
    • PEM_cert_to_DER_cert()
    • RAND_add()
    • RAND_bytes()
    • RAND_pseudo_bytes()
    • RAND_status()
    • cert_time_to_seconds()
    • create_connection()
    • create_default_context()
    • get_default_verify_paths()
    • get_server_certificate()
    • match_hostname()
  • Python 2.7.9 and above interface (including PyPy 2.6.1 and above)
    • CertificateError
    • SSLCertVerificationError
    • SSLEOFError
    • SSLError
    • SSLSyscallError
    • SSLWantReadError
    • SSLWantWriteError
    • SSLZeroReturnError
    • socket_error
    • AlertDescription
    • DefaultVerifyPaths
      • DefaultVerifyPaths.cafile
      • DefaultVerifyPaths.capath
      • DefaultVerifyPaths.openssl_cafile
      • DefaultVerifyPaths.openssl_cafile_env
      • DefaultVerifyPaths.openssl_capath
      • DefaultVerifyPaths.openssl_capath_env
    • Options
    • Purpose
    • SSLContext
    • SSLErrorNumber
    • SSLObject
      • SSLObject.cipher()
      • SSLObject.compression()
      • SSLObject.do_handshake()
      • SSLObject.get_channel_binding()
      • SSLObject.getpeercert()
      • SSLObject.pending()
      • SSLObject.read()
      • SSLObject.selected_alpn_protocol()
      • SSLObject.selected_npn_protocol()
      • SSLObject.shared_ciphers()
      • SSLObject.unwrap()
      • SSLObject.version()
      • SSLObject.write()
      • SSLObject.context
      • SSLObject.server_hostname
      • SSLObject.server_side
      • SSLObject.session
      • SSLObject.session_reused
    • SSLSocket
      • SSLSocket.accept()
      • SSLSocket.connect()
      • SSLSocket.connect_ex()
      • SSLSocket.do_handshake()
      • SSLSocket.dup()
      • SSLSocket.get_channel_binding()
      • SSLSocket.getpeercert()
      • SSLSocket.makefile()
      • SSLSocket.read()
      • SSLSocket.recv()
      • SSLSocket.recv_into()
      • SSLSocket.recvfrom()
      • SSLSocket.recvfrom_into()
      • SSLSocket.send()
      • SSLSocket.sendall()
      • SSLSocket.sendto()
      • SSLSocket.shutdown()
      • SSLSocket.version()
      • SSLSocket.write()
    • TLSVersion
    • VerifyFlags
    • VerifyMode
    • DER_cert_to_PEM_cert()
    • PEM_cert_to_DER_cert()
    • RAND_add()
    • RAND_bytes()
    • RAND_pseudo_bytes()
    • RAND_status()
    • cert_time_to_seconds()
    • create_default_context()
    • get_default_verify_paths()
    • get_server_certificate()
    • match_hostname()
  • Python 2.7.8 and below interface
    • CertificateError
    • SSLCertVerificationError
    • SSLEOFError
    • SSLError
    • SSLSyscallError
    • SSLWantReadError
    • SSLWantWriteError
    • SSLZeroReturnError
    • socket_error
    • AlertDescription
    • DefaultVerifyPaths
      • DefaultVerifyPaths.cafile
      • DefaultVerifyPaths.capath
      • DefaultVerifyPaths.openssl_cafile
      • DefaultVerifyPaths.openssl_cafile_env
      • DefaultVerifyPaths.openssl_capath
      • DefaultVerifyPaths.openssl_capath_env
    • Options
    • Purpose
    • SSLContext
      • SSLContext.sslobject_class
      • SSLContext.sslsocket_class
    • SSLErrorNumber
    • SSLObject
      • SSLObject.cipher()
      • SSLObject.compression()
      • SSLObject.do_handshake()
      • SSLObject.get_channel_binding()
      • SSLObject.getpeercert()
      • SSLObject.pending()
      • SSLObject.read()
      • SSLObject.selected_alpn_protocol()
      • SSLObject.selected_npn_protocol()
      • SSLObject.shared_ciphers()
      • SSLObject.unwrap()
      • SSLObject.version()
      • SSLObject.write()
      • SSLObject.context
      • SSLObject.server_hostname
      • SSLObject.server_side
      • SSLObject.session
      • SSLObject.session_reused
    • SSLSocket
      • SSLSocket.accept()
      • SSLSocket.connect()
      • SSLSocket.do_handshake()
      • SSLSocket.getpeercert()
      • SSLSocket.makefile()
      • SSLSocket.read()
      • SSLSocket.recv()
      • SSLSocket.recv_into()
      • SSLSocket.recvfrom()
      • SSLSocket.recvfrom_into()
      • SSLSocket.send()
      • SSLSocket.sendall()
      • SSLSocket.sendto()
      • SSLSocket.shutdown()
      • SSLSocket.write()
    • TLSVersion
    • VerifyFlags
    • VerifyMode
    • DER_cert_to_PEM_cert()
    • PEM_cert_to_DER_cert()
    • RAND_add()
    • RAND_bytes()
    • RAND_pseudo_bytes()
    • RAND_status()
    • cert_time_to_seconds()
    • create_connection()
    • create_default_context()
    • get_default_verify_paths()
    • get_server_certificate()
    • match_hostname()
    • sslwrap_simple()
    • wrap_socket()
• gevent.select – Waiting for I/O completion
  • error
  • poll
    • poll.poll()
    • poll.unregister()
  • select()
• gevent.selectors – High-level IO Multiplexing
  • DefaultSelector
  • GeventSelector
    • GeventSelector.close()
    • GeventSelector.register()
    • GeventSelector.select()
    • GeventSelector.unregister()

Synchronization primitives (locks, queues, events)

• gevent.event – Notifications of multiple listeners
  • Event
    • Event.is_set()
    • Event.isSet()
    • Event.ready()
    • Event.clear()
    • Event.is_set()
    • Event.set()
    • Event.wait()
  • AsyncResult
    • AsyncResult.cancel()
    • AsyncResult.cancelled()
    • AsyncResult.done()
    • AsyncResult.get()
    • AsyncResult.get_nowait()
    • AsyncResult.ready()
    • AsyncResult.result()
    • AsyncResult.set()
    • AsyncResult.set_exception()
    • AsyncResult.set_result()
    • AsyncResult.successful()
    • AsyncResult.wait()
    • AsyncResult.exc_info
    • AsyncResult.exception
    • AsyncResult.value
• gevent.queue – Synchronized queues
  • Empty
  • Full
  • Channel
    • Channel.empty()
    • Channel.full()
    • Channel.get()
    • Channel.get_nowait()
    • Channel.next()
    • Channel.put()
    • Channel.put_nowait()
    • Channel.qsize()
    • Channel.balance
    • Channel.getters
    • Channel.hub
    • Channel.putters
  • JoinableQueue
    • JoinableQueue.copy()
    • JoinableQueue.join()
    • JoinableQueue.task_done()
    • JoinableQueue.unfinished_tasks
  • LifoQueue
  • PriorityQueue
  • Queue
    • Queue.copy()
    • Queue.empty()
    • Queue.full()
    • Queue.get()
    • Queue.get_nowait()
    • Queue.next()
    • Queue.peek()
    • Queue.peek_nowait()
    • Queue.put()
    • Queue.put_nowait()
    • Queue.qsize()
    • Queue.getters
    • Queue.hub
    • Queue.maxsize
    • Queue.putters
    • Queue.queue
  • SimpleQueue
  • Full
  • Empty
  • Examples
• gevent.local – Greenlet-local objects
  • local
• gevent.lock – Locking primitives
  • BoundedSemaphore
    • BoundedSemaphore.acquire()
    • BoundedSemaphore.locked()
    • BoundedSemaphore.rawlink()
    • BoundedSemaphore.ready()
    • BoundedSemaphore.release()
    • BoundedSemaphore.unlink()
    • BoundedSemaphore.wait()
  • DummySemaphore
    • DummySemaphore.acquire()
    • DummySemaphore.locked()
    • DummySemaphore.ready()
    • DummySemaphore.release()
    • DummySemaphore.wait()
  • RLock
    • RLock.acquire()
    • RLock.release()
  • Semaphore
    • Semaphore.acquire()
    • Semaphore.locked()
    • Semaphore.rawlink()
    • Semaphore.ready()
    • Semaphore.release()
    • Semaphore.unlink()
    • Semaphore.wait()

Low-level details

• gevent.hub - The Event Loop and the Hub
  • get_hub()
  • Hub
    • Hub.wait()
    • Hub.cancel_wait()
    • Hub.loop
    • Hub.destroy()
    • Hub.exception_stream()
    • Hub.handle_error()
    • Hub.handle_system_error()
    • Hub.join()
    • Hub.run()
    • Hub.NOT_ERROR
    • Hub.SYSTEM_ERROR
    • Hub.main_hub
    • Hub.name
    • Hub.resolver
    • Hub.threadpool
    • Hub.threadpool_size
  • The Event Loop
    • ILoop
      • ILoop.default
      • ILoop.approx_timer_resolution
      • ILoop.run()
      • ILoop.now()
      • ILoop.update_now()
      • ILoop.destroy()
      • ILoop.io()
      • ILoop.closing_fd()
      • ILoop.timer()
      • ILoop.signal()
      • ILoop.idle()
      • ILoop.prepare()
      • ILoop.check()
      • ILoop.fork()
      • ILoop.async_()
      • ILoop.child()
      • ILoop.stat()
      • ILoop.run_callback()
      • ILoop.run_callback_threadsafe()
    • IWatcher
      • IWatcher.start()
      • IWatcher.stop()
      • IWatcher.close()
    • ICallback
      • ICallback.pending
      • ICallback.stop()
      • ICallback.close()
  • Utilities
    • Waiter
      • Waiter.get()
      • Waiter.ready()
      • Waiter.successful()
      • Waiter.switch()
      • Waiter.throw()
      • Waiter.exc_info
  • Exceptions
    • LoopExit
      • LoopExit.hub
    • ConcurrentObjectUseError
    • BlockingSwitchOutError
    • InvalidSwitchError
• gevent.core - (deprecated) event loop abstraction

Module Listing

This section of the document groups gevent APIs by module.

• gevent – common functions
  • __version__
  • Working With Greenlets
    • Creating Greenlets
      • spawn()
      • spawn_later()
      • spawn_raw()
    • Getting Greenlets
      • getcurrent()
    • Stopping Greenlets
      • kill()
      • killall()
  • Sleeping
    • sleep()
    • idle()
  • Switching
    • getswitchinterval()
    • setswitchinterval()
  • Waiting
    • wait()
    • iwait()
    • joinall()
  • Working with multiple processes
    • fork()
    • reinit()
  • Signals
    • signal_handler()
  • Timeouts
    • with_timeout()
• gevent.backdoor – Interactive greenlet-based network console that can be used in any process
  • BackdoorServer
    • BackdoorServer.handle()
• gevent.baseserver – Base class for implementing servers
  • BaseServer
    • BaseServer.close()
    • BaseServer.init_socket()
    • BaseServer.serve_forever()
    • BaseServer.start()
    • BaseServer.stop()
    • BaseServer.max_accept
    • BaseServer.min_delay
    • BaseServer.server_host
    • BaseServer.server_port
    • BaseServer.stop_timeout
• gevent.builtins – gevent friendly implementations of builtin functions
• gevent.contextvars – Cooperative contextvars
  • Context
    • Context.copy()
  • ContextVar
  • Token
    • Token.old_value
    • Token.var
  • copy_context()
• gevent.core - (deprecated) event loop abstraction
• gevent.event – Notifications of multiple listeners
  • Event
    • Event.is_set()
    • Event.isSet()
    • Event.ready()
    • Event.clear()
    • Event.is_set()
    • Event.set()
    • Event.wait()
  • AsyncResult
    • AsyncResult.cancel()
    • AsyncResult.cancelled()
    • AsyncResult.done()
    • AsyncResult.get()
    • AsyncResult.get_nowait()
    • AsyncResult.ready()
    • AsyncResult.result()
    • AsyncResult.set()
    • AsyncResult.set_exception()
    • AsyncResult.set_result()
    • AsyncResult.successful()
    • AsyncResult.wait()
    • AsyncResult.exc_info
    • AsyncResult.exception
    • AsyncResult.value
• gevent.events – Publish/subscribe event infrastructure
  • DoNotPatch
  • IEventLoopBlocked
    • IEventLoopBlocked.greenlet
    • IEventLoopBlocked.blocking_time
    • IEventLoopBlocked.info
  • IGeventDidPatchAllEvent
  • IGeventDidPatchBuiltinModulesEvent
    • IGeventDidPatchBuiltinModulesEvent.patch_all_arguments
    • IGeventDidPatchBuiltinModulesEvent.patch_all_kwargs
  • IGeventDidPatchEvent
  • IGeventDidPatchModuleEvent
    • IGeventDidPatchModuleEvent.module_name
  • IGeventPatchEvent
    • IGeventPatchEvent.source
    • IGeventPatchEvent.target
  • IGeventWillPatchAllEvent
    • IGeventWillPatchAllEvent.patch_all_arguments
    • IGeventWillPatchAllEvent.patch_all_kwargs
    • IGeventWillPatchAllEvent.will_patch_module()
  • IGeventWillPatchEvent
  • IGeventWillPatchModuleEvent
    • IGeventWillPatchModuleEvent.module_name
    • IGeventWillPatchModuleEvent.target_item_names
  • IMemoryUsageThresholdExceeded
    • IMemoryUsageThresholdExceeded.mem_usage
    • IMemoryUsageThresholdExceeded.max_allowed
    • IMemoryUsageThresholdExceeded.memory_info
  • IMemoryUsageUnderThreshold
    • IMemoryUsageUnderThreshold.mem_usage
    • IMemoryUsageUnderThreshold.max_allowed
    • IMemoryUsageUnderThreshold.max_memory_usage
    • IMemoryUsageUnderThreshold.memory_info
  • IPeriodicMonitorThread
    • IPeriodicMonitorThread.add_monitoring_function()
  • IPeriodicMonitorThreadStartedEvent
    • IPeriodicMonitorThreadStartedEvent.monitor
  • EventLoopBlocked
  • GeventDidPatchAllEvent
    • GeventDidPatchAllEvent.ENTRY_POINT_NAME
  • GeventDidPatchBuiltinModulesEvent
    • GeventDidPatchBuiltinModulesEvent.ENTRY_POINT_NAME
  • GeventDidPatchModuleEvent
    • GeventDidPatchModuleEvent.ENTRY_POINT_NAME
  • GeventPatchEvent
  • GeventWillPatchAllEvent
    • GeventWillPatchAllEvent.ENTRY_POINT_NAME
  • GeventWillPatchEvent
  • GeventWillPatchModuleEvent
    • GeventWillPatchModuleEvent.ENTRY_POINT_NAME
  • MemoryUsageThresholdExceeded
  • MemoryUsageUnderThreshold
  • PeriodicMonitorThreadStartedEvent
    • PeriodicMonitorThreadStartedEvent.ENTRY_POINT_NAME
  • subscribers
• gevent.exceptions – Exceptions
  • LoopExit
    • LoopExit.hub
• gevent.fileobject – Wrappers to make file-like objects cooperative
  • FileObject
  • Configuration
  • Classes
  • FileObject
  • FileObjectBlock
  • FileObjectPosix
  • FileObjectThread
• gevent.hub - The Event Loop and the Hub
  • get_hub()
  • Hub
    • Hub.wait()
    • Hub.cancel_wait()
    • Hub.loop
    • Hub.destroy()
    • Hub.exception_stream()
    • Hub.handle_error()
    • Hub.handle_system_error()
    • Hub.join()
    • Hub.run()
    • Hub.NOT_ERROR
    • Hub.SYSTEM_ERROR
    • Hub.main_hub
    • Hub.name
    • Hub.resolver
    • Hub.threadpool
    • Hub.threadpool_size
  • The Event Loop
    • ILoop
      • ILoop.default
      • ILoop.approx_timer_resolution
      • ILoop.run()
      • ILoop.now()
      • ILoop.update_now()
      • ILoop.destroy()
      • ILoop.io()
      • ILoop.closing_fd()
      • ILoop.timer()
      • ILoop.signal()
      • ILoop.idle()
      • ILoop.prepare()
      • ILoop.check()
      • ILoop.fork()
      • ILoop.async_()
      • ILoop.child()
      • ILoop.stat()
      • ILoop.run_callback()
      • ILoop.run_callback_threadsafe()
    • IWatcher
      • IWatcher.start()
      • IWatcher.stop()
      • IWatcher.close()
    • ICallback
      • ICallback.pending
      • ICallback.stop()
      • ICallback.close()
  • Utilities
    • Waiter
      • Waiter.get()
      • Waiter.ready()
      • Waiter.successful()
      • Waiter.switch()
      • Waiter.throw()
      • Waiter.exc_info
  • Exceptions
    • LoopExit
      • LoopExit.hub
    • ConcurrentObjectUseError
    • BlockingSwitchOutError
    • InvalidSwitchError
• gevent.local – Greenlet-local objects
  • local
• gevent.lock – Locking primitives
  • BoundedSemaphore
    • BoundedSemaphore.acquire()
    • BoundedSemaphore.locked()
    • BoundedSemaphore.rawlink()
    • BoundedSemaphore.ready()
    • BoundedSemaphore.release()
    • BoundedSemaphore.unlink()
    • BoundedSemaphore.wait()
  • DummySemaphore
    • DummySemaphore.acquire()
    • DummySemaphore.locked()
    • DummySemaphore.ready()
    • DummySemaphore.release()
    • DummySemaphore.wait()
  • RLock
    • RLock.acquire()
    • RLock.release()
  • Semaphore
    • Semaphore.acquire()
    • Semaphore.locked()
    • Semaphore.rawlink()
    • Semaphore.ready()
    • Semaphore.release()
    • Semaphore.unlink()
    • Semaphore.wait()
• gevent.monkey – Make the standard library cooperative
  • Querying
  • Plugins and Events
  • Use as a module
  • get_original()
  • is_module_patched()
  • is_object_patched()
  • main()
  • patch_all()
  • patch_builtins()
  • patch_dns()
  • patch_module()
  • patch_os()
  • patch_queue()
  • patch_select()
  • patch_signal()
  • patch_socket()
  • patch_ssl()
  • patch_subprocess()
  • patch_sys()
  • patch_thread()
  • patch_time()
• gevent.os – Low-level operating system functions from os
  • Cooperative I/O
    • POSIX functions
    • All Platforms
  • Child Processes
  • fork()
  • fork_and_watch()
  • fork_gevent()
  • forkpty()
  • forkpty_and_watch()
  • forkpty_gevent()
  • make_nonblocking()
  • nb_read()
  • nb_write()
  • tp_read()
  • tp_write()
  • waitpid()
• gevent.pool – Managing greenlets in a group
  • Group
    • Group.greenlet_class
    • Group.__len__()
    • Group.__contains__()
    • Group.greenlet_class
    • Group.add()
    • Group.apply()
    • Group.apply_async()
    • Group.apply_cb()
    • Group.discard()
    • Group.full()
    • Group.imap()
    • Group.imap_unordered()
    • Group.join()
    • Group.kill()
    • Group.killone()
    • Group.map()
    • Group.map_async()
    • Group.spawn()
    • Group.start()
    • Group.wait_available()
  • PoolFull
  • Pool
    • Pool.add()
    • Pool.free_count()
    • Pool.full()
    • Pool.start()
    • Pool.wait_available()
• gevent.pywsgi – A pure-Python, gevent-friendly WSGI server
  • Environ
    • Environ.copy()
  • LoggingLogAdapter
    • LoggingLogAdapter.flush()
  • SecureEnviron
  • WSGIHandler
    • WSGIHandler.ApplicationError
    • WSGIHandler.get_environ()
    • WSGIHandler.handle()
    • WSGIHandler.handle_one_request()
    • WSGIHandler.handle_one_response()
    • WSGIHandler.read_request()
    • WSGIHandler.read_requestline()
    • WSGIHandler.start_response()
    • WSGIHandler.ignored_socket_errors
  • WSGISecureEnviron
  • WSGIServer
    • WSGIServer.environ_class
    • WSGIServer.handler_class
    • WSGIServer.secure_environ_class
    • WSGIServer.handle()
    • WSGIServer.init_socket()
    • WSGIServer.update_environ()
    • WSGIServer.error_log
    • WSGIServer.log
• gevent.queue – Synchronized queues
  • Empty
  • Full
  • Channel
    • Channel.empty()
    • Channel.full()
    • Channel.get()
    • Channel.get_nowait()
    • Channel.next()
    • Channel.put()
    • Channel.put_nowait()
    • Channel.qsize()
    • Channel.balance
    • Channel.getters
    • Channel.hub
    • Channel.putters
  • JoinableQueue
    • JoinableQueue.copy()
    • JoinableQueue.join()
    • JoinableQueue.task_done()
    • JoinableQueue.unfinished_tasks
  • LifoQueue
  • PriorityQueue
  • Queue
    • Queue.copy()
    • Queue.empty()
    • Queue.full()
    • Queue.get()
    • Queue.get_nowait()
    • Queue.next()
    • Queue.peek()
    • Queue.peek_nowait()
    • Queue.put()
    • Queue.put_nowait()
    • Queue.qsize()
    • Queue.getters
    • Queue.hub
    • Queue.maxsize
    • Queue.putters
    • Queue.queue
  • SimpleQueue
  • Full
  • Empty
  • Examples
• gevent.resolver.ares – c-ares based hostname resolver
  • Resolver
    • Resolver.close()
• gevent.resolver.blocking – Non-cooperative resolver
  • Resolver
    • Resolver.getaddrinfo()
    • Resolver.gethostbyaddr()
    • Resolver.gethostbyname()
    • Resolver.gethostbyname_ex()
    • Resolver.getnameinfo()
• gevent.resolver.dnspython – Pure Python hostname resolver
• gevent.resolver.thread – thread based hostname resolver
  • Resolver
• gevent.select – Waiting for I/O completion
  • error
  • poll
    • poll.poll()
    • poll.unregister()
  • select()
• gevent.server – TCP/SSL server
  • DatagramServer
    • DatagramServer.init_socket()
  • StreamServer
    • StreamServer.init_socket()
• gevent.signal – Cooperative implementation of special cases of signal.signal()
  • getsignal()
  • signal()
• gevent.socket – Cooperative low-level networking interface
  • Standard Library Interface
    • gethostbyname()
    • socket
    • Python 3 interface
      • SocketType
      • socket
        • socket.accept()
        • socket.bind()
        • socket.connect()
        • socket.connect_ex()
        • socket.detach()
        • socket.dup()
        • socket.fileno()
        • socket.get_inheritable()
        • socket.getblocking()
        • socket.getpeername()
        • socket.getsockname()
        • socket.getsockopt()
        • socket.gettimeout()
        • socket.listen()
        • socket.makefile()
        • socket.recv()
        • socket.recv_into()
        • socket.recvfrom()
        • socket.recvfrom_into()
        • socket.send()
        • socket.sendall()
        • socket.sendfile()
        • socket.sendto()
        • socket.set_inheritable()
        • socket.setblocking()
        • socket.setsockopt()
        • socket.settimeout()
        • socket.shutdown()
        • socket.family
        • socket.proto
        • socket.type
      • create_connection()
      • fromfd()
      • getaddrinfo()
      • getfqdn()
      • gethostbyaddr()
      • gethostbyname()
      • gethostbyname_ex()
      • getnameinfo()
      • socketpair()
    • Python 2 interface
      • error
      • gaierror
        • gaierror.add_note()
        • gaierror.with_traceback()
        • gaierror.errno
        • gaierror.filename
        • gaierror.filename2
        • gaierror.strerror
      • herror
        • herror.add_note()
        • herror.with_traceback()
        • herror.errno
        • herror.filename
        • herror.filename2
        • herror.strerror
      • timeout
      • SocketType
      • socket
        • socket.bind()
        • socket.connect()
        • socket.connect_ex()
        • socket.dup()
        • socket.fileno()
        • socket.getblocking()
        • socket.getpeername()
        • socket.getsockname()
        • socket.getsockopt()
        • socket.gettimeout()
        • socket.listen()
        • socket.recv()
        • socket.recv_into()
        • socket.recvfrom()
        • socket.recvfrom_into()
        • socket.send()
        • socket.sendall()
        • socket.sendto()
        • socket.setblocking()
        • socket.setsockopt()
        • socket.settimeout()
        • socket.shutdown()
        • socket.family
        • socket.proto
        • socket.type
      • create_server()
      • getaddrinfo()
      • getdefaulttimeout()
      • getfqdn()
      • gethostbyaddr()
      • gethostbyname()
      • gethostbyname_ex()
      • gethostname()
      • getnameinfo()
      • getprotobyname()
      • getservbyname()
      • getservbyport()
      • has_dualstack_ipv6()
      • htonl()
      • htons()
      • inet_aton()
      • inet_ntoa()
      • inet_ntop()
      • inet_pton()
      • ntohl()
      • ntohs()
      • recv_fds()
      • send_fds()
      • setdefaulttimeout()
      • sethostname()
  • Gevent Extensions
    • Waiting
      • wait_read()
      • wait_write()
      • wait_readwrite()
      • wait()
      • cancel_wait()
• gevent.ssl – Secure Sockets Layer (SSL/TLS) module
  • SSLObject
  • Python 3 interface
    • CertificateError
    • SSLCertVerificationError
    • SSLEOFError
    • SSLError
    • SSLSyscallError
    • SSLWantReadError
    • SSLWantWriteError
    • SSLZeroReturnError
    • socket_error
    • AlertDescription
    • DefaultVerifyPaths
      • DefaultVerifyPaths.cafile
      • DefaultVerifyPaths.capath
      • DefaultVerifyPaths.openssl_cafile
      • DefaultVerifyPaths.openssl_cafile_env
      • DefaultVerifyPaths.openssl_capath
      • DefaultVerifyPaths.openssl_capath_env
    • Options
    • Purpose
    • SSLContext
      • SSLContext.sslsocket_class
      • SSLContext.sni_callback
    • SSLErrorNumber
    • SSLObject
      • SSLObject.cipher()
      • SSLObject.compression()
      • SSLObject.do_handshake()
      • SSLObject.get_channel_binding()
      • SSLObject.getpeercert()
      • SSLObject.pending()
      • SSLObject.read()
      • SSLObject.selected_alpn_protocol()
      • SSLObject.selected_npn_protocol()
      • SSLObject.shared_ciphers()
      • SSLObject.unwrap()
      • SSLObject.version()
      • SSLObject.write()
      • SSLObject.context
      • SSLObject.server_hostname
      • SSLObject.server_side
      • SSLObject.session
      • SSLObject.session_reused
    • SSLSocket
      • SSLSocket.accept()
      • SSLSocket.connect()
      • SSLSocket.connect_ex()
      • SSLSocket.do_handshake()
      • SSLSocket.dup()
      • SSLSocket.get_channel_binding()
      • SSLSocket.getpeercert()
      • SSLSocket.read()
      • SSLSocket.recv()
      • SSLSocket.recv_into()
      • SSLSocket.recvfrom()
      • SSLSocket.recvfrom_into()
      • SSLSocket.send()
      • SSLSocket.sendall()
      • SSLSocket.sendto()
      • SSLSocket.shared_ciphers()
      • SSLSocket.shutdown()
      • SSLSocket.version()
      • SSLSocket.write()
      • SSLSocket.session
      • SSLSocket.session_reused
    • TLSVersion
    • VerifyFlags
    • VerifyMode
    • DER_cert_to_PEM_cert()
    • PEM_cert_to_DER_cert()
    • RAND_add()
    • RAND_bytes()
    • RAND_pseudo_bytes()
    • RAND_status()
    • cert_time_to_seconds()
    • create_connection()
    • create_default_context()
    • get_default_verify_paths()
    • get_server_certificate()
    • match_hostname()
  • Python 2.7.9 and above interface (including PyPy 2.6.1 and above)
    • CertificateError
    • SSLCertVerificationError
    • SSLEOFError
    • SSLError
    • SSLSyscallError
    • SSLWantReadError
    • SSLWantWriteError
    • SSLZeroReturnError
    • socket_error
    • AlertDescription
    • DefaultVerifyPaths
      • DefaultVerifyPaths.cafile
      • DefaultVerifyPaths.capath
      • DefaultVerifyPaths.openssl_cafile
      • DefaultVerifyPaths.openssl_cafile_env
      • DefaultVerifyPaths.openssl_capath
      • DefaultVerifyPaths.openssl_capath_env
    • Options
    • Purpose
    • SSLContext
    • SSLErrorNumber
    • SSLObject
      • SSLObject.cipher()
      • SSLObject.compression()
      • SSLObject.do_handshake()
      • SSLObject.get_channel_binding()
      • SSLObject.getpeercert()
      • SSLObject.pending()
      • SSLObject.read()
      • SSLObject.selected_alpn_protocol()
      • SSLObject.selected_npn_protocol()
      • SSLObject.shared_ciphers()
      • SSLObject.unwrap()
      • SSLObject.version()
      • SSLObject.write()
      • SSLObject.context
      • SSLObject.server_hostname
      • SSLObject.server_side
      • SSLObject.session
      • SSLObject.session_reused
    • SSLSocket
      • SSLSocket.accept()
      • SSLSocket.connect()
      • SSLSocket.connect_ex()
      • SSLSocket.do_handshake()
      • SSLSocket.dup()
      • SSLSocket.get_channel_binding()
      • SSLSocket.getpeercert()
      • SSLSocket.makefile()
      • SSLSocket.read()
      • SSLSocket.recv()
      • SSLSocket.recv_into()
      • SSLSocket.recvfrom()
      • SSLSocket.recvfrom_into()
      • SSLSocket.send()
      • SSLSocket.sendall()
      • SSLSocket.sendto()
      • SSLSocket.shutdown()
      • SSLSocket.version()
      • SSLSocket.write()
    • TLSVersion
    • VerifyFlags
    • VerifyMode
    • DER_cert_to_PEM_cert()
    • PEM_cert_to_DER_cert()
    • RAND_add()
    • RAND_bytes()
    • RAND_pseudo_bytes()
    • RAND_status()
    • cert_time_to_seconds()
    • create_default_context()
    • get_default_verify_paths()
    • get_server_certificate()
    • match_hostname()
  • Python 2.7.8 and below interface
    • CertificateError
    • SSLCertVerificationError
    • SSLEOFError
    • SSLError
    • SSLSyscallError
    • SSLWantReadError
    • SSLWantWriteError
    • SSLZeroReturnError
    • socket_error
    • AlertDescription
    • DefaultVerifyPaths
      • DefaultVerifyPaths.cafile
      • DefaultVerifyPaths.capath
      • DefaultVerifyPaths.openssl_cafile
      • DefaultVerifyPaths.openssl_cafile_env
      • DefaultVerifyPaths.openssl_capath
      • DefaultVerifyPaths.openssl_capath_env
    • Options
    • Purpose
    • SSLContext
      • SSLContext.sslobject_class
      • SSLContext.sslsocket_class
    • SSLErrorNumber
    • SSLObject
      • SSLObject.cipher()
      • SSLObject.compression()
      • SSLObject.do_handshake()
      • SSLObject.get_channel_binding()
      • SSLObject.getpeercert()
      • SSLObject.pending()
      • SSLObject.read()
      • SSLObject.selected_alpn_protocol()
      • SSLObject.selected_npn_protocol()
      • SSLObject.shared_ciphers()
      • SSLObject.unwrap()
      • SSLObject.version()
      • SSLObject.write()
      • SSLObject.context
      • SSLObject.server_hostname
      • SSLObject.server_side
      • SSLObject.session
      • SSLObject.session_reused
    • SSLSocket
      • SSLSocket.accept()
      • SSLSocket.connect()
      • SSLSocket.do_handshake()
      • SSLSocket.getpeercert()
      • SSLSocket.makefile()
      • SSLSocket.read()
      • SSLSocket.recv()
      • SSLSocket.recv_into()
      • SSLSocket.recvfrom()
      • SSLSocket.recvfrom_into()
      • SSLSocket.send()
      • SSLSocket.sendall()
      • SSLSocket.sendto()
      • SSLSocket.shutdown()
      • SSLSocket.write()
    • TLSVersion
    • VerifyFlags
    • VerifyMode
    • DER_cert_to_PEM_cert()
    • PEM_cert_to_DER_cert()
    • RAND_add()
    • RAND_bytes()
    • RAND_pseudo_bytes()
    • RAND_status()
    • cert_time_to_seconds()
    • create_connection()
    • create_default_context()
    • get_default_verify_paths()
    • get_server_certificate()
    • match_hostname()
    • sslwrap_simple()
    • wrap_socket()
• gevent.subprocess – Cooperative subprocess module
  • CalledProcessError
    • CalledProcessError.stdout
  • SubprocessError
  • TimeoutExpired
  • CompletedProcess
    • CompletedProcess.check_returncode()
  • Popen
    • Popen.communicate()
    • Popen.kill()
    • Popen.pipe_cloexec()
    • Popen.poll()
    • Popen.send_signal()
    • Popen.terminate()
    • Popen.wait()
  • call()
  • check_call()
  • check_output()
  • getoutput()
  • getstatusoutput()
  • run()
• gevent.thread – Implementation of the standard thread module that spawns greenlets
  • error
  • LockType
    • LockType.acquire()
  • allocate_lock
  • allocate()
  • exit_thread()
  • get_native_id()
  • interrupt_main()
  • start_new()
• gevent.threading – Implementation of the standard threading using greenlets
  • Thread
  • Timer
• gevent.threadpool - A pool of native threads
  • ThreadPool
    • ThreadPool.apply()
    • ThreadPool.apply()
    • ThreadPool.apply_async()
    • ThreadPool.apply_cb()
    • ThreadPool.imap()
    • ThreadPool.imap_unordered()
    • ThreadPool.join()
    • ThreadPool.map()
    • ThreadPool.map_async()
    • ThreadPool.spawn()
    • ThreadPool.maxsize
    • ThreadPool.size
  • ThreadPoolExecutor
    • ThreadPoolExecutor.kill()
    • ThreadPoolExecutor.shutdown()
    • ThreadPoolExecutor.submit()
• gevent.time – Makes sleep gevent aware
  • sleep()
• gevent.util – Low-level utilities
  • GreenletTree
    • GreenletTree.current_tree()
    • GreenletTree.forest()
    • GreenletTree.format()
    • GreenletTree.format_lines()
    • GreenletTree.greenlet
    • GreenletTree.is_current_tree
  • assert_switches
  • wrap_errors
  • format_run_info()
  • print_run_info()

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