archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

PyAPI: utility functions for parsing typed RNA arguments

Browse Source 
These functions can be used with PyArg_ParseTupleAndKeywords
(and related functions) to take typed RNA arguments without
having to extract and type-check them separately.

No functional changes, extracted from D13126.
This commit is contained in:
Campbell Barton
2022-04-20 12:06:03 +10:00
parent 16afff2ddc
commit 6d9268c2c7
2 changed files with 71 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
source/blender/python/intern/bpy_rna.c
View File

@@ -7872,6 +7872,50 @@ StructRNA *pyrna_struct_as_srna(PyObject *self, const bool parent, const char *e
return srna;
}
const PointerRNA *pyrna_struct_as_ptr(PyObject *py_obj, const StructRNA *srna)
{
BPy_StructRNA *bpy_srna = (BPy_StructRNA *)py_obj;
if (!BPy_StructRNA_Check(py_obj) || !RNA_struct_is_a(bpy_srna->ptr.type, srna)) {
PyErr_Format(PyExc_TypeError,
"Expected a \"bpy.types.%.200s\" not a \"%.200s\"",
RNA_struct_identifier(srna),
Py_TYPE(py_obj)->tp_name);
return NULL;
}
PYRNA_STRUCT_CHECK_OBJ(bpy_srna);
return &bpy_srna->ptr;
}
const PointerRNA *pyrna_struct_as_ptr_or_null(PyObject *py_obj, const StructRNA *srna)
{
if (py_obj == Py_None) {
return &PointerRNA_NULL;
}
return pyrna_struct_as_ptr(py_obj, srna);
}
int pyrna_struct_as_ptr_parse(PyObject *o, void *p)
{
struct BPy_StructRNA_Parse *srna_parse = p;
BLI_assert(srna_parse->type != NULL);
srna_parse->ptr = pyrna_struct_as_ptr(o, srna_parse->type);
if (srna_parse->ptr == NULL) {
return 0;
}
return 1;
}
int pyrna_struct_as_ptr_or_null_parse(PyObject *o, void *p)
{
struct BPy_StructRNA_Parse *srna_parse = p;
BLI_assert(srna_parse->type != NULL);
srna_parse->ptr = pyrna_struct_as_ptr_or_null(o, srna_parse->type);
if (srna_parse->ptr == NULL) {
return 0;
}
return 1;
}
/* Orphan functions, not sure where they should go. */
StructRNA *srna_from_self(PyObject *self, const char *error_prefix)
{