TypeModule

class TypeModule(**properties: Any)

Superclasses: Object

Implemented Interfaces: TypePlugin

Constructors:

TypeModule(**properties)

Methods

class TypeModule
add_interface(instance_type: type, interface_type: type, interface_info: InterfaceInfo) → None

Registers an additional interface for a type, whose interface lives in the given type plugin. If the interface was already registered for the type in this plugin, nothing will be done.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if module is None this will call type_add_interface_static() instead. This can be used when making a static build of the module.

Parameters:

  • instance_type – type to which to add the interface.

  • interface_type – interface type to add

  • interface_info – type information structure

register_enum(name: str, const_static_values: EnumValue) → type

Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name type_name was previously registered, the Type identifier for the type is returned, otherwise the type is newly registered, and the resulting Type identifier returned.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if module is None this will call type_register_static() instead. This can be used when making a static build of the module.

Added in version 2.6.

Parameters:

  • name – name for the type

  • const_static_values – an array of EnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0.

register_flags(name: str, const_static_values: FlagsValue) → type

Looks up or registers a flags type that is implemented with a particular type plugin. If a type with name type_name was previously registered, the Type identifier for the type is returned, otherwise the type is newly registered, and the resulting Type identifier returned.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if module is None this will call type_register_static() instead. This can be used when making a static build of the module.

Added in version 2.6.

Parameters:

  • name – name for the type

  • const_static_values – an array of FlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0.

register_type(parent_type: type, type_name: str, type_info: TypeInfo, flags: TypeFlags) → type

Looks up or registers a type that is implemented with a particular type plugin. If a type with name type_name was previously registered, the Type identifier for the type is returned, otherwise the type is newly registered, and the resulting Type identifier returned.

When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized), module and parent_type must be the same as they were previously.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if module is None this will call type_register_static() instead. This can be used when making a static build of the module.

Parameters:

  • parent_type – the type for the parent class

  • type_name – name for the type

  • type_info – type information structure

  • flags – flags field providing details about the type

set_name(name: str) → None

Sets the name for a TypeModule

Parameters:

name – a human-readable name to use in error messages.

unuse() → None

Decreases the use count of a TypeModule by one. If the result is zero, the module will be unloaded. (However, the TypeModule will not be freed, and types associated with the TypeModule are not unregistered. Once a TypeModule is initialized, it must exist forever.)

use() → bool

Increases the use count of a TypeModule by one. If the use count was zero before, the plugin will be loaded. If loading the plugin fails, the use count is reset to its prior value.

Virtual Methods

class TypeModule
do_load() → bool

loads the module and registers one or more types using register_type().

do_unload() → None

unloads the module

Fields

class TypeModule
interface_infos
name

The name of the module

parent_instance
type_infos
use_count