Decorator used to register object type Examples -------- >>> @register_object >>> class MyObject: >>> ... pass Parameters ---------- type_key : str or cls The type key of the object
(type_key=None)
| 87 | |
| 88 | |
| 89 | def register_object(type_key=None): |
| 90 | """Decorator used to register object type |
| 91 | |
| 92 | Examples |
| 93 | -------- |
| 94 | >>> @register_object |
| 95 | >>> class MyObject: |
| 96 | >>> ... pass |
| 97 | |
| 98 | Parameters |
| 99 | ---------- |
| 100 | type_key : str or cls |
| 101 | The type key of the object |
| 102 | """ |
| 103 | object_name = type_key if isinstance(type_key, str) else type_key.__name__ |
| 104 | |
| 105 | def register(cls): |
| 106 | """internal register function""" |
| 107 | tindex = ctypes.c_int() |
| 108 | ret = _LIB.DGLObjectTypeKey2Index( |
| 109 | c_str(object_name), ctypes.byref(tindex) |
| 110 | ) |
| 111 | if ret == 0: |
| 112 | _register_object(tindex.value, cls) |
| 113 | return cls |
| 114 | |
| 115 | if isinstance(type_key, str): |
| 116 | return register |
| 117 | return register(type_key) |
nothing calls this directly
no test coverage detected