griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: use nodiscard attribute for functions in the Python API

Browse Source 
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.
This commit is contained in:
Campbell Barton
2025-06-28 00:15:23 +00:00
parent 0d3826b354
commit 6253a33aa3
71 changed files with 496 additions and 468 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
source/blender/python/mathutils/mathutils_Vector.hh
View File

@@ -26,30 +26,28 @@ struct VectorObject {
/* Prototypes. */
PyObject *Vector_CreatePyObject(const float *vec,
int vec_num,
PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT;
[[nodiscard]] PyObject *Vector_CreatePyObject(const float *vec,
int vec_num,
PyTypeObject *base_type);
/**
* Create a vector that wraps existing memory.
*
* \param vec: Use this vector in-place.
*/
PyObject *Vector_CreatePyObject_wrap(float *vec,
int vec_num,
PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL(1);
[[nodiscard]] PyObject *Vector_CreatePyObject_wrap(float *vec,
int vec_num,
PyTypeObject *base_type) ATTR_NONNULL(1);
/**
* Create a vector where the value is defined by registered callbacks,
* see: #Mathutils_RegisterCallback
*/
PyObject *Vector_CreatePyObject_cb(PyObject *cb_user,
int vec_num,
unsigned char cb_type,
unsigned char cb_subtype) ATTR_WARN_UNUSED_RESULT;
[[nodiscard]] PyObject *Vector_CreatePyObject_cb(PyObject *cb_user,
int vec_num,
unsigned char cb_type,
unsigned char cb_subtype);
/**
* \param vec: Initialized vector value to use in-place, allocated with #PyMem_Malloc
*/
PyObject *Vector_CreatePyObject_alloc(float *vec,
int vec_num,
PyTypeObject *base_type) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL(1);
[[nodiscard]] PyObject *Vector_CreatePyObject_alloc(float *vec,
int vec_num,
PyTypeObject *base_type) ATTR_NONNULL(1);