1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "class_property.h"
#include "pysidestaticstrings.h"
#include "feature_select.h"
#include <shiboken.h>
#include <sbkstaticstrings.h>
extern "C" {
/*
* A `classproperty` is the same as a `property` but the `__get__()` and `__set__()`
* methods are modified to always use the object class instead of a concrete instance.
*
* Note: A "static property" as it is often called does not exist per se.
* Static methods do not receive anything when created. Static methods which
* should participate in a property must be turned into class methods, before.
* See function `createProperty` in `feature_select.cpp`.
*/
// `class_property.__get__()`: Always pass the class instead of the instance.
static PyObject *PyClassProperty_descr_get(PyObject *self, PyObject * /*ob*/, PyObject *cls)
{
return PyProperty_Type.tp_descr_get(self, cls, cls);
}
// `class_property.__set__()`: Just like the above `__get__()`.
static int PyClassProperty_descr_set(PyObject *self, PyObject *obj, PyObject *value)
{
PyObject *cls = PyType_Check(obj) ? obj : reinterpret_cast<PyObject *>(Py_TYPE(obj));
return PyProperty_Type.tp_descr_set(self, cls, value);
}
// The property `__doc__` default does not work for class properties
// because PyProperty_Type.tp_init thinks this is a subclass which needs PyObject_SetAttr.
// We call `__init__` while pretending to be a PyProperty_Type instance.
static int PyClassProperty_tp_init(PyObject *self, PyObject *args, PyObject *kwargs)
{
auto hold = Py_TYPE(self);
self->ob_type = &PyProperty_Type;
auto ret = PyProperty_Type.tp_init(self, args, kwargs);
self->ob_type = hold;
return ret;
}
static PyType_Slot PyClassProperty_slots[] = {
{Py_tp_getset, nullptr}, // will be set below
{Py_tp_base, reinterpret_cast<void *>(&PyProperty_Type)},
{Py_tp_descr_get, reinterpret_cast<void *>(PyClassProperty_descr_get)},
{Py_tp_descr_set, reinterpret_cast<void *>(PyClassProperty_descr_set)},
{Py_tp_init, reinterpret_cast<void *>(PyClassProperty_tp_init)},
{0, 0}
};
static PyType_Spec PyClassProperty_spec = {
"2:PySide6.QtCore.PyClassProperty",
sizeof(propertyobject),
0,
Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
PyClassProperty_slots,
};
PyTypeObject *PyClassProperty_TypeF()
{
static PyTypeObject *type = nullptr;
if (type == nullptr) {
// Provide the same `tp_getset`, which is not inherited.
PyClassProperty_slots[0].pfunc = PyProperty_Type.tp_getset;
type = SbkType_FromSpec(&PyClassProperty_spec);
}
return type;
}
/*
* Types with class properties need to handle `Type.class_prop = x` in a specific way.
* By default, Python replaces the `class_property` itself, but for wrapped C++ types
* we need to call `class_property.__set__()` in order to propagate the new value to
* the underlying C++ data structure.
*/
static int SbkObjectType_meta_setattro(PyObject *obj, PyObject *name, PyObject *value)
{
// Use `_PepType_Lookup()` instead of `PyObject_GetAttr()` in order to get the raw
// descriptor (`property`) instead of calling `tp_descr_get` (`property.__get__()`).
auto type = reinterpret_cast<PyTypeObject *>(obj);
PySide::Feature::Select(type);
PyObject *descr = _PepType_Lookup(type, name);
// The following assignment combinations are possible:
// 1. `Type.class_prop = value` --> descr_set: `Type.class_prop.__set__(value)`
// 2. `Type.class_prop = other_class_prop` --> setattro: replace existing `class_prop`
// 3. `Type.regular_attribute = value` --> setattro: regular attribute assignment
const auto class_prop = reinterpret_cast<PyObject *>(PyClassProperty_TypeF());
const auto call_descr_set = descr && PyObject_IsInstance(descr, class_prop)
&& !PyObject_IsInstance(value, class_prop);
if (call_descr_set) {
// Call `class_property.__set__()` instead of replacing the `class_property`.
return Py_TYPE(descr)->tp_descr_set(descr, obj, value);
} else {
// Replace existing attribute.
return PyType_Type.tp_setattro(obj, name, value);
}
}
} // extern "C"
/*
* These functions are added to the SbkObjectType_TypeF() dynamically.
*/
namespace PySide { namespace ClassProperty {
static const char *PyClassProperty_SignatureStrings[] = {
"PySide6.QtCore.PyClassProperty(cls,"
"fget:typing.Optional[typing.Callable[[typing.Any],typing.Any]]=None,"
"fset:typing.Optional[typing.Callable[[typing.Any,typing.Any],None]]=None,"
"fdel:typing.Optional[typing.Callable[[typing.Any],None]]=None,"
"doc:typing.Optional[str]=None)",
"PySide6.QtCore.PyClassProperty.getter(cls,fget:typing.Callable[[typing.Any],typing.Any])->PySide6.QtCore.PyClassProperty",
"PySide6.QtCore.PyClassProperty.setter(cls,fset:typing.Callable[[typing.Any,typing.Any],None])->PySide6.QtCore.PyClassProperty",
"PySide6.QtCore.PyClassProperty.deleter(cls,fdel:typing.Callable[[typing.Any],None])->PySide6.QtCore.PyClassProperty",
nullptr}; // Sentinel
void init(PyObject *module)
{
PyTypeObject *type = SbkObjectType_TypeF();
type->tp_setattro = SbkObjectType_meta_setattro;
reinterpret_cast<PyObject *>(type)->ob_type = type;
if (InitSignatureStrings(PyClassProperty_TypeF(), PyClassProperty_SignatureStrings) < 0)
return;
Py_INCREF(PyClassProperty_TypeF());
auto classproptype = reinterpret_cast<PyObject *>(PyClassProperty_TypeF());
PyModule_AddObject(module, "PyClassProperty", classproptype);
}
} // namespace ClassProperty
} // namespace PySide
|
