micropython: update to v1.25

Update to current MicroPython stable release v1.25.

Includes changes required to compile without errors:

- Handling of PYEXEC_FORCED_EXIT/SystemExit changed
- mp_make_function_from_raw_code() replaced by mp_make_function_from_proto_fun()
- Module import code changed
- mp_lexer_new_from_file() function signature changed
- mp_hal_stdout_tx_strn() function signature changed
- MP_REGISTER_MODULE_DELEGATION() replaces MP_MODULE_ATTR_DELEGATION_ENTRY()
- mp_obj_malloc_var() signature changed
- mp_generic_unary_op was removed
- m_new_obj_var_with_finaliser() replaced by mp_obj_malloc_var_with_finaliser()

Author: dlech

bricks/_common/micropython.c

@@ -55,8 +55,6 @@ void pbsys_main_stop_program(bool force_stop) {
     if (force_stop) {
         mp_sched_vm_abort();
     } else {
-        pyexec_system_exit = PYEXEC_FORCED_EXIT;
-
         static mp_obj_exception_t system_exit;
         system_exit.base.type = &mp_type_SystemExit;
         system_exit.traceback_alloc = system_exit.traceback_len = 0;
@@ -106,9 +104,9 @@ static void mp_vfs_map_minimal_new_reader(mp_reader_t *reader, mp_vfs_map_minima
 }
 
 // Prints the exception that ended the program.
-static void print_final_exception(mp_obj_t exc) {
+static void print_final_exception(mp_obj_t exc, int ret) {
     // Handle graceful stop with button.
-    if (pyexec_system_exit == PYEXEC_FORCED_EXIT &&
+    if ((ret & PYEXEC_FORCED_EXIT) &&
         mp_obj_exception_match(exc, MP_OBJ_FROM_PTR(&mp_type_SystemExit))) {
         mp_printf(&mp_plat_print, "The program was stopped (%q).\n",
             ((mp_obj_exception_t *)MP_OBJ_TO_PTR(exc))->base.type->name);
@@ -121,8 +119,9 @@ static void print_final_exception(mp_obj_t exc) {
 
 #if PBSYS_CONFIG_FEATURE_BUILTIN_USER_PROGRAM_REPL
 static void run_repl(void) {
+    int ret;
+
     readline_init0();
-    pyexec_system_exit = 0;
 
     nlr_buf_t nlr;
     nlr.ret_val = NULL;
@@ -134,12 +133,12 @@ static void run_repl(void) {
         if (pyexec_mode_kind == PYEXEC_MODE_RAW_REPL) {
             // Compatibility with mpremote.
             mp_printf(&mp_plat_print, "MPY: soft reboot\n");
-            pyexec_raw_repl();
+            ret = pyexec_raw_repl();
         } else {
-            pyexec_friendly_repl();
+            ret = pyexec_friendly_repl();
         }
         #else // PYBRICKS_OPT_RAW_REPL
-        pyexec_friendly_repl();
+        ret = pyexec_friendly_repl();
         #endif // PYBRICKS_OPT_RAW_REPL
         nlr_pop();
     } else {
@@ -152,7 +151,7 @@ static void run_repl(void) {
         // clear any pending exceptions (and run any callbacks).
         mp_handle_pending(false);
         // Print which exception triggered this.
-        print_final_exception(MP_OBJ_FROM_PTR(nlr.ret_val));
+        print_final_exception(MP_OBJ_FROM_PTR(nlr.ret_val), ret);
     }
 
     nlr_set_abort(NULL);
@@ -175,7 +174,7 @@ static void do_execute_raw_code(mp_module_context_t *context, const mp_raw_code_
 
     nlr_buf_t nlr;
     if (nlr_push(&nlr) == 0) {
-        mp_obj_t module_fun = mp_make_function_from_raw_code(rc, mc, NULL);
+        mp_obj_t module_fun = mp_make_function_from_proto_fun(rc, mc, NULL);
         mp_call_function_0(module_fun);
 
         // finish nlr block, restore context
@@ -241,7 +240,7 @@ static mpy_info_t *mpy_data_find(qstr name) {
  * Runs the __main__ module from user RAM.
  */
 static void run_user_program(void) {
-    pyexec_system_exit = 0;
+    int ret = 0;
 
     nlr_buf_t nlr;
     nlr.ret_val = NULL;
@@ -264,7 +263,7 @@ static void run_user_program(void) {
         mp_compiled_module_t compiled_module;
         compiled_module.context = context;
         mp_raw_code_load(&reader, &compiled_module);
-        mp_obj_t module_fun = mp_make_function_from_raw_code(compiled_module.rc, context, NULL);
+        mp_obj_t module_fun = mp_make_function_from_proto_fun(compiled_module.rc, context, NULL);
 
         // Run the script while letting CTRL-C interrupt it.
         mp_hal_set_interrupt_char(CHAR_CTRL_C);
@@ -287,7 +286,12 @@ static void run_user_program(void) {
         // Clear any pending exceptions (and run any callbacks).
         mp_handle_pending(false);
 
-        print_final_exception(MP_OBJ_FROM_PTR(nlr.ret_val));
+        if (mp_obj_is_subclass_fast(MP_OBJ_FROM_PTR(((mp_obj_base_t *)nlr.ret_val)->type), MP_OBJ_FROM_PTR(&mp_type_SystemExit))) {
+            // at the moment, the value of SystemExit is unused
+            ret = PYEXEC_FORCED_EXIT;
+        }
+
+        print_final_exception(MP_OBJ_FROM_PTR(nlr.ret_val), ret);
 
         #if PBSYS_CONFIG_FEATURE_BUILTIN_USER_PROGRAM_REPL
         // On KeyboardInterrupt, drop to REPL for debugging.
@@ -422,6 +426,53 @@ mp_obj_t mp_builtin_open(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs)
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_open_obj, 1, mp_builtin_open);
 
+// REVISIT: These functions were removed from upstream MicroPython. We should
+// see if there is a better way to do this now.
+
+static void mp_module_register(mp_obj_t module_name, mp_obj_t module) {
+    mp_map_t *mp_loaded_modules_map = &MP_STATE_VM(mp_loaded_modules_dict).map;
+    mp_map_lookup(mp_loaded_modules_map, module_name, MP_MAP_LOOKUP_ADD_IF_NOT_FOUND)->value = module;
+}
+
+static void mp_module_call_init(mp_obj_t module_name, mp_obj_t module_obj) {
+    // Look for __init__ and call it if it exists
+    mp_obj_t dest[2];
+    mp_load_method_maybe(module_obj, MP_QSTR___init__, dest);
+    if (dest[0] != MP_OBJ_NULL) {
+        mp_call_method_n_kw(0, 0, dest);
+        // Register module so __init__ is not called again.
+        // If a module can be referenced by more than one name (eg due to weak links)
+        // then __init__ will still be called for each distinct import, and it's then
+        // up to the particular module to make sure it's __init__ code only runs once.
+        mp_module_register(module_name, module_obj);
+    }
+}
+
+// Tries to find a loaded module, otherwise attempts to load a builtin, otherwise MP_OBJ_NULL.
+static mp_obj_t mp_module_get_loaded_or_builtin(qstr module_name) {
+    // First try loaded modules.
+    mp_map_elem_t *elem = mp_map_lookup(&MP_STATE_VM(mp_loaded_modules_dict).map, MP_OBJ_NEW_QSTR(module_name), MP_MAP_LOOKUP);
+
+    if (!elem) {
+        #if MICROPY_MODULE_WEAK_LINKS
+        return mp_module_get_builtin(module_name);
+        #else
+        // Otherwise try builtin.
+        elem = mp_map_lookup((mp_map_t *)&mp_builtin_module_map, MP_OBJ_NEW_QSTR(module_name), MP_MAP_LOOKUP);
+        if (!elem) {
+            return MP_OBJ_NULL;
+        }
+
+        #if MICROPY_MODULE_BUILTIN_INIT
+        // If found, it's a newly loaded built-in, so init it.
+        mp_module_call_init(MP_OBJ_NEW_QSTR(module_name), elem->value);
+        #endif
+        #endif
+    }
+
+    return elem->value;
+}
+
 // Overrides MicroPython's mp_builtin___import__
 // IMPORTANT: this needs to be kept in sync with mp_builtin___import___default().
 mp_obj_t pb_builtin_import(size_t n_args, const mp_obj_t *args) {
@@ -473,7 +524,7 @@ mp_obj_t pb_builtin_import(size_t n_args, const mp_obj_t *args) {
         mp_module_context_t *context = MP_OBJ_TO_PTR(module_obj);
         const mp_frozen_module_t *frozen = modref;
         context->constants = frozen->constants;
-        do_execute_raw_code(context, frozen->rc, context);
+        do_execute_raw_code(context, frozen->proto_fun, context);
         return module_obj;
     }
     #endif
@@ -486,7 +537,7 @@ mp_import_stat_t mp_import_stat(const char *path) {
     return MP_IMPORT_STAT_NO_EXIST;
 }
 
-mp_lexer_t *mp_lexer_new_from_file(const char *filename) {
+mp_lexer_t *mp_lexer_new_from_file(qstr filename) {
     mp_raise_OSError(MP_ENOENT);
 }
 

bricks/_common_stm32/mphalport.c

@@ -64,11 +64,13 @@ int mp_hal_stdin_rx_chr(void) {
 }
 
 // Send string of given length
-void mp_hal_stdout_tx_strn(const char *str, mp_uint_t len) {
+mp_uint_t mp_hal_stdout_tx_strn(const char *str, size_t len) {
     while (pbsys_host_tx((const uint8_t *)str, len) == PBIO_ERROR_AGAIN) {
         MICROPY_EVENT_POLL_HOOK
     }
     // Not raising the error. This means stdout lost if host is not connected.
+
+    return len;
 }
 
 void mp_hal_stdout_tx_flush(void) {

bricks/ev3/mphalport.c

@@ -57,7 +57,7 @@ int mp_hal_stdin_rx_chr(void) {
 
 extern uint32_t pbdrv_usb_write(const uint8_t *data, uint32_t size);
 
-void mp_hal_stdout_tx_strn(const char *str, mp_uint_t len) {
+mp_uint_t mp_hal_stdout_tx_strn(const char *str, size_t len) {
     pbdrv_uart_debug_printf("%.*s", len, str);
 
     uint32_t done = 0;
@@ -69,6 +69,8 @@ void mp_hal_stdout_tx_strn(const char *str, mp_uint_t len) {
     while (!pbdrv_uart_debug_is_done()) {
         MICROPY_VM_HOOK_LOOP;
     }
+
+    return len;
 }
 
 extern void pbdrv_usb_tx_flush(void);

bricks/nxt/mphalport.c

@@ -74,17 +74,19 @@ int mp_hal_stdin_rx_chr(void) {
 }
 
 // Send string of given length
-void mp_hal_stdout_tx_strn(const char *str, mp_uint_t len) {
+mp_uint_t mp_hal_stdout_tx_strn(const char *str, size_t len) {
 
     // Nothing to do if disconnected or empty data
     if (!nx_bt_stream_opened() || len == 0) {
-        return;
+        return len;
     }
 
     nx_bt_stream_write((uint8_t *)str, len);
     while (!nx_bt_stream_data_written()) {
         MICROPY_EVENT_POLL_HOOK;
     }
+
+    return len;
 }
 
 void mp_hal_stdout_tx_flush(void) {

micropython

@@ -566,7 +566,7 @@ mp_obj_t pb_type_BLE_new(mp_obj_t broadcast_channel_in, mp_obj_t observe_channel
     }
     #endif // PBSYS_CONFIG_BLUETOOTH_TOGGLE
 
-    pb_obj_BLE_t *self = mp_obj_malloc_var(pb_obj_BLE_t, observed_data_t, num_observe_channels, &pb_type_BLE);
+    pb_obj_BLE_t *self = mp_obj_malloc_var(pb_obj_BLE_t, observed_data, observed_data_t, num_observe_channels, &pb_type_BLE);
     self->broadcast_channel = broadcast_channel_in;
 
     for (mp_int_t i = 0; i < num_observe_channels; i++) {

pybricks/common/pb_type_ble.c

@@ -117,9 +117,7 @@ mp_obj_t pb_type_device_method_call(mp_obj_t self_in, size_t n_args, size_t n_kw
  */
 MP_DEFINE_CONST_OBJ_TYPE(
     pb_type_device_method, MP_QSTR_function, MP_TYPE_FLAG_BINDS_SELF | MP_TYPE_FLAG_BUILTIN_FUN,
-    call, pb_type_device_method_call,
-    unary_op, mp_generic_unary_op
-    );
+    call, pb_type_device_method_call);
 
 /**
  * Set data for a Powered Up device, such as the brightness of multiple external

pybricks/common/pb_type_device.c

@@ -104,7 +104,6 @@ MP_DEFINE_CONST_OBJ_TYPE(pb_type_button_,
     MP_TYPE_FLAG_NONE,
     print, pb_type_button_print,
     attr, pb_type_button_attribute_handler,
-    unary_op, mp_generic_unary_op,
     binary_op, pb_type_button_binary_op
     );
 

pybricks/parameters/pb_type_button.c

@@ -354,7 +354,6 @@ MP_DEFINE_CONST_OBJ_TYPE(pb_type_Color,
     call, pb_type_Color_call,
     attr, pb_type_Color_attr,
     print, pb_type_Color_print,
-    unary_op, mp_generic_unary_op,
     binary_op, pb_type_Color_binary_op,
     subscr, pb_type_Color_subscr,
     iter, pb_type_Color_getiter);

pybricks/parameters/pb_type_color.c

@@ -33,7 +33,6 @@ MP_DEFINE_CONST_OBJ_TYPE(pb_enum_type_Direction,
     MP_QSTR_Direction,
     MP_TYPE_FLAG_NONE,
     print, pb_type_enum_print,
-    unary_op, mp_generic_unary_op,
     locals_dict, &(pb_enum_type_Direction_locals_dict));
 
 #endif // PYBRICKS_PY_PARAMETERS