gevent API reference

100 public APIs from gevent (gevent/gevent) — 58 classes, 9 functions, 33 methods. Signatures extracted by static analysis of the actual source.

Repository: gevent/gevent

Kind	Count
Classes	58
Functions	9
Methods	33

API list

func_setuputils.read(*names)

Read a file path relative to this file.

classsrc.gevent._config.Config

Global configuration for gevent.

funcsrc.gevent._config.validate_bool(value)

This is a boolean value.

classsrc.gevent._ffi.watcher.AbstractWatcherType

Base metaclass for watchers.

classsrc.gevent._ffi.watcher.ResourceWarning

Python 2 fallback

classsrc.gevent._fileobjectcommon.FileIO

A subclass that we can dynamically assign __class__ for.

classsrc.gevent._fileobjectcommon.OpenDescriptor

Interprets the arguments to `open`.

funcsrc.gevent._hub_local.get_hub()

Return the hub for the current thread.

funcsrc.gevent._hub_local.get_hub_class()

Return the type of hub to use for the current thread.

funcsrc.gevent._hub_local.get_hub_if_exists()

Return the hub for the current thread.

classsrc.gevent._ident.ValuedWeakRef

A weak ref with an associated value.

classsrc.gevent._imap.IMapUnordered

At iterator of map results.

methodsrc.gevent._interfaces.ICallback.close()

An alias of `stop`.

classsrc.gevent._interfaces.ILoop

The common interface expected for all event loops.

methodsrc.gevent._interfaces.ILoop.destroy()

Clean up resources used by this loop.

methodsrc.gevent._interfaces.ILoop.run(once=False)

Run the event loop.

classsrc.gevent._interfaces.IWatcher

An event loop watcher.

classsrc.gevent._monitor.MonitorWarning

The type of warnings we emit.

classsrc.gevent._patcher.cached_platform_architecture

Context manager that caches ``platform.architecture``.

classsrc.gevent._semaphore.Semaphore

Semaphore(value=1) -> Semaphore ..

classsrc.gevent._tblib.Traceback

Class that wraps builtin Traceback objects.

methodsrc.gevent._tblib.Traceback.as_dict()

Converts to a dictionary representation.

classsrc.gevent._threading.Queue

Create a queue object.

methodsrc.gevent._threading.Queue.kill()

Call to destroy this object.

methodsrc.gevent._threading.Queue.put(item)

Put an item into the queue.

classsrc.gevent._util.Lazy

A non-data descriptor used just like @property.

classsrc.gevent._util.LazyOnClass

Similar to `Lazy`, but stores the value in the class.

classsrc.gevent._util.readproperty

A non-data descriptor similar to :class:`property`.

classsrc.gevent._waiter.Waiter

A low level communication utility for greenlets.

methodsrc.gevent._waiter.Waiter.throw(*throw_args)

Switch to the greenlet with the exception.

classsrc.gevent.backdoor.BackdoorServer

Provide a backdoor to a program for debugging purposes.

methodsrc.gevent.backdoor.BackdoorServer.handle(conn, _address)

Interact with one remote user.

methodsrc.gevent.baseserver.BaseServer.start()

Start accepting the connections.

classsrc.gevent.contextvars.Context

Implementation of :class:`contextvars.Context`

methodsrc.gevent.contextvars.Context.copy()

Return a shallow copy.

classsrc.gevent.contextvars.ContextVar

Implementation of :class:`contextvars.ContextVar`.

classsrc.gevent.contextvars.Token

Opaque implementation of :class:`contextvars.Token`.

classsrc.gevent.event.AsyncResult

A one-time event that stores a value or an exception.

methodsrc.gevent.event.AsyncResult.wait(timeout=None)

Block until the instance is ready.

methodsrc.gevent.event.Event.clear()

Reset the internal flag to false.

methodsrc.gevent.event.Event.set()

Set the internal flag to true.

classsrc.gevent.events.EventLoopBlocked

The event emitted when the event loop is blocked.

classsrc.gevent.events.GeventDidPatchAllEvent

Implementation of `IGeventDidPatchAllEvent`.

classsrc.gevent.events.GeventDidPatchBuiltinModulesEvent

Implementation of `IGeventDidPatchBuiltinModulesEvent`.

classsrc.gevent.events.GeventDidPatchEvent

Implementation of `IGeventDidPatchEvent`.

classsrc.gevent.events.GeventDidPatchModuleEvent

Implementation of `IGeventDidPatchModuleEvent`.

classsrc.gevent.events.GeventPatchEvent

Implementation of `IGeventPatchEvent`.

classsrc.gevent.events.GeventWillPatchAllEvent

Implementation of `IGeventWillPatchAllEvent`.

classsrc.gevent.events.GeventWillPatchEvent

Implementation of `IGeventWillPatchEvent`.

