Files
test/source/blender/python/intern/bpy_props.hh
Campbell Barton 6253a33aa3 Cleanup: use nodiscard attribute for functions in the Python API
In most (cases functions returning a PyObject pointer
requires it to be used by the caller, declare functions in the Python
API with the `nodiscard` attribute.
2025-06-28 10:15:27 +10:00

40 lines
1.1 KiB
C++

/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup pythonintern
*/
#pragma once
#include <Python.h>
struct StructRNA;
[[nodiscard]] PyObject *BPY_rna_props();
/**
* Run this on exit, clearing all Python callback users and disable the RNA callback,
* as it would be called after Python has already finished.
*/
void BPY_rna_props_clear_all();
[[nodiscard]] PyObject *BPy_PointerProperty(PyObject *self, PyObject *args, PyObject *kw);
[[nodiscard]] PyObject *BPy_CollectionProperty(PyObject *self, PyObject *args, PyObject *kw);
[[nodiscard]] StructRNA *pointer_type_from_py(PyObject *value, const char *error_prefix);
struct BPy_PropDeferred {
PyObject_HEAD
/**
* Internally a #PyCFunctionObject type.
* \note This isn't GC tracked, it's a function from `bpy.props` so it's not going away.
*/
void *fn;
PyObject *kw;
};
extern PyTypeObject bpy_prop_deferred_Type;
#define BPy_PropDeferred_CheckTypeExact(v) (Py_TYPE(v) == &bpy_prop_deferred_Type)
#define PYRNA_STACK_ARRAY RNA_STACK_ARRAY