modbuiltins.c 30 KB
Newer Older
1
/*
2
 * This file is part of the MicroPython project, http://micropython.org/
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

27 28 29
#include <stdio.h>
#include <assert.h>

30
#include "py/smallint.h"
31
#include "py/objint.h"
32
#include "py/objstr.h"
33
#include "py/objtype.h"
34 35 36
#include "py/runtime.h"
#include "py/builtin.h"
#include "py/stream.h"
37

38
#if MICROPY_PY_BUILTINS_FLOAT
39 40 41
#include <math.h>
#endif

42
#if MICROPY_PY_IO
43
extern struct _mp_dummy_t mp_sys_stdout_obj; // type is irrelevant, just need pointer
44 45
#endif

Damien George's avatar
Damien George committed
46 47 48
// args[0] is function from class body
// args[1] is class name
// args[2:] are base objects
49
STATIC mp_obj_t mp_builtin___build_class__(size_t n_args, const mp_obj_t *args) {
Damien George's avatar
Damien George committed
50 51
    assert(2 <= n_args);

52 53
    // set the new classes __locals__ object
    mp_obj_dict_t *old_locals = mp_locals_get();
54
    mp_obj_t class_locals = mp_obj_new_dict(0);
55
    mp_locals_set(MP_OBJ_TO_PTR(class_locals));
56 57

    // call the class code
58
    mp_obj_t cell = mp_call_function_0(args[0]);
59 60

    // restore old __locals__ object
Damien George's avatar
Damien George committed
61
    mp_locals_set(old_locals);
62

Damien George's avatar
Damien George committed
63 64 65 66
    // get the class type (meta object) from the base objects
    mp_obj_t meta;
    if (n_args == 2) {
        // no explicit bases, so use 'type'
67
        meta = MP_OBJ_FROM_PTR(&mp_type_type);
Damien George's avatar
Damien George committed
68 69
    } else {
        // use type of first base object
70
        meta = MP_OBJ_FROM_PTR(mp_obj_get_type(args[2]));
Damien George's avatar
Damien George committed
71 72 73 74 75 76
    }

    // TODO do proper metaclass resolution for multiple base objects

    // create the new class using a call to the meta object
    mp_obj_t meta_args[3];
77
    meta_args[0] = args[1]; // class name
Damien George's avatar
Damien George committed
78
    meta_args[1] = mp_obj_new_tuple(n_args - 2, args + 2); // tuple of bases
79
    meta_args[2] = class_locals; // dict of members
Damien George's avatar
Damien George committed
80
    mp_obj_t new_class = mp_call_function_n_kw(meta, 3, 0, meta_args);
Damien George's avatar
Damien George committed
81 82 83 84 85 86 87

    // store into cell if neede
    if (cell != mp_const_none) {
        mp_obj_cell_set(cell, new_class);
    }

    return new_class;
88
}
Damien George's avatar
Damien George committed
89 90
MP_DEFINE_CONST_FUN_OBJ_VAR(mp_builtin___build_class___obj, 2, mp_builtin___build_class__);

91
STATIC mp_obj_t mp_builtin_abs(mp_obj_t o_in) {
92
    return mp_unary_op(MP_UNARY_OP_ABS, o_in);
93
}
94 95
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_abs_obj, mp_builtin_abs);

96
STATIC mp_obj_t mp_builtin_all(mp_obj_t o_in) {
97 98
    mp_obj_iter_buf_t iter_buf;
    mp_obj_t iterable = mp_getiter(o_in, &iter_buf);
99
    mp_obj_t item;
100
    while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
Damien George's avatar
Damien George committed
101
        if (!mp_obj_is_true(item)) {
102
            return mp_const_false;
103 104
        }
    }
105
    return mp_const_true;
106
}
107 108
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_all_obj, mp_builtin_all);

109
STATIC mp_obj_t mp_builtin_any(mp_obj_t o_in) {
110 111
    mp_obj_iter_buf_t iter_buf;
    mp_obj_t iterable = mp_getiter(o_in, &iter_buf);
112
    mp_obj_t item;
113
    while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
Damien George's avatar
Damien George committed
114
        if (mp_obj_is_true(item)) {
115
            return mp_const_true;
116 117
        }
    }
118
    return mp_const_false;
119
}
120 121
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_any_obj, mp_builtin_any);

122 123
STATIC mp_obj_t mp_builtin_bin(mp_obj_t o_in) {
    mp_obj_t args[] = { MP_OBJ_NEW_QSTR(MP_QSTR__brace_open__colon__hash_b_brace_close_), o_in };
124
    return mp_obj_str_format(MP_ARRAY_SIZE(args), args, NULL);
125 126 127
}
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_bin_obj, mp_builtin_bin);

128
STATIC mp_obj_t mp_builtin_callable(mp_obj_t o_in) {
129 130
    if (mp_obj_is_callable(o_in)) {
        return mp_const_true;
131
    } else {
132
        return mp_const_false;
133 134
    }
}
135 136
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_callable_obj, mp_builtin_callable);

137
STATIC mp_obj_t mp_builtin_chr(mp_obj_t o_in) {
138
    #if MICROPY_PY_BUILTINS_STR_UNICODE
139
    mp_uint_t c = mp_obj_get_int(o_in);
140
    uint8_t str[4];
141 142 143 144
    int len = 0;
    if (c < 0x80) {
        *str = c; len = 1;
    } else if (c < 0x800) {
145 146
        str[0] = (c >> 6) | 0xC0;
        str[1] = (c & 0x3F) | 0x80;
147 148
        len = 2;
    } else if (c < 0x10000) {
149 150 151
        str[0] = (c >> 12) | 0xE0;
        str[1] = ((c >> 6) & 0x3F) | 0x80;
        str[2] = (c & 0x3F) | 0x80;
152 153
        len = 3;
    } else if (c < 0x110000) {
154 155 156 157
        str[0] = (c >> 18) | 0xF0;
        str[1] = ((c >> 12) & 0x3F) | 0x80;
        str[2] = ((c >> 6) & 0x3F) | 0x80;
        str[3] = (c & 0x3F) | 0x80;
158
        len = 4;
159
    } else {
160
        mp_raise_ValueError("chr() arg not in range(0x110000)");
161
    }
162
    return mp_obj_new_str_via_qstr((char*)str, len);
163
    #else
164
    mp_int_t ord = mp_obj_get_int(o_in);
165
    if (0 <= ord && ord <= 0xff) {
166 167
        uint8_t str[1] = {ord};
        return mp_obj_new_str_via_qstr((char*)str, 1);
168
    } else {
169
        mp_raise_ValueError("chr() arg not in range(256)");
170 171
    }
    #endif
172
}
173 174
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_chr_obj, mp_builtin_chr);

175
STATIC mp_obj_t mp_builtin_dir(size_t n_args, const mp_obj_t *args) {
176
    mp_obj_t dir = mp_obj_new_list(0, NULL);
177
    if (n_args == 0) {
178
        // Make a list of names in the local namespace
179
        mp_obj_dict_t *dict = mp_locals_get();
180
        for (size_t i = 0; i < dict->map.alloc; i++) {
181 182
            if (MP_MAP_SLOT_IS_FILLED(&dict->map, i)) {
                mp_obj_list_append(dir, dict->map.table[i].key);
183 184
            }
        }
185
    } else { // n_args == 1
186 187 188
        // Make a list of names in the given object
        // Implemented by probing all possible qstrs with mp_load_method_maybe
        size_t nqstr = QSTR_TOTAL();
189 190 191 192 193
        for (size_t i = 1; i < nqstr; ++i) {
            mp_obj_t dest[2];
            mp_load_method_maybe(args[0], i, dest);
            if (dest[0] != MP_OBJ_NULL) {
                mp_obj_list_append(dir, MP_OBJ_NEW_QSTR(i));
194 195 196
            }
        }
    }
197 198 199 200
    return dir;
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_dir_obj, 0, 1, mp_builtin_dir);

201
STATIC mp_obj_t mp_builtin_divmod(mp_obj_t o1_in, mp_obj_t o2_in) {
202
    return mp_binary_op(MP_BINARY_OP_DIVMOD, o1_in, o2_in);
203
}
204 205
MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_divmod_obj, mp_builtin_divmod);

206
STATIC mp_obj_t mp_builtin_hash(mp_obj_t o_in) {
207 208
    // result is guaranteed to be a (small) int
    return mp_unary_op(MP_UNARY_OP_HASH, o_in);
209
}
210
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_hash_obj, mp_builtin_hash);
211

Damien George's avatar
Damien George committed
212
STATIC mp_obj_t mp_builtin_hex(mp_obj_t o_in) {
213
    return mp_binary_op(MP_BINARY_OP_MODULO, MP_OBJ_NEW_QSTR(MP_QSTR__percent__hash_x), o_in);
Damien George's avatar
Damien George committed
214 215 216
}
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_hex_obj, mp_builtin_hex);

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
#if MICROPY_PY_BUILTINS_INPUT

#include "py/mphal.h"
#include "lib/mp-readline/readline.h"

// A port can define mp_hal_readline if they want to use a custom function here
#ifndef mp_hal_readline
#define mp_hal_readline readline
#endif

STATIC mp_obj_t mp_builtin_input(size_t n_args, const mp_obj_t *args) {
    if (n_args == 1) {
        mp_obj_print(args[0], PRINT_STR);
    }
    vstr_t line;
    vstr_init(&line, 16);
    int ret = mp_hal_readline(&line, "");
    if (ret == CHAR_CTRL_C) {
        nlr_raise(mp_obj_new_exception(&mp_type_KeyboardInterrupt));
    }
    if (line.len == 0 && ret == CHAR_CTRL_D) {
        nlr_raise(mp_obj_new_exception(&mp_type_EOFError));
    }
    return mp_obj_new_str_from_vstr(&mp_type_str, &line);
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_input_obj, 0, 1, mp_builtin_input);

#endif

246
STATIC mp_obj_t mp_builtin_iter(mp_obj_t o_in) {
247
    return mp_getiter(o_in, NULL);
248
}
249 250
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_iter_obj, mp_builtin_iter);

251 252
#if MICROPY_PY_BUILTINS_MIN_MAX

253
STATIC mp_obj_t mp_builtin_min_max(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs, mp_uint_t op) {
254
    mp_map_elem_t *key_elem = mp_map_lookup(kwargs, MP_OBJ_NEW_QSTR(MP_QSTR_key), MP_MAP_LOOKUP);
255
    mp_map_elem_t *default_elem;
256
    mp_obj_t key_fn = key_elem == NULL ? MP_OBJ_NULL : key_elem->value;
257 258
    if (n_args == 1) {
        // given an iterable
259 260
        mp_obj_iter_buf_t iter_buf;
        mp_obj_t iterable = mp_getiter(args[0], &iter_buf);
261 262
        mp_obj_t best_key = MP_OBJ_NULL;
        mp_obj_t best_obj = MP_OBJ_NULL;
263
        mp_obj_t item;
264
        while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
265 266 267 268
            mp_obj_t key = key_fn == MP_OBJ_NULL ? item : mp_call_function_1(key_fn, item);
            if (best_obj == MP_OBJ_NULL || (mp_binary_op(op, key, best_key) == mp_const_true)) {
                best_key = key;
                best_obj = item;
269
            }
270
        }
271
        if (best_obj == MP_OBJ_NULL) {
272 273 274 275
            default_elem = mp_map_lookup(kwargs, MP_OBJ_NEW_QSTR(MP_QSTR_default), MP_MAP_LOOKUP);
            if (default_elem != NULL) {
                best_obj = default_elem->value;
            } else {
276
                mp_raise_ValueError("arg is an empty sequence");
277
            }
278
        }
279
        return best_obj;
280
    } else {
281
        // given many args
282 283
        mp_obj_t best_key = MP_OBJ_NULL;
        mp_obj_t best_obj = MP_OBJ_NULL;
284
        for (size_t i = 0; i < n_args; i++) {
285 286 287 288
            mp_obj_t key = key_fn == MP_OBJ_NULL ? args[i] : mp_call_function_1(key_fn, args[i]);
            if (best_obj == MP_OBJ_NULL || (mp_binary_op(op, key, best_key) == mp_const_true)) {
                best_key = key;
                best_obj = args[i];
289 290
            }
        }
291
        return best_obj;
292 293 294
    }
}

295
STATIC mp_obj_t mp_builtin_max(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
296
    return mp_builtin_min_max(n_args, args, kwargs, MP_BINARY_OP_MORE);
297
}
298
MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_max_obj, 1, mp_builtin_max);
299

300
STATIC mp_obj_t mp_builtin_min(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
301 302 303
    return mp_builtin_min_max(n_args, args, kwargs, MP_BINARY_OP_LESS);
}
MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_min_obj, 1, mp_builtin_min);
304

305 306
#endif

307
STATIC mp_obj_t mp_builtin_next(mp_obj_t o) {
Damien George's avatar
Damien George committed
308
    mp_obj_t ret = mp_iternext_allow_raise(o);
309
    if (ret == MP_OBJ_STOP_ITERATION) {
310
        nlr_raise(mp_obj_new_exception(&mp_type_StopIteration));
311 312 313
    } else {
        return ret;
    }
314 315 316
}
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_next_obj, mp_builtin_next);

317 318 319 320 321
STATIC mp_obj_t mp_builtin_oct(mp_obj_t o_in) {
    return mp_binary_op(MP_BINARY_OP_MODULO, MP_OBJ_NEW_QSTR(MP_QSTR__percent__hash_o), o_in);
}
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_oct_obj, mp_builtin_oct);

322
STATIC mp_obj_t mp_builtin_ord(mp_obj_t o_in) {
323
    size_t len;
324
    const byte *str = (const byte*)mp_obj_str_get_data(o_in, &len);
325
    #if MICROPY_PY_BUILTINS_STR_UNICODE
326
    if (MP_OBJ_IS_STR(o_in)) {
327
        len = utf8_charlen(str, len);
328
        if (len == 1) {
329
            return mp_obj_new_int(utf8_get_char(str));
330
        }
331 332 333 334
    } else
    #endif
    {
        // a bytes object, or a str without unicode support (don't sign extend the char)
335
        if (len == 1) {
336
            return MP_OBJ_NEW_SMALL_INT(str[0]);
337
        }
338
    }
339

340
    #if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE
341
        mp_raise_TypeError("ord expects a character");
342
    #else
343
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError,
344
            "ord() expected a character, but string of length %d found", (int)len));
345
    #endif
346
}
347 348
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_ord_obj, mp_builtin_ord);

349
STATIC mp_obj_t mp_builtin_pow(size_t n_args, const mp_obj_t *args) {
350
    switch (n_args) {
Damien George's avatar
Damien George committed
351
        case 2: return mp_binary_op(MP_BINARY_OP_POWER, args[0], args[1]);
352 353 354 355 356 357 358 359
        default:
#if !MICROPY_PY_BUILTINS_POW3
            mp_raise_msg(&mp_type_NotImplementedError, "3-arg pow() not supported");
#elif MICROPY_LONGINT_IMPL != MICROPY_LONGINT_IMPL_MPZ
            return mp_binary_op(MP_BINARY_OP_MODULO, mp_binary_op(MP_BINARY_OP_POWER, args[0], args[1]), args[2]);
#else
            return mp_obj_int_pow3(args[0], args[1], args[2]);
#endif
360 361
    }
}
362 363
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_pow_obj, 2, 3, mp_builtin_pow);

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
STATIC mp_obj_t mp_builtin_print(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
    enum { ARG_sep, ARG_end, ARG_file };
    static const mp_arg_t allowed_args[] = {
        { MP_QSTR_sep, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_QSTR(MP_QSTR__space_)} },
        { MP_QSTR_end, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_QSTR(MP_QSTR__0x0a_)} },
        #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
        { MP_QSTR_file, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_rom_obj = MP_ROM_PTR(&mp_sys_stdout_obj)} },
        #endif
    };

    // parse args (a union is used to reduce the amount of C stack that is needed)
    union {
        mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
        size_t len[2];
    } u;
    mp_arg_parse_all(0, NULL, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, u.args);
380

381 382 383
    #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
    // TODO file may not be a concrete object (eg it could be a small-int)
    mp_print_t print = {MP_OBJ_TO_PTR(u.args[ARG_file].u_obj), mp_stream_write_adaptor};
384
    #endif
385 386 387 388 389 390 391

    // extract the objects first because we are going to use the other part of the union
    mp_obj_t sep = u.args[ARG_sep].u_obj;
    mp_obj_t end = u.args[ARG_end].u_obj;
    const char *sep_data = mp_obj_str_get_data(sep, &u.len[0]);
    const char *end_data = mp_obj_str_get_data(end, &u.len[1]);

392
    for (size_t i = 0; i < n_args; i++) {
393
        if (i > 0) {
394
            #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
395
            mp_stream_write_adaptor(print.data, sep_data, u.len[0]);
396
            #else
397
            mp_print_strn(&mp_plat_print, sep_data, u.len[0], 0, 0, 0);
398
            #endif
399
        }
400
        #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
401
        mp_obj_print_helper(&print, pos_args[i], PRINT_STR);
402
        #else
403
        mp_obj_print_helper(&mp_plat_print, pos_args[i], PRINT_STR);
404
        #endif
405
    }
406
    #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
407
    mp_stream_write_adaptor(print.data, end_data, u.len[1]);
408
    #else
409
    mp_print_strn(&mp_plat_print, end_data, u.len[1], 0, 0, 0);
410
    #endif
411
    return mp_const_none;
412
}
413
MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_print_obj, 0, mp_builtin_print);
414

415 416
STATIC mp_obj_t mp_builtin___repl_print__(mp_obj_t o) {
    if (o != mp_const_none) {
417 418
        mp_obj_print_helper(MP_PYTHON_PRINTER, o, PRINT_REPR);
        mp_print_str(MP_PYTHON_PRINTER, "\n");
419
        #if MICROPY_CAN_OVERRIDE_BUILTINS
420
        // Set "_" special variable
421
        mp_obj_t dest[2] = {MP_OBJ_SENTINEL, o};
422
        mp_type_module.attr(MP_OBJ_FROM_PTR(&mp_module_builtins), MP_QSTR__, dest);
423
        #endif
424 425 426 427 428
    }
    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin___repl_print___obj, mp_builtin___repl_print__);

429
STATIC mp_obj_t mp_builtin_repr(mp_obj_t o_in) {
430
    vstr_t vstr;
431 432 433
    mp_print_t print;
    vstr_init_print(&vstr, 16, &print);
    mp_obj_print_helper(&print, o_in, PRINT_REPR);
434
    return mp_obj_new_str_from_vstr(&mp_type_str, &vstr);
Damien George's avatar
Damien George committed
435 436 437
}
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_repr_obj, mp_builtin_repr);

438
STATIC mp_obj_t mp_builtin_round(size_t n_args, const mp_obj_t *args) {
439
    mp_obj_t o_in = args[0];
440 441 442 443 444 445

    if (MP_OBJ_IS_TYPE(o_in, &mp_type_bool)) {
        // Convert bool to int
        o_in = MP_OBJ_NEW_SMALL_INT(mp_obj_get_int(o_in));
    }

446
    if (MP_OBJ_IS_INT(o_in)) {
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
        mp_int_t num_dig = 0;
        if (n_args > 1) {
            num_dig = mp_obj_get_int(args[1]);
        }
        if (num_dig >= 0) {
            // No rounding required, return original object
            return o_in;
        }

        // Truncate unwanted digits by subtracting the remainder
        mp_obj_t mult = mp_binary_op(MP_BINARY_OP_POWER, MP_OBJ_NEW_SMALL_INT(10), MP_OBJ_NEW_SMALL_INT(-num_dig));
        mp_obj_tuple_t *divmod = (mp_obj_tuple_t*)MP_OBJ_TO_PTR(mp_binary_op(MP_BINARY_OP_DIVMOD, o_in, mult));
        mp_obj_t rounded = mp_binary_op(MP_BINARY_OP_SUBTRACT, o_in, divmod->items[1]);

        // Round answer up if needed, preferring even values in case of a rounding tie
        mp_obj_t r2 = mp_binary_op(MP_BINARY_OP_ADD, divmod->items[1], divmod->items[1]);
        if (mp_obj_is_true(mp_binary_op(MP_BINARY_OP_LESS, mult, r2))
            || (mp_obj_is_true(mp_binary_op(MP_BINARY_OP_EQUAL, mult, r2))
                && mp_obj_is_true(mp_binary_op(MP_BINARY_OP_AND, divmod->items[0], MP_OBJ_NEW_SMALL_INT(1))))) {
            rounded = mp_binary_op(MP_BINARY_OP_ADD, rounded, mult);
        }

        return rounded;
470
    }
471

472
#if MICROPY_PY_BUILTINS_FLOAT
473
    mp_float_t val = mp_obj_get_float(o_in);
474
    if (n_args > 1) {
475
        mp_int_t num_dig = mp_obj_get_int(args[1]);
476
        mp_float_t mult = MICROPY_FLOAT_C_FUN(pow)(10, num_dig);
477 478 479 480 481 482 483 484 485 486 487 488 489 490
        mp_float_t val_mult = val * mult;
        if (!isfinite(val_mult)) {
            if (num_dig >= 0) {
                // Overflow in number of digits so just keep them all and return original number
                return o_in;
            } else {
                // Round to zero to remove all digits, retaining the sign of the value to round
                return mp_obj_new_float(0 * val);
            }
        }
        mp_float_t rounded = MICROPY_FLOAT_C_FUN(nearbyint)(val_mult) / mult;
        if (!isfinite(rounded)) {
            mp_raise_msg(&mp_type_OverflowError, NULL);
        }
491
        return mp_obj_new_float(rounded);
492
    }
493
    mp_float_t rounded = MICROPY_FLOAT_C_FUN(nearbyint)(val);
494
    return mp_obj_new_int_from_float(rounded);
495
#else
496
    mp_raise_TypeError("int required");
497
#endif
498
}
499
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_round_obj, 1, 2, mp_builtin_round);
500

501
STATIC mp_obj_t mp_builtin_sum(size_t n_args, const mp_obj_t *args) {
502
    mp_obj_t value;
503
    switch (n_args) {
504
        case 1: value = MP_OBJ_NEW_SMALL_INT(0); break;
505
        default: value = args[1]; break;
506
    }
507 508
    mp_obj_iter_buf_t iter_buf;
    mp_obj_t iterable = mp_getiter(args[0], &iter_buf);
509
    mp_obj_t item;
510
    while ((item = mp_iternext(iterable)) != MP_OBJ_STOP_ITERATION) {
Damien George's avatar
Damien George committed
511
        value = mp_binary_op(MP_BINARY_OP_ADD, value, item);
512 513 514
    }
    return value;
}
515
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_sum_obj, 1, 2, mp_builtin_sum);
John R. Lenton's avatar
sorted  
John R. Lenton committed
516

517
STATIC mp_obj_t mp_builtin_sorted(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
518
    if (n_args > 1) {
519
        mp_raise_TypeError("must use keyword argument for key function");
John R. Lenton's avatar
sorted  
John R. Lenton committed
520
    }
521
    mp_obj_t self = mp_type_list.make_new(&mp_type_list, 1, 0, args);
522
    mp_obj_list_sort(1, &self, kwargs);
John R. Lenton's avatar
sorted  
John R. Lenton committed
523 524 525

    return self;
}
526
MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_sorted_obj, 1, mp_builtin_sorted);
527

528
// See mp_load_attr() if making any changes
529
static inline mp_obj_t mp_load_attr_default(mp_obj_t base, qstr attr, mp_obj_t defval) {
530 531 532 533 534 535 536 537 538 539 540 541 542 543
    mp_obj_t dest[2];
    // use load_method, raising or not raising exception
    ((defval == MP_OBJ_NULL) ? mp_load_method : mp_load_method_maybe)(base, attr, dest);
    if (dest[0] == MP_OBJ_NULL) {
        return defval;
    } else if (dest[1] == MP_OBJ_NULL) {
        // load_method returned just a normal attribute
        return dest[0];
    } else {
        // load_method returned a method, so build a bound method object
        return mp_obj_new_bound_meth(dest[0], dest[1]);
    }
}

544
STATIC mp_obj_t mp_builtin_getattr(size_t n_args, const mp_obj_t *args) {
545 546 547 548
    mp_obj_t defval = MP_OBJ_NULL;
    if (n_args > 2) {
        defval = args[2];
    }
stijn's avatar
stijn committed
549
    return mp_load_attr_default(args[0], mp_obj_str_get_qstr(args[1]), defval);
550
}
551
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_getattr_obj, 2, 3, mp_builtin_getattr);
552

stijn's avatar
stijn committed
553 554 555 556 557 558
STATIC mp_obj_t mp_builtin_setattr(mp_obj_t base, mp_obj_t attr, mp_obj_t value) {
    mp_store_attr(base, mp_obj_str_get_qstr(attr), value);
    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_3(mp_builtin_setattr_obj, mp_builtin_setattr);

559 560 561 562 563 564 565
#if MICROPY_CPYTHON_COMPAT
STATIC mp_obj_t mp_builtin_delattr(mp_obj_t base, mp_obj_t attr) {
    return mp_builtin_setattr(base, attr, MP_OBJ_NULL);
}
MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_delattr_obj, mp_builtin_delattr);
#endif

566
STATIC mp_obj_t mp_builtin_hasattr(mp_obj_t object_in, mp_obj_t attr_in) {
567
    qstr attr = mp_obj_str_get_qstr(attr_in);
568 569

    mp_obj_t dest[2];
570
    // TODO: https://docs.python.org/3/library/functions.html?highlight=hasattr#hasattr
571 572 573
    // explicitly says "This is implemented by calling getattr(object, name) and seeing
    // whether it raises an AttributeError or not.", so we should explicitly wrap this
    // in nlr_push and handle exception.
574
    mp_load_method_maybe(object_in, attr, dest);
575

576
    return mp_obj_new_bool(dest[0] != MP_OBJ_NULL);
577 578 579
}
MP_DEFINE_CONST_FUN_OBJ_2(mp_builtin_hasattr_obj, mp_builtin_hasattr);

580 581 582 583 584 585
STATIC mp_obj_t mp_builtin_globals(void) {
    return MP_OBJ_FROM_PTR(mp_globals_get());
}
MP_DEFINE_CONST_FUN_OBJ_0(mp_builtin_globals_obj, mp_builtin_globals);

STATIC mp_obj_t mp_builtin_locals(void) {
586 587 588
    if (!(MP_STATE_THREAD(scope_flags) & MP_SCOPE_FLAG_LOCALS_VALID)) {
        mp_raise_NotImplementedError("locals() in this context");
    }
589 590 591 592
    return MP_OBJ_FROM_PTR(mp_locals_get());
}
MP_DEFINE_CONST_FUN_OBJ_0(mp_builtin_locals_obj, mp_builtin_locals);

593
// These are defined in terms of MicroPython API functions right away
594
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_id_obj, mp_obj_id);
595
MP_DEFINE_CONST_FUN_OBJ_1(mp_builtin_len_obj, mp_obj_len);
596

597
STATIC const mp_rom_map_elem_t mp_module_builtins_globals_table[] = {
598 599
    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_builtins) },

600
    // built-in core functions
601 602 603
    { MP_ROM_QSTR(MP_QSTR___build_class__), MP_ROM_PTR(&mp_builtin___build_class___obj) },
    { MP_ROM_QSTR(MP_QSTR___import__), MP_ROM_PTR(&mp_builtin___import___obj) },
    { MP_ROM_QSTR(MP_QSTR___repl_print__), MP_ROM_PTR(&mp_builtin___repl_print___obj) },
604 605

    // built-in types
606 607
    { MP_ROM_QSTR(MP_QSTR_bool), MP_ROM_PTR(&mp_type_bool) },
    { MP_ROM_QSTR(MP_QSTR_bytes), MP_ROM_PTR(&mp_type_bytes) },
608
    #if MICROPY_PY_BUILTINS_BYTEARRAY
609
    { MP_ROM_QSTR(MP_QSTR_bytearray), MP_ROM_PTR(&mp_type_bytearray) },
610 611
    #endif
    #if MICROPY_PY_BUILTINS_COMPLEX
612
    { MP_ROM_QSTR(MP_QSTR_complex), MP_ROM_PTR(&mp_type_complex) },
613
    #endif
614
    { MP_ROM_QSTR(MP_QSTR_dict), MP_ROM_PTR(&mp_type_dict) },
615
    #if MICROPY_PY_BUILTINS_ENUMERATE
616
    { MP_ROM_QSTR(MP_QSTR_enumerate), MP_ROM_PTR(&mp_type_enumerate) },
617
    #endif
618
    #if MICROPY_PY_BUILTINS_FILTER
619
    { MP_ROM_QSTR(MP_QSTR_filter), MP_ROM_PTR(&mp_type_filter) },
620
    #endif
621
    #if MICROPY_PY_BUILTINS_FLOAT
622
    { MP_ROM_QSTR(MP_QSTR_float), MP_ROM_PTR(&mp_type_float) },
623 624
    #endif
    #if MICROPY_PY_BUILTINS_SET && MICROPY_PY_BUILTINS_FROZENSET
625
    { MP_ROM_QSTR(MP_QSTR_frozenset), MP_ROM_PTR(&mp_type_frozenset) },
626
    #endif
627 628 629
    { MP_ROM_QSTR(MP_QSTR_int), MP_ROM_PTR(&mp_type_int) },
    { MP_ROM_QSTR(MP_QSTR_list), MP_ROM_PTR(&mp_type_list) },
    { MP_ROM_QSTR(MP_QSTR_map), MP_ROM_PTR(&mp_type_map) },
630
    #if MICROPY_PY_BUILTINS_MEMORYVIEW
631
    { MP_ROM_QSTR(MP_QSTR_memoryview), MP_ROM_PTR(&mp_type_memoryview) },
632
    #endif
633
    { MP_ROM_QSTR(MP_QSTR_object), MP_ROM_PTR(&mp_type_object) },
634
    #if MICROPY_PY_BUILTINS_PROPERTY
635
    { MP_ROM_QSTR(MP_QSTR_property), MP_ROM_PTR(&mp_type_property) },
636
    #endif
637
    { MP_ROM_QSTR(MP_QSTR_range), MP_ROM_PTR(&mp_type_range) },
638
    #if MICROPY_PY_BUILTINS_REVERSED
639
    { MP_ROM_QSTR(MP_QSTR_reversed), MP_ROM_PTR(&mp_type_reversed) },
640
    #endif
641
    #if MICROPY_PY_BUILTINS_SET
642
    { MP_ROM_QSTR(MP_QSTR_set), MP_ROM_PTR(&mp_type_set) },
643
    #endif
644 645 646
    #if MICROPY_PY_BUILTINS_SLICE
    { MP_ROM_QSTR(MP_QSTR_slice), MP_ROM_PTR(&mp_type_slice) },
    #endif
647 648 649 650 651
    { MP_ROM_QSTR(MP_QSTR_str), MP_ROM_PTR(&mp_type_str) },
    { MP_ROM_QSTR(MP_QSTR_super), MP_ROM_PTR(&mp_type_super) },
    { MP_ROM_QSTR(MP_QSTR_tuple), MP_ROM_PTR(&mp_type_tuple) },
    { MP_ROM_QSTR(MP_QSTR_type), MP_ROM_PTR(&mp_type_type) },
    { MP_ROM_QSTR(MP_QSTR_zip), MP_ROM_PTR(&mp_type_zip) },
652

653 654
    { MP_ROM_QSTR(MP_QSTR_classmethod), MP_ROM_PTR(&mp_type_classmethod) },
    { MP_ROM_QSTR(MP_QSTR_staticmethod), MP_ROM_PTR(&mp_type_staticmethod) },
655 656

    // built-in objects
657
    { MP_ROM_QSTR(MP_QSTR_Ellipsis), MP_ROM_PTR(&mp_const_ellipsis_obj) },
658
    #if MICROPY_PY_BUILTINS_NOTIMPLEMENTED
659
    { MP_ROM_QSTR(MP_QSTR_NotImplemented), MP_ROM_PTR(&mp_const_notimplemented_obj) },
660
    #endif
661 662

    // built-in user functions
663 664 665 666 667
    { MP_ROM_QSTR(MP_QSTR_abs), MP_ROM_PTR(&mp_builtin_abs_obj) },
    { MP_ROM_QSTR(MP_QSTR_all), MP_ROM_PTR(&mp_builtin_all_obj) },
    { MP_ROM_QSTR(MP_QSTR_any), MP_ROM_PTR(&mp_builtin_any_obj) },
    { MP_ROM_QSTR(MP_QSTR_bin), MP_ROM_PTR(&mp_builtin_bin_obj) },
    { MP_ROM_QSTR(MP_QSTR_callable), MP_ROM_PTR(&mp_builtin_callable_obj) },
668
    #if MICROPY_PY_BUILTINS_COMPILE
669
    { MP_ROM_QSTR(MP_QSTR_compile), MP_ROM_PTR(&mp_builtin_compile_obj) },
670
    #endif
671
    { MP_ROM_QSTR(MP_QSTR_chr), MP_ROM_PTR(&mp_builtin_chr_obj) },
672 673 674
    #if MICROPY_CPYTHON_COMPAT
    { MP_ROM_QSTR(MP_QSTR_delattr), MP_ROM_PTR(&mp_builtin_delattr_obj) },
    #endif
675 676
    { MP_ROM_QSTR(MP_QSTR_dir), MP_ROM_PTR(&mp_builtin_dir_obj) },
    { MP_ROM_QSTR(MP_QSTR_divmod), MP_ROM_PTR(&mp_builtin_divmod_obj) },
677
    #if MICROPY_PY_BUILTINS_EVAL_EXEC
678 679
    { MP_ROM_QSTR(MP_QSTR_eval), MP_ROM_PTR(&mp_builtin_eval_obj) },
    { MP_ROM_QSTR(MP_QSTR_exec), MP_ROM_PTR(&mp_builtin_exec_obj) },
680
    #endif
681
    #if MICROPY_PY_BUILTINS_EXECFILE
682
    { MP_ROM_QSTR(MP_QSTR_execfile), MP_ROM_PTR(&mp_builtin_execfile_obj) },
683
    #endif
684 685 686 687 688
    { MP_ROM_QSTR(MP_QSTR_getattr), MP_ROM_PTR(&mp_builtin_getattr_obj) },
    { MP_ROM_QSTR(MP_QSTR_setattr), MP_ROM_PTR(&mp_builtin_setattr_obj) },
    { MP_ROM_QSTR(MP_QSTR_globals), MP_ROM_PTR(&mp_builtin_globals_obj) },
    { MP_ROM_QSTR(MP_QSTR_hasattr), MP_ROM_PTR(&mp_builtin_hasattr_obj) },
    { MP_ROM_QSTR(MP_QSTR_hash), MP_ROM_PTR(&mp_builtin_hash_obj) },
689 690 691
    #if MICROPY_PY_BUILTINS_HELP
    { MP_ROM_QSTR(MP_QSTR_help), MP_ROM_PTR(&mp_builtin_help_obj) },
    #endif
692 693
    { MP_ROM_QSTR(MP_QSTR_hex), MP_ROM_PTR(&mp_builtin_hex_obj) },
    { MP_ROM_QSTR(MP_QSTR_id), MP_ROM_PTR(&mp_builtin_id_obj) },
694 695 696
    #if MICROPY_PY_BUILTINS_INPUT
    { MP_ROM_QSTR(MP_QSTR_input), MP_ROM_PTR(&mp_builtin_input_obj) },
    #endif
697 698 699 700 701
    { MP_ROM_QSTR(MP_QSTR_isinstance), MP_ROM_PTR(&mp_builtin_isinstance_obj) },
    { MP_ROM_QSTR(MP_QSTR_issubclass), MP_ROM_PTR(&mp_builtin_issubclass_obj) },
    { MP_ROM_QSTR(MP_QSTR_iter), MP_ROM_PTR(&mp_builtin_iter_obj) },
    { MP_ROM_QSTR(MP_QSTR_len), MP_ROM_PTR(&mp_builtin_len_obj) },
    { MP_ROM_QSTR(MP_QSTR_locals), MP_ROM_PTR(&mp_builtin_locals_obj) },
702
    #if MICROPY_PY_BUILTINS_MIN_MAX
703 704
    { MP_ROM_QSTR(MP_QSTR_max), MP_ROM_PTR(&mp_builtin_max_obj) },
    { MP_ROM_QSTR(MP_QSTR_min), MP_ROM_PTR(&mp_builtin_min_obj) },
705
    #endif
706 707 708 709 710 711 712 713 714
    { MP_ROM_QSTR(MP_QSTR_next), MP_ROM_PTR(&mp_builtin_next_obj) },
    { MP_ROM_QSTR(MP_QSTR_oct), MP_ROM_PTR(&mp_builtin_oct_obj) },
    { MP_ROM_QSTR(MP_QSTR_ord), MP_ROM_PTR(&mp_builtin_ord_obj) },
    { MP_ROM_QSTR(MP_QSTR_pow), MP_ROM_PTR(&mp_builtin_pow_obj) },
    { MP_ROM_QSTR(MP_QSTR_print), MP_ROM_PTR(&mp_builtin_print_obj) },
    { MP_ROM_QSTR(MP_QSTR_repr), MP_ROM_PTR(&mp_builtin_repr_obj) },
    { MP_ROM_QSTR(MP_QSTR_round), MP_ROM_PTR(&mp_builtin_round_obj) },
    { MP_ROM_QSTR(MP_QSTR_sorted), MP_ROM_PTR(&mp_builtin_sorted_obj) },
    { MP_ROM_QSTR(MP_QSTR_sum), MP_ROM_PTR(&mp_builtin_sum_obj) },
715 716

    // built-in exceptions
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
    { MP_ROM_QSTR(MP_QSTR_BaseException), MP_ROM_PTR(&mp_type_BaseException) },
    { MP_ROM_QSTR(MP_QSTR_ArithmeticError), MP_ROM_PTR(&mp_type_ArithmeticError) },
    { MP_ROM_QSTR(MP_QSTR_AssertionError), MP_ROM_PTR(&mp_type_AssertionError) },
    { MP_ROM_QSTR(MP_QSTR_AttributeError), MP_ROM_PTR(&mp_type_AttributeError) },
    { MP_ROM_QSTR(MP_QSTR_EOFError), MP_ROM_PTR(&mp_type_EOFError) },
    { MP_ROM_QSTR(MP_QSTR_Exception), MP_ROM_PTR(&mp_type_Exception) },
    { MP_ROM_QSTR(MP_QSTR_GeneratorExit), MP_ROM_PTR(&mp_type_GeneratorExit) },
    { MP_ROM_QSTR(MP_QSTR_ImportError), MP_ROM_PTR(&mp_type_ImportError) },
    { MP_ROM_QSTR(MP_QSTR_IndentationError), MP_ROM_PTR(&mp_type_IndentationError) },
    { MP_ROM_QSTR(MP_QSTR_IndexError), MP_ROM_PTR(&mp_type_IndexError) },
    { MP_ROM_QSTR(MP_QSTR_KeyboardInterrupt), MP_ROM_PTR(&mp_type_KeyboardInterrupt) },
    { MP_ROM_QSTR(MP_QSTR_KeyError), MP_ROM_PTR(&mp_type_KeyError) },
    { MP_ROM_QSTR(MP_QSTR_LookupError), MP_ROM_PTR(&mp_type_LookupError) },
    { MP_ROM_QSTR(MP_QSTR_MemoryError), MP_ROM_PTR(&mp_type_MemoryError) },
    { MP_ROM_QSTR(MP_QSTR_NameError), MP_ROM_PTR(&mp_type_NameError) },
    { MP_ROM_QSTR(MP_QSTR_NotImplementedError), MP_ROM_PTR(&mp_type_NotImplementedError) },
    { MP_ROM_QSTR(MP_QSTR_OSError), MP_ROM_PTR(&mp_type_OSError) },
    { MP_ROM_QSTR(MP_QSTR_OverflowError), MP_ROM_PTR(&mp_type_OverflowError) },
    { MP_ROM_QSTR(MP_QSTR_RuntimeError), MP_ROM_PTR(&mp_type_RuntimeError) },
736 737 738
    #if MICROPY_PY_ASYNC_AWAIT
    { MP_ROM_QSTR(MP_QSTR_StopAsyncIteration), MP_ROM_PTR(&mp_type_StopAsyncIteration) },
    #endif
739 740 741 742
    { MP_ROM_QSTR(MP_QSTR_StopIteration), MP_ROM_PTR(&mp_type_StopIteration) },
    { MP_ROM_QSTR(MP_QSTR_SyntaxError), MP_ROM_PTR(&mp_type_SyntaxError) },
    { MP_ROM_QSTR(MP_QSTR_SystemExit), MP_ROM_PTR(&mp_type_SystemExit) },
    { MP_ROM_QSTR(MP_QSTR_TypeError), MP_ROM_PTR(&mp_type_TypeError) },
Paul Sokolovsky's avatar
Paul Sokolovsky committed
743
    #if MICROPY_PY_BUILTINS_STR_UNICODE
744
    { MP_ROM_QSTR(MP_QSTR_UnicodeError), MP_ROM_PTR(&mp_type_UnicodeError) },
Paul Sokolovsky's avatar
Paul Sokolovsky committed
745
    #endif
746
    { MP_ROM_QSTR(MP_QSTR_ValueError), MP_ROM_PTR(&mp_type_ValueError) },
747
    #if MICROPY_EMIT_NATIVE
748
    { MP_ROM_QSTR(MP_QSTR_ViperTypeError), MP_ROM_PTR(&mp_type_ViperTypeError) },
749
    #endif
750
    { MP_ROM_QSTR(MP_QSTR_ZeroDivisionError), MP_ROM_PTR(&mp_type_ZeroDivisionError) },
751 752 753 754 755 756 757 758 759 760 761 762 763
    // Somehow CPython managed to have OverflowError not inherit from ValueError ;-/
    // TODO: For MICROPY_CPYTHON_COMPAT==0 use ValueError to avoid exc proliferation

    // Extra builtins as defined by a port
    MICROPY_PORT_BUILTINS
};

MP_DEFINE_CONST_DICT(mp_module_builtins_globals, mp_module_builtins_globals_table);

const mp_obj_module_t mp_module_builtins = {
    .base = { &mp_type_module },
    .globals = (mp_obj_dict_t*)&mp_module_builtins_globals,
};