Skip to content

Commit 777b0f3

Browse files
dpgeorgedpgeorge
committed
py: Add property object, with basic functionality.
Enabled by MICROPY_ENABLE_PROPERTY.
1 parent 4417478 commit 777b0f3

8 files changed

Lines changed: 159 additions & 3 deletions

File tree

‎py/builtintables.c‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ STATIC const mp_map_elem_t mp_builtin_object_table[] = {
3131
{ MP_OBJ_NEW_QSTR(MP_QSTR_list), (mp_obj_t)&mp_type_list },
3232
{ MP_OBJ_NEW_QSTR(MP_QSTR_map), (mp_obj_t)&mp_type_map },
3333
{ MP_OBJ_NEW_QSTR(MP_QSTR_object), (mp_obj_t)&mp_type_object },
34+
#if MICROPY_ENABLE_PROPERTY
35+
{ MP_OBJ_NEW_QSTR(MP_QSTR_property), (mp_obj_t)&mp_type_property },
36+
#endif
3437
{ MP_OBJ_NEW_QSTR(MP_QSTR_set), (mp_obj_t)&mp_type_set },
3538
{ MP_OBJ_NEW_QSTR(MP_QSTR_str), (mp_obj_t)&mp_type_str },
3639
{ MP_OBJ_NEW_QSTR(MP_QSTR_super), (mp_obj_t)&mp_type_super },

‎py/mpconfig.h‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,11 @@ typedef double mp_float_t;
135135
#define MICROPY_ENABLE_SLICE (1)
136136
#endif
137137

138+
// Whether to support the property object
139+
#ifndef MICROPY_ENABLE_PROPERTY
140+
#define MICROPY_ENABLE_PROPERTY (0)
141+
#endif
142+
138143
// Enable features which improve CPython compatibility
139144
// but may lead to more code size/memory usage.
140145
// TODO: Originally intended as generic category to not

‎py/obj.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ extern const mp_obj_type_t mp_type_fun_bc;
283283
extern const mp_obj_type_t mp_type_module;
284284
extern const mp_obj_type_t mp_type_staticmethod;
285285
extern const mp_obj_type_t mp_type_classmethod;
286+
extern const mp_obj_type_t mp_type_property;
286287

287288
// Exceptions
288289
extern const mp_obj_type_t mp_type_BaseException;
@@ -518,6 +519,9 @@ typedef struct _mp_obj_static_class_method_t {
518519
mp_obj_t fun;
519520
} mp_obj_static_class_method_t;
520521

522+
// property
523+
const mp_obj_t *mp_obj_property_get(mp_obj_t self_in);
524+
521525
// sequence helpers
522526
void mp_seq_multiply(const void *items, uint item_sz, uint len, uint times, void *dest);
523527
bool m_seq_get_fast_slice_indexes(machine_uint_t len, mp_obj_t slice, machine_uint_t *begin, machine_uint_t *end);

‎py/objproperty.c‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
#include <stdlib.h>
2+
#include <assert.h>
3+
4+
#include "nlr.h"
5+
#include "misc.h"
6+
#include "mpconfig.h"
7+
#include "qstr.h"
8+
#include "obj.h"
9+
#include "runtime.h"
10+
11+
#if MICROPY_ENABLE_PROPERTY
12+
13+
typedef struct _mp_obj_property_t {
14+
mp_obj_base_t base;
15+
mp_obj_t proxy[3]; // getter, setter, deleter
16+
} mp_obj_property_t;
17+
18+
STATIC mp_obj_t property_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
19+
// TODO check n_kw == 0
20+
21+
mp_obj_property_t *o = m_new_obj(mp_obj_property_t);
22+
o->base.type = &mp_type_property;
23+
if (n_args >= 5) {
24+
nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "property takes at most 4 arguments"));
25+
}
26+
if (n_args >= 4) {
27+
// doc ignored
28+
}
29+
if (n_args >= 3) {
30+
o->proxy[2] = args[2];
31+
} else {
32+
o->proxy[2] = mp_const_none;
33+
}
34+
if (n_args >= 2) {
35+
o->proxy[1] = args[1];
36+
} else {
37+
o->proxy[1] = mp_const_none;
38+
}
39+
if (n_args >= 1) {
40+
o->proxy[0] = args[0];
41+
} else {
42+
o->proxy[0] = mp_const_none;
43+
}
44+
return o;
45+
}
46+
47+
STATIC mp_obj_t property_getter(mp_obj_t self_in, mp_obj_t getter) {
48+
mp_obj_property_t *p2 = m_new_obj(mp_obj_property_t);
49+
*p2 = *(mp_obj_property_t*)self_in;
50+
p2->proxy[0] = getter;
51+
return p2;
52+
}
53+
54+
STATIC MP_DEFINE_CONST_FUN_OBJ_2(property_getter_obj, property_getter);
55+
56+
STATIC mp_obj_t property_setter(mp_obj_t self_in, mp_obj_t setter) {
57+
mp_obj_property_t *p2 = m_new_obj(mp_obj_property_t);
58+
*p2 = *(mp_obj_property_t*)self_in;
59+
p2->proxy[1] = setter;
60+
return p2;
61+
}
62+
63+
STATIC MP_DEFINE_CONST_FUN_OBJ_2(property_setter_obj, property_setter);
64+
65+
STATIC mp_obj_t property_deleter(mp_obj_t self_in, mp_obj_t deleter) {
66+
mp_obj_property_t *p2 = m_new_obj(mp_obj_property_t);
67+
*p2 = *(mp_obj_property_t*)self_in;
68+
p2->proxy[2] = deleter;
69+
return p2;
70+
}
71+
72+
STATIC MP_DEFINE_CONST_FUN_OBJ_2(property_deleter_obj, property_deleter);
73+
74+
STATIC const mp_map_elem_t property_locals_dict_table[] = {
75+
{ MP_OBJ_NEW_QSTR(MP_QSTR_getter), (mp_obj_t)&property_getter_obj },
76+
{ MP_OBJ_NEW_QSTR(MP_QSTR_setter), (mp_obj_t)&property_setter_obj },
77+
{ MP_OBJ_NEW_QSTR(MP_QSTR_deleter), (mp_obj_t)&property_deleter_obj },
78+
};
79+
80+
STATIC MP_DEFINE_CONST_DICT(property_locals_dict, property_locals_dict_table);
81+
82+
const mp_obj_type_t mp_type_property = {
83+
{ &mp_type_type },
84+
.name = MP_QSTR_property,
85+
.make_new = property_make_new,
86+
.locals_dict = (mp_obj_t)&property_locals_dict,
87+
};
88+
89+
const mp_obj_t *mp_obj_property_get(mp_obj_t self_in) {
90+
assert(MP_OBJ_IS_TYPE(self_in, &mp_type_property));
91+
mp_obj_property_t *self = self_in;
92+
return self->proxy;
93+
}
94+
95+
#endif // MICROPY_ENABLE_PROPERTY

