Mojo module
bindings
Provides infrastructure for creating Python bindings to Mojo code.
This module implements the core machinery for exposing Mojo functions and types to Python through CPython's C API. It includes builder types for constructing Python modules and type objects, wrapper functions for converting between Mojo and Python calling conventions, and utilities for argument validation and type conversion. This enables seamless bidirectional interoperability between Mojo and Python code.
comptime values
GenericPyFunction
comptime GenericPyFunction = Variant[PyFunctionRaising, PyFunctionWithKeywordsRaising]
A variant type that can hold either a PyFunctionRaising or PyFunctionWithKeywordsRaising.
MOJO_PYTHON_TYPE_OBJECTS
comptime MOJO_PYTHON_TYPE_OBJECTS = _Global["MOJO_PYTHON_TYPE_OBJECTS", __init__[StaticString, PythonObject, default_hasher]]
Mapping of Mojo type identifiers to unique PyTypeObject* binding that Mojo type to this CPython interpreter instance.
PyFunctionRaising
comptime PyFunctionRaising = fn(mut PythonObject, mut PythonObject) raises -> PythonObject
The generic function type for raising Python bindings.
The first argument is the self object, and the second argument is a tuple of the
positional arguments. These functions always return a Python object (could be a
None object).
PyFunctionWithKeywordsRaising
comptime PyFunctionWithKeywordsRaising = fn(mut PythonObject, mut PythonObject, mut PythonObject) raises -> PythonObject
The generic function type for raising Python bindings with keyword arguments.
The first argument is the self object, the second argument is a tuple of the positional arguments, and the third argument is a dictionary of the keyword arguments.
Structs
-
PyMojoObject: Storage backing a PyObject* wrapping a Mojo value. -
PythonModuleBuilder: A builder for creating Python modules with Mojo function and type bindings. -
PythonTypeBuilder: A builder for a Python 'type' binding.
Functions
-
check_and_get_arg: Get the argument at the given index and downcast it to a given Mojo type. -
check_and_get_or_convert_arg: Get the argument at the given index and convert it to a given Mojo type. -
check_arguments_arity: Validate that the provided arguments match the expected function arity. -
lookup_py_type_object: Retrieve a reference to the unique Python type describing Python objects containing Mojo values of typeT.
Was this page helpful?
Thank you! We'll create more content like this.
Thank you for helping us improve!