classsrc.gevent.events.GeventWillPatchModuleEvent

Implementation of `IGeventWillPatchModuleEvent`.

classsrc.gevent.events.IEventLoopBlocked

The event emitted when the event loop is blocked.

classsrc.gevent.events.IGeventDidPatchEvent

An event emitted *after* gevent has patched something.

classsrc.gevent.events.IGeventPatchEvent

The root for all monkey-patch events gevent emits.

classsrc.gevent.events.IGeventWillPatchEvent

An event emitted *before* gevent monkey-patches something.

classsrc.gevent.events.MemoryUsageThresholdExceeded

Implementation of `IMemoryUsageThresholdExceeded`.

classsrc.gevent.events.MemoryUsageUnderThreshold

Implementation of `IMemoryUsageUnderThreshold`.

classsrc.gevent.greenlet.Greenlet

A light-weight cooperatively-scheduled execution unit.

methodsrc.gevent.greenlet.Greenlet.name()

The greenlet name.

methodsrc.gevent.greenlet.Greenlet.unlink_all()

Remove all the callbacks.

classsrc.gevent.greenlet.SpawnedLink

A wrapper around link that calls it in another greenlet.

classsrc.gevent.hub.Hub

A greenlet that runs the event loop.

methodsrc.gevent.hub.Hub.join(timeout=None)

Wait for the event loop to finish.

methodsrc.gevent.hub.Hub.main_hub()

Is this the hub for the main thread?

methodsrc.gevent.hub.Hub.run()

Entry-point to running the loop.

funcsrc.gevent.hub.kill(greenlet, exception=GreenletExit)

Kill greenlet asynchronously.

classsrc.gevent.local.local

An object whose attributes are greenlet-local.

classsrc.gevent.lock.RLock

A mutex that can be acquired more than once by the same greenlet.

methodsrc.gevent.lock.RLock.release()

Release the mutex.

classsrc.gevent.monkey._errors.MonkeyPatchWarning

The type of warnings we issue.

funcsrc.gevent.monkey.patch_queue()

Patch objects in :mod:`queue`.

funcsrc.gevent.os.close(fd)

Close a file descriptor.

funcsrc.gevent.os.waitpid(pid, options)

Wait for a child process to finish.

methodsrc.gevent.pool.Group.add(greenlet)

Begin tracking the *greenlet*.

methodsrc.gevent.pool.Group.discard(greenlet)

Stop tracking the greenlet.

classsrc.gevent.pywsgi.Environ

A base class that can be used for WSGI environment objects.

classsrc.gevent.queue.Channel

A queue-like object that can only hold one item at a time.

classsrc.gevent.queue.ShutDown

gevent extension for Python versions less than 3.13

classsrc.gevent.queue.SimpleQueue

Create a queue object with a given maximum size.

methodsrc.gevent.queue.SimpleQueue.put(item, block=True, timeout=None)

Put an item into the queue.

methodsrc.gevent.queue.SimpleQueue.qsize()

Return the size of the queue.

methodsrc.gevent.resolver.AbstractResolver.close()

Release resources held by this object.

classsrc.gevent.resolver._hostsfile.HostsFile

A class to read the contents of a hosts file (/etc/hosts).

classsrc.gevent.resolver.dnspython.Resolver

An *experimental* resolver that uses `dnspython`_.

classsrc.gevent.selectors.GeventSelector

A selector implementation using gevent primitives.

methodsrc.gevent.selectors.GeventSelector.select(timeout=None)

Poll for I/O.

classsrc.gevent.server.DatagramServer

A UDP server

classsrc.gevent.server.StreamServer

A generic TCP server.

classsrc.gevent.subprocess.CompletedProcess

A process that has finished running.

methodsrc.gevent.subprocess.Popen.kill()

Kill the process with SIGKILL

methodsrc.gevent.subprocess.Popen.pipe_cloexec()

Create a pipe with FDs set CLOEXEC.

methodsrc.gevent.subprocess.Popen.poll()

Check if child process has terminated.

methodsrc.gevent.subprocess.Popen.send_signal(sig)

Send a signal to the process

methodsrc.gevent.subprocess.Popen.terminate()

Terminates the process

classsrc.gevent.thread.LockType

The basic lock type.

classsrc.gevent.threadpool.ThreadPool

A pool of native worker threads.

classsrc.gevent.threadpool.ThreadResult

A one-time event for cross-thread communication.

methodsrc.gevent.timeout.Timeout.cancel()

If the timeout is pending, cancel it.

methodsrc.gevent.timeout.Timeout.close()

Close the timeout and free resources.

methodsrc.gevent.timeout.Timeout.start()

Schedule the timeout.

classsrc.gevent.util.GreenletTree

Represents a tree of greenlets.

About this data

These signatures were extracted from the public source of gevent/gevent using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries