Branch data Line data Source code
1 : : /*
2 : : * This file is part of the MicroPython project, http://micropython.org/
3 : : *
4 : : * The MIT License (MIT)
5 : : *
6 : : * Copyright (c) 2013, 2014 Damien P. George
7 : : * Copyright (c) 2014 Paul Sokolovsky
8 : : *
9 : : * Permission is hereby granted, free of charge, to any person obtaining a copy
10 : : * of this software and associated documentation files (the "Software"), to deal
11 : : * in the Software without restriction, including without limitation the rights
12 : : * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 : : * copies of the Software, and to permit persons to whom the Software is
14 : : * furnished to do so, subject to the following conditions:
15 : : *
16 : : * The above copyright notice and this permission notice shall be included in
17 : : * all copies or substantial portions of the Software.
18 : : *
19 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 : : * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 : : * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 : : * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 : : * THE SOFTWARE.
26 : : */
27 : :
28 : : #include <string.h>
29 : :
30 : : #include "py/objtuple.h"
31 : : #include "py/runtime.h"
32 : : #include "py/objstr.h"
33 : : #include "py/objnamedtuple.h"
34 : :
35 : : #if MICROPY_PY_COLLECTIONS
36 : :
37 : 60 : size_t mp_obj_namedtuple_find_field(const mp_obj_namedtuple_type_t *type, qstr name) {
38 [ + + ]: 108 : for (size_t i = 0; i < type->n_fields; i++) {
39 [ + + ]: 96 : if (type->fields[i] == name) {
40 : : return i;
41 : : }
42 : : }
43 : : return (size_t)-1;
44 : : }
45 : :
46 : : #if MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
47 : 4 : static mp_obj_t namedtuple_asdict(mp_obj_t self_in) {
48 : 4 : mp_obj_namedtuple_t *self = MP_OBJ_TO_PTR(self_in);
49 : 4 : const qstr *fields = ((mp_obj_namedtuple_type_t *)self->tuple.base.type)->fields;
50 : 4 : mp_obj_t dict = mp_obj_new_dict(self->tuple.len);
51 : : // make it an OrderedDict
52 : 4 : mp_obj_dict_t *dictObj = MP_OBJ_TO_PTR(dict);
53 : 4 : dictObj->base.type = &mp_type_ordereddict;
54 : 4 : dictObj->map.is_ordered = 1;
55 [ + + ]: 16 : for (size_t i = 0; i < self->tuple.len; ++i) {
56 : 12 : mp_obj_dict_store(dict, MP_OBJ_NEW_QSTR(fields[i]), self->tuple.items[i]);
57 : : }
58 : 4 : return dict;
59 : : }
60 : : MP_DEFINE_CONST_FUN_OBJ_1(namedtuple_asdict_obj, namedtuple_asdict);
61 : : #endif
62 : :
63 : 16 : static void namedtuple_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
64 : 16 : (void)kind;
65 : 16 : mp_obj_namedtuple_t *o = MP_OBJ_TO_PTR(o_in);
66 : 16 : mp_printf(print, "%q", o->tuple.base.type->name);
67 : 16 : const qstr *fields = ((mp_obj_namedtuple_type_t *)o->tuple.base.type)->fields;
68 : 16 : mp_obj_attrtuple_print_helper(print, fields, &o->tuple);
69 : 16 : }
70 : :
71 : 52 : static void namedtuple_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
72 [ + + ]: 52 : if (dest[0] == MP_OBJ_NULL) {
73 : : // load attribute
74 : 48 : mp_obj_namedtuple_t *self = MP_OBJ_TO_PTR(self_in);
75 : : #if MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
76 [ + + ]: 48 : if (attr == MP_QSTR__asdict) {
77 : 8 : dest[0] = MP_OBJ_FROM_PTR(&namedtuple_asdict_obj);
78 : 8 : dest[1] = self_in;
79 : 8 : return;
80 : : }
81 : : #endif
82 : 40 : size_t id = mp_obj_namedtuple_find_field((mp_obj_namedtuple_type_t *)self->tuple.base.type, attr);
83 [ + + ]: 40 : if (id == (size_t)-1) {
84 : : return;
85 : : }
86 : 32 : dest[0] = self->tuple.items[id];
87 : : } else {
88 : : // delete/store attribute
89 : : // provide more detailed error message than we'd get by just returning
90 : 4 : mp_raise_msg(&mp_type_AttributeError, MP_ERROR_TEXT("can't set attribute"));
91 : : }
92 : : }
93 : :
94 : 60 : static mp_obj_t namedtuple_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
95 : 60 : const mp_obj_namedtuple_type_t *type = (const mp_obj_namedtuple_type_t *)type_in;
96 : 60 : size_t num_fields = type->n_fields;
97 [ + + ]: 60 : if (n_args + n_kw != num_fields) {
98 : : #if MICROPY_ERROR_REPORTING <= MICROPY_ERROR_REPORTING_TERSE
99 : : mp_arg_error_terse_mismatch();
100 : : #elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_NORMAL
101 : : mp_raise_msg_varg(&mp_type_TypeError,
102 : : MP_ERROR_TEXT("function takes %d positional arguments but %d were given"),
103 : : num_fields, n_args + n_kw);
104 : : #elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
105 : 12 : mp_raise_msg_varg(&mp_type_TypeError,
106 : 12 : MP_ERROR_TEXT("%q() takes %d positional arguments but %d were given"),
107 : 12 : ((mp_obj_type_t *)&type->base)->name, num_fields, n_args + n_kw);
108 : : #endif
109 : : }
110 : :
111 : : // Create a namedtuple with explicit malloc. Calling mp_obj_new_tuple
112 : : // with num_fields=0 returns a read-only object.
113 : 48 : mp_obj_tuple_t *tuple = mp_obj_malloc_var(mp_obj_tuple_t, items, mp_obj_t, num_fields, type_in);
114 : 48 : tuple->len = num_fields;
115 : :
116 : : // Copy the positional args into the first slots of the namedtuple
117 : 48 : memcpy(&tuple->items[0], args, sizeof(mp_obj_t) * n_args);
118 : :
119 : : // Fill in the remaining slots with the keyword args
120 : 48 : memset(&tuple->items[n_args], 0, sizeof(mp_obj_t) * n_kw);
121 [ + + ]: 60 : for (size_t i = n_args; i < n_args + 2 * n_kw; i += 2) {
122 : 20 : qstr kw = mp_obj_str_get_qstr(args[i]);
123 : 20 : size_t id = mp_obj_namedtuple_find_field(type, kw);
124 [ + + ]: 20 : if (id == (size_t)-1) {
125 : : #if MICROPY_ERROR_REPORTING <= MICROPY_ERROR_REPORTING_TERSE
126 : : mp_arg_error_terse_mismatch();
127 : : #else
128 : 4 : mp_raise_msg_varg(&mp_type_TypeError, MP_ERROR_TEXT("unexpected keyword argument '%q'"), kw);
129 : : #endif
130 : : }
131 [ + + ]: 16 : if (tuple->items[id] != MP_OBJ_NULL) {
132 : : #if MICROPY_ERROR_REPORTING <= MICROPY_ERROR_REPORTING_TERSE
133 : : mp_arg_error_terse_mismatch();
134 : : #else
135 : 4 : mp_raise_msg_varg(&mp_type_TypeError,
136 : 4 : MP_ERROR_TEXT("function got multiple values for argument '%q'"), kw);
137 : : #endif
138 : : }
139 : 12 : tuple->items[id] = args[i + 1];
140 : : }
141 : :
142 : 40 : return MP_OBJ_FROM_PTR(tuple);
143 : : }
144 : :
145 : 24 : mp_obj_namedtuple_type_t *mp_obj_new_namedtuple_base(size_t n_fields, mp_obj_t *fields) {
146 : 24 : mp_obj_namedtuple_type_t *o = m_new_obj_var0(mp_obj_namedtuple_type_t, fields, qstr, n_fields);
147 : 24 : o->n_fields = n_fields;
148 [ + + ]: 68 : for (size_t i = 0; i < n_fields; i++) {
149 : 44 : o->fields[i] = mp_obj_str_get_qstr(fields[i]);
150 : : }
151 : 24 : return o;
152 : : }
153 : :
154 : 24 : static mp_obj_t mp_obj_new_namedtuple_type(qstr name, size_t n_fields, mp_obj_t *fields) {
155 : 24 : mp_obj_namedtuple_type_t *o = mp_obj_new_namedtuple_base(n_fields, fields);
156 : 24 : mp_obj_type_t *type = (mp_obj_type_t *)&o->base;
157 : 24 : type->base.type = &mp_type_type;
158 : 24 : type->flags = MP_TYPE_FLAG_EQ_CHECKS_OTHER_TYPE; // can match tuple
159 : 24 : type->name = name;
160 : 24 : MP_OBJ_TYPE_SET_SLOT(type, make_new, namedtuple_make_new, 0);
161 : 24 : MP_OBJ_TYPE_SET_SLOT(type, print, namedtuple_print, 1);
162 : 24 : MP_OBJ_TYPE_SET_SLOT(type, unary_op, mp_obj_tuple_unary_op, 2);
163 : 24 : MP_OBJ_TYPE_SET_SLOT(type, binary_op, mp_obj_tuple_binary_op, 3);
164 : 24 : MP_OBJ_TYPE_SET_SLOT(type, attr, namedtuple_attr, 4);
165 : 24 : MP_OBJ_TYPE_SET_SLOT(type, subscr, mp_obj_tuple_subscr, 5);
166 : 24 : MP_OBJ_TYPE_SET_SLOT(type, iter, mp_obj_tuple_getiter, 6);
167 : 24 : MP_OBJ_TYPE_SET_SLOT(type, parent, &mp_type_tuple, 7);
168 : 24 : return MP_OBJ_FROM_PTR(o);
169 : : }
170 : :
171 : 28 : static mp_obj_t new_namedtuple_type(mp_obj_t name_in, mp_obj_t fields_in) {
172 : 28 : qstr name = mp_obj_str_get_qstr(name_in);
173 : 28 : size_t n_fields;
174 : 28 : mp_obj_t *fields;
175 : : #if MICROPY_CPYTHON_COMPAT
176 [ + + + + : 28 : if (mp_obj_is_str(fields_in)) {
- + ]
177 : 4 : fields_in = mp_obj_str_split(1, &fields_in);
178 : : }
179 : : #endif
180 : 28 : mp_obj_get_array(fields_in, &n_fields, &fields);
181 : 24 : return mp_obj_new_namedtuple_type(name, n_fields, fields);
182 : : }
183 : : MP_DEFINE_CONST_FUN_OBJ_2(mp_namedtuple_obj, new_namedtuple_type);
184 : :
185 : : #endif // MICROPY_PY_COLLECTIONS
|