diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-13 05:09:14 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-13 05:12:09 +0300 |
commit | bc1e517bb378dc71fe9c45386e72dbbbe852284b (patch) | |
tree | c9292f5673bc418f0da93df6946ff8a5f109768f /source/blender/python/generic | |
parent | 03015a9b222e29e894fe7ce0da059094a8fee9ce (diff) |
Docs: improve on doc-strings for BPY_extern_run.h
Also add ATTR_NONNULL function attributes.
Diffstat (limited to 'source/blender/python/generic')
-rw-r--r-- | source/blender/python/generic/py_capi_utils.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/source/blender/python/generic/py_capi_utils.h b/source/blender/python/generic/py_capi_utils.h index 09eade9c477..f6d8d7298af 100644 --- a/source/blender/python/generic/py_capi_utils.h +++ b/source/blender/python/generic/py_capi_utils.h @@ -138,6 +138,14 @@ const char *PyC_UnicodeAsByteAndSize(PyObject *py_str, Py_ssize_t *size, PyObjec */ PyObject *PyC_DefaultNameSpace(const char *filename); void PyC_RunQuicky(const char *filepath, int n, ...); +/** + * Import `imports` into `py_dict`. + * + * \param py_dict: A Python dictionary, typically used as a name-space for script execution. + * \param imports: A NULL terminated array of strings. + * \return true when all modules import without errors, otherwise return false. + * The caller is expected to handle the exception. + */ bool PyC_NameSpace_ImportArray(PyObject *py_dict, const char *imports[]); /** |