‎py/objtype.c‎

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,15 +229,35 @@ STATIC mp_obj_t class_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
229229
STATIC void class_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
230230
// logic: look in obj members then class locals (TODO check this against CPython)
231231
mp_obj_class_t *self = self_in;
232+
232233
mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP);
233234
if (elem != NULL) {
234235
// object member, always treated as a value
236+
// TODO should we check for properties?
235237
dest[0] = elem->value;
236238
return;
237239
}
240+
238241
mp_obj_t member = mp_obj_class_lookup(self->base.type, attr);
239242
if (member != MP_OBJ_NULL) {
240-
class_convert_return_attr(self_in, member, dest);
243+
if (0) {
244+
#if MICROPY_ENABLE_PROPERTY
245+
} else if (MP_OBJ_IS_TYPE(member, &mp_type_property)) {
246+
// object member is a property
247+
// delegate the store to the property
248+
// TODO should this be part of class_convert_return_attr?
249+
const mp_obj_t *proxy = mp_obj_property_get(member);
250+
if (proxy[0] == mp_const_none) {
251+
// TODO
252+
} else {
253+
dest[0] = mp_call_function_n_kw(proxy[0], 1, 0, &self_in);
254+
// TODO should we convert the returned value using class_convert_return_attr?
255+
}
256+
#endif
257+
} else {
258+
// not a property
259+
class_convert_return_attr(self_in, member, dest);
260+
}
241261
return;
242262
}
243263

@@ -257,10 +277,30 @@ STATIC void class_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
257277

258278
STATIC bool class_store_attr(mp_obj_t self_in, qstr attr, mp_obj_t value) {
259279
mp_obj_class_t *self = self_in;
280+
281+
#if MICROPY_ENABLE_PROPERTY
282+
// for property, we need to do a lookup first in the class dict
283+
// this makes all stores slow... how to fix?
284+
mp_obj_t member = mp_obj_class_lookup(self->base.type, attr);
285+
if (member != MP_OBJ_NULL && MP_OBJ_IS_TYPE(member, &mp_type_property)) {
286+
// attribute already exists and is a property
287+
// delegate the store to the property
288+
const mp_obj_t *proxy = mp_obj_property_get(member);
289+
if (proxy[1] == mp_const_none) {
290+
// TODO better error message
291+
return false;
292+
} else {
293+
mp_obj_t dest[2] = {self_in, value};
294+
mp_call_function_n_kw(proxy[1], 2, 0, dest);
295+
return true;
296+
}
297+
}
298+
#endif
299+
260300
if (value == MP_OBJ_NULL) {
261301
// delete attribute
262-
mp_map_elem_t *el = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
263-
return el != NULL;
302+
mp_map_elem_t *elem = mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_REMOVE_IF_FOUND);
303+
return elem != NULL;
264304
} else {
265305
// store attribute
266306
mp_map_lookup(&self->members, MP_OBJ_NEW_QSTR(attr), MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = value;

‎py/py.mk‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ PY_O_BASENAME = \
6060
objmap.o \
6161
objmodule.o \
6262
objobject.o \
63+
objproperty.o \
6364
objnone.o \
6465
objnamedtuple.o \
6566
objrange.o \

‎py/qstrdefs.h‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,3 +281,10 @@ Q(stdout)
281281
Q(stderr)
282282
Q(version_info)
283283
#endif
284+
285+
#if MICROPY_ENABLE_PROPERTY
286+
Q(property)
287+
Q(getter)
288+
Q(setter)
289+
Q(deleter)
290+
#endif

‎unix/mpconfigport.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
#define MICROPY_ENABLE_REPL_HELPERS (1)
1111
#define MICROPY_ENABLE_LEXER_UNIX (1)
1212
#define MICROPY_ENABLE_SOURCE_LINE (1)
13+
#define MICROPY_ENABLE_PROPERTY (1)
1314
#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_DOUBLE)
1415
#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_MPZ)
1516
#define MICROPY_PATH_MAX (PATH_MAX)

0 commit comments

Comments
 (0)