Page MenuHome
Differential D12322 Diff 41125 source/blender/python/intern/bpy.c

Changeset View

Standalone View

View Options

source/blender/python/intern/bpy.c

Show All 19 Lines
* This file defines the '_bpy' module which is used by python's 'bpy' package * This file defines the '_bpy' module which is used by python's 'bpy' package
* to access C defined builtin functions. * to access C defined builtin functions.
* A script writer should never directly access this module. * A script writer should never directly access this module.
*/ */
#include <Python.h> #include <Python.h>
#include "BLI_string.h" #include "BLI_string.h"
#include "BLI_string_utils.h"
#include "BLI_utildefines.h" #include "BLI_utildefines.h"
#include "BKE_appdir.h" #include "BKE_appdir.h"
#include "BKE_blender_version.h" #include "BKE_blender_version.h"
#include "BKE_bpath.h" #include "BKE_bpath.h"
#include "BKE_global.h" /* XXX, G_MAIN only */ #include "BKE_global.h" /* XXX, G_MAIN only */
#include "RNA_access.h" #include "RNA_access.h"
▲ Show 20 Lines • Show All 107 Lines • ▼ Show 20 Linesstatic PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
list = PyList_New(0); list = PyList_New(0);
BKE_bpath_traverse_main(G_MAIN, bpy_blend_paths_visit_cb, flag, (void *)list); BKE_bpath_traverse_main(G_MAIN, bpy_blend_paths_visit_cb, flag, (void *)list);
return list; return list;
} }
PyDoc_STRVAR(bpy_flip_name_doc,
".. function:: flip_name(from_name, strip_number)\n"
campbellbartonUnsubmitted
Done
Inline Actions

Prefer name strip_digits, more closely follows Python's terminology (str.isdigits(), string.digits, string.hexdigits).

campbellbarton: Prefer name `strip_digits`, more closely follows Python's terminology (`str.isdigits()`…
"\n"
" Flip a name between left/right sides, useful for \n"
" mirroring bone names.\n"
"\n"
" :arg name: Bone name to flip.\n"
" :type name: string\n"
" :arg strip_number: Whether to remove .### suffix.\n"
campbellbartonUnsubmitted
Done
Inline Actions

Use double tack for literals:

``.###``
campbellbarton: Use double tack for literals: ``` ``.###`` ```
campbellbartonUnsubmitted
Done
Inline Actions

Correction: Use double back-tick for literals:

campbellbarton: Correction: //Use double **back-tick** for literals://
" :type strip_number: bool\n"
" :return: The flipped name.\n"
" :rtype: string\n");
static PyObject *bpy_flip_name(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
{
const char *from_name = NULL;
bool strip_number = false;
static const char *_keywords[] = {"from_name", "strip_number", NULL};
campbellbartonUnsubmitted
Not Done
Inline Actions

from_name can be positional only argument, an empty string can be used here "".

campbellbarton: `from_name` can be positional only argument, an empty string can be used here `""`.
MetsAuthorUnsubmitted
Done
Inline Actions

Positional only arguments don't exist in Python, and even non-keyword-only arguments are usually discouraged, I don't see why we would want to prevent the caller from specifying the keyword, maybe I'm misunderstanding.

Mets: Positional only arguments don't exist in Python, and even non-keyword-only arguments are…
static _PyArg_Parser _parser = {"s|$O&:flip_name", _keywords, 0};
if (!_PyArg_ParseTupleAndKeywordsFast(
args, kw, &_parser, &from_name, PyC_ParseBool, &strip_number)) {
return NULL;
}
Py_ssize_t from_name_len = strlen(from_name);
campbellbartonUnsubmitted
Not Done
Inline Actions

No need to call strlen, instead pass s# to _PyArg_ParseTupleAndKeywordsFast.

campbellbarton: No need to call `strlen`, instead pass `s#` to `_PyArg_ParseTupleAndKeywordsFast`.
MetsAuthorUnsubmitted
Done
Inline Actions

Can you elaborate on this one? Would something like "s#|$O&:flip_name" feed the string length into an argument, or so?

Mets: Can you elaborate on this one? Would something like `"s#|$O&:flip_name"` feed the string length…
campbellbartonUnsubmitted
Not Done
Inline Actions

Yes, check the documentation for usage. https://docs.python.org/3/c-api/arg.html#c.Py_BuildValue

campbellbarton: Yes, check the documentation for usage. https://docs.python.org/3/c-api/arg.html#c.Py_BuildValue
campbellbartonUnsubmitted
Not Done
Inline Actions

Correct URL https://docs.python.org/3/c-api/arg.html#strings-and-buffers

campbellbarton: Correct URL https://docs.python.org/3/c-api/arg.html#strings-and-buffers
MetsAuthorUnsubmitted
Done
Inline Actions

Following code crashes:

Py_ssize_t from_name_len;

static const char *_keywords[] = {"from_name", "strip_digits", NULL};
static _PyArg_Parser _parser = {"s#|$O&:flip_name", _keywords, 0};
if (!_PyArg_ParseTupleAndKeywordsFast(
        args, kw, &_parser, &from_name, &from_name_len, PyC_ParseBool, &strip_digits)) {
  return NULL;
}

The debugger is giving me something very odd:

==2372449==ERROR: AddressSanitizer: requested allocation size 0x7fff00000008 (0x7fff00001008 after adjustments for alignment, red zones etc.) exceeds maximum supported size of 0x10000000000 (thread T0)
    #0 0x7ffff7682517 in malloc (/lib/x86_64-linux-gnu/libasan.so.6+0xb0517)
    #1 0x1f2ea7f7 in _PyObject_Malloc Objects/obmalloc.c:1645
    #2 0x1f2ea7f7 in _PyObject_Malloc Objects/obmalloc.c:1638
Mets: Following code crashes: ``` Py_ssize_t from_name_len; static const char *_keywords[] =…
if (from_name == NULL) {
PyErr_SetString(PyExc_TypeError, "expected a string");
return NULL;
}
campbellbartonUnsubmitted
Done
Inline Actions

This check isn't needed, _PyArg_ParseTupleAndKeywordsFast would return an error in this case, also the strlen above would have crashed if this is NULL.

campbellbarton: This check isn't needed, `_PyArg_ParseTupleAndKeywordsFast` would return an error in this case…
/* Worst case we gain one extra byte (besides null-terminator) by changing
"Left" to "Right", because only the first appearance of "Left" gets replaced. */
const size_t size = from_name_len + 2;
char *name_flip_str = PyMem_MALLOC(size);
BLI_string_flip_side_name(name_flip_str, from_name, strip_number, size);
PyObject *return_value = PyUnicode_FromStringAndSize(name_flip_str, strlen(name_flip_str));
campbellbartonUnsubmitted
Not Done
Inline Actions

No need to use strlen here, BLI_string_flip_side_name now returns the string length.

campbellbarton: No need to use `strlen` here, `BLI_string_flip_side_name` now returns the string length.
MetsAuthorUnsubmitted
Done
Inline Actions

With this code:

size_t size = from_name_len + 2;
char *name_flip_str = PyMem_MALLOC(size);

BLI_string_flip_side_name(name_flip_str, from_name, strip_number, size);

PyObject *return_value = PyUnicode_FromStringAndSize(name_flip_str, size);

I get strange results when I call the function from the PyAPI:

>>> bpy.utils.flip_name('a.Right')
'a.Left\x00\x00p'

>>> bpy.utils.flip_name('a.Left')
'a.Right\x00'

>>> bpy.utils.flip_name('a.L')
Traceback (most recent call last):
  File "<blender_console>", line 1, in <module>
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 4: invalid start byte

>>> bpy.utils.flip_name('a.R')
Traceback (most recent call last):
  File "<blender_console>", line 1, in <module>
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 4: invalid start byte
Mets: With this code: ``` size_t size = from_name_len + 2; char *name_flip_str = PyMem_MALLOC(size)…
campbellbartonUnsubmitted
Not Done
Inline Actions

The input size wont work, the return value is the length, e.g:

const size_t name_flip_str_len = BLI_string_flip_side_name(name_flip_str, from_name, strip_digits, size);

PyObject *return_value = PyUnicode_FromStringAndSize(name_flip_str, name_flip_str_len);

PyMem_FREE(name_flip_str);

return return_value;
campbellbarton: The input size wont work, the return value is the length, e.g: ``` const size_t…
PyMem_FREE(name_flip_str);
return return_value;
}
// PyDoc_STRVAR(bpy_user_resource_doc[] = /* now in bpy/utils.py */ // PyDoc_STRVAR(bpy_user_resource_doc[] = /* now in bpy/utils.py */
static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw) static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
{ {
const struct PyC_StringEnumItems type_items[] = { const struct PyC_StringEnumItems type_items[] = {
{BLENDER_USER_DATAFILES, "DATAFILES"}, {BLENDER_USER_DATAFILES, "DATAFILES"},
{BLENDER_USER_CONFIG, "CONFIG"}, {BLENDER_USER_CONFIG, "CONFIG"},
{BLENDER_USER_SCRIPTS, "SCRIPTS"}, {BLENDER_USER_SCRIPTS, "SCRIPTS"},
{BLENDER_USER_AUTOSAVE, "AUTOSAVE"}, {BLENDER_USER_AUTOSAVE, "AUTOSAVE"},
▲ Show 20 Lines • Show All 173 Lines • ▼ Show 20 Linesstatic PyMethodDef meth_bpy_script_paths = {
bpy_script_paths_doc, bpy_script_paths_doc,
}; };
static PyMethodDef meth_bpy_blend_paths = { static PyMethodDef meth_bpy_blend_paths = {
"blend_paths", "blend_paths",
(PyCFunction)bpy_blend_paths, (PyCFunction)bpy_blend_paths,
METH_VARARGS | METH_KEYWORDS, METH_VARARGS | METH_KEYWORDS,
bpy_blend_paths_doc, bpy_blend_paths_doc,
}; };
static PyMethodDef meth_bpy_flip_name = {
"flip_name",
(PyCFunction)bpy_flip_name,
METH_VARARGS | METH_KEYWORDS,
bpy_flip_name_doc,
};
static PyMethodDef meth_bpy_user_resource = { static PyMethodDef meth_bpy_user_resource = {
"user_resource", "user_resource",
(PyCFunction)bpy_user_resource, (PyCFunction)bpy_user_resource,
METH_VARARGS | METH_KEYWORDS, METH_VARARGS | METH_KEYWORDS,
NULL, NULL,
}; };
static PyMethodDef meth_bpy_system_resource = { static PyMethodDef meth_bpy_system_resource = {
"system_resource", "system_resource",
▲ Show 20 Lines • Show All 117 Lines • ▼ Show 20 Lines PyModule_AddObject(mod,
meth_bpy_resource_path.ml_name, meth_bpy_resource_path.ml_name,
(PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL)); (PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL));
PyModule_AddObject(mod, PyModule_AddObject(mod,
meth_bpy_escape_identifier.ml_name, meth_bpy_escape_identifier.ml_name,
(PyObject *)PyCFunction_New(&meth_bpy_escape_identifier, NULL)); (PyObject *)PyCFunction_New(&meth_bpy_escape_identifier, NULL));
PyModule_AddObject(mod, PyModule_AddObject(mod,
meth_bpy_unescape_identifier.ml_name, meth_bpy_unescape_identifier.ml_name,
(PyObject *)PyCFunction_New(&meth_bpy_unescape_identifier, NULL)); (PyObject *)PyCFunction_New(&meth_bpy_unescape_identifier, NULL));
PyModule_AddObject(mod,
meth_bpy_flip_name.ml_name,
(PyObject *)PyCFunction_New(&meth_bpy_flip_name, NULL));
/* register funcs (bpy_rna.c) */ /* register funcs (bpy_rna.c) */
PyModule_AddObject(mod, PyModule_AddObject(mod,
meth_bpy_register_class.ml_name, meth_bpy_register_class.ml_name,
(PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL)); (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
PyModule_AddObject(mod, PyModule_AddObject(mod,
meth_bpy_unregister_class.ml_name, meth_bpy_unregister_class.ml_name,
(PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL)); (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
Show All 11 Lines