MLIR: mlir::python::nanobind_adaptors::pure_subclass Class Reference

MLIR 22.0.0git

Provides a facility like nanobind::class_ for defining a new class in a scope, but this allows extension of an arbitrary Python class, defining methods on it is a similar way. More...

#include "mlir/Bindings/Python/NanobindAdaptors.h"

Inheritance diagram for mlir::python::nanobind_adaptors::pure_subclass:

Public Member Functions
	pure_subclass (nanobind::handle scope, const char *derivedClassName, const nanobind::object &superClass)
template<typename Func, typename... Extra>
pure_subclass &	def (const char *name, Func &&f, const Extra &...extra)
template<typename Func, typename... Extra>
pure_subclass &	def_property_readonly (const char *name, Func &&f, const Extra &...extra)
template<typename Func, typename... Extra>
pure_subclass &	def_staticmethod (const char *name, Func &&f, const Extra &...extra)
template<typename Func, typename... Extra>
pure_subclass &	def_classmethod (const char *name, Func &&f, const Extra &...extra)
nanobind::object	get_class () const

Protected Attributes
nanobind::object	superClass
nanobind::object	thisClass

Detailed Description

Provides a facility like nanobind::class_ for defining a new class in a scope, but this allows extension of an arbitrary Python class, defining methods on it is a similar way.

Classes defined in this way are very similar to if defined in Python in the usual way but use nanobind machinery to do it. These are not "real" nanobind classes but pure Python classes with no relation to a concrete C++ class.

Derived from a discussion upstream: https://github.com/pybind/pybind11/issues/1193 (plus a fair amount of extra curricular poking) TODO: If this proves useful, see about including it in nanobind.

Definition at line 438 of file NanobindAdaptors.h.

Constructor & Destructor Documentation

◆ pure_subclass()

mlir::python::nanobind_adaptors::pure_subclass::pure_subclass	(	nanobind::handle	scope,
		const char *	derivedClassName,
		const nanobind::object &	superClass )

inline

Definition at line 440 of file NanobindAdaptors.h.

References superClass, and thisClass.

Referenced by def(), def_classmethod(), def_property_readonly(), def_staticmethod(), mlir::python::nanobind_adaptors::mlir_attribute_subclass::mlir_attribute_subclass(), mlir::python::nanobind_adaptors::mlir_type_subclass::mlir_type_subclass(), and mlir::python::nanobind_adaptors::mlir_value_subclass::mlir_value_subclass().

Member Function Documentation

◆ def()

template<typename Func, typename... Extra>

pure_subclass & mlir::python::nanobind_adaptors::pure_subclass::def	(	const char *	name,
		Func &&	f,
		const Extra &...	extra )

inline

Definition at line 454 of file NanobindAdaptors.h.

References pure_subclass(), and thisClass.

Referenced by mlir::python::nanobind_adaptors::mlir_attribute_subclass::mlir_attribute_subclass(), mlir::python::nanobind_adaptors::mlir_type_subclass::mlir_type_subclass(), and populateDialectLLVMSubmodule().

◆ def_classmethod()

template<typename Func, typename... Extra>

pure_subclass & mlir::python::nanobind_adaptors::pure_subclass::def_classmethod	(	const char *	name,
		Func &&	f,
		const Extra &...	extra )

inline

Definition at line 489 of file NanobindAdaptors.h.

References pure_subclass(), and thisClass.

Referenced by NB_MODULE(), populateDialectLLVMSubmodule(), and populateDialectSparseTensorSubmodule().

◆ def_property_readonly()

template<typename Func, typename... Extra>

pure_subclass & mlir::python::nanobind_adaptors::pure_subclass::def_property_readonly	(	const char *	name,
		Func &&	f,
		const Extra &...	extra )

inline

Definition at line 463 of file NanobindAdaptors.h.

References pure_subclass(), and thisClass.

Referenced by populateDialectSparseTensorSubmodule().

◆ def_staticmethod()

template<typename Func, typename... Extra>

pure_subclass & mlir::python::nanobind_adaptors::pure_subclass::def_staticmethod	(	const char *	name,
		Func &&	f,
		const Extra &...	extra )

inline

Definition at line 475 of file NanobindAdaptors.h.

References pure_subclass(), and thisClass.

Referenced by mlir::python::nanobind_adaptors::mlir_attribute_subclass::mlir_attribute_subclass(), mlir::python::nanobind_adaptors::mlir_type_subclass::mlir_type_subclass(), mlir::python::nanobind_adaptors::mlir_value_subclass::mlir_value_subclass(), and populateDialectSMTSubmodule().

◆ get_class()

nanobind::object mlir::python::nanobind_adaptors::pure_subclass::get_class ( ) const

inline

Definition at line 503 of file NanobindAdaptors.h.

References thisClass.

Member Data Documentation

◆ superClass

nanobind::object mlir::python::nanobind_adaptors::pure_subclass::superClass

protected

Definition at line 506 of file NanobindAdaptors.h.

Referenced by pure_subclass().

◆ thisClass

nanobind::object mlir::python::nanobind_adaptors::pure_subclass::thisClass

protected

Definition at line 507 of file NanobindAdaptors.h.

Referenced by def(), def_classmethod(), def_property_readonly(), def_staticmethod(), get_class(), mlir::python::nanobind_adaptors::mlir_attribute_subclass::mlir_attribute_subclass(), mlir::python::nanobind_adaptors::mlir_type_subclass::mlir_type_subclass(), mlir::python::nanobind_adaptors::mlir_value_subclass::mlir_value_subclass(), and pure_subclass().

The documentation for this class was generated from the following file:

include/mlir/Bindings/Python/NanobindAdaptors.h