py/builtinimport: Allow overriding of mp_builtin___import__.

laurensvalk · laurensvalk · commit 167f980bed91 · 2022-08-11T20:04:57.000+02:00
This allows ports to override mp_builtin___import__.

This is particularly useful in MicroPython applications where
MICROPY_ENABLE_EXTERNAL_IMPORT has to be disabled due to its impact on
build size (2% to 2.5% of the minimal port). By overriding the otherwise
very minimal mp_builtin___import__, ports can still allow limited forms
of application-specific imports.

Signed-off-by: Laurens Valk &lt;laurens@pybricks.com&gt;
diff --git a/py/builtin.h b/py/builtin.h
@@ -64,7 +64,17 @@ MP_DECLARE_CONST_FUN_OBJ_KW(mp_builtin_open_obj);
 
 #endif
 
+// A port can provide its own import handler to expand or fully replace
+// the mp_builtin___import___default function.
+mp_obj_t mp_builtin___import___default(size_t n_args, const mp_obj_t *args);
+#if MICROPY_MODULE_OVERRIDE_BUILTIN_IMPORT
 mp_obj_t mp_builtin___import__(size_t n_args, const mp_obj_t *args);
+#else
+static inline mp_obj_t mp_builtin___import__(size_t n_args, const mp_obj_t *args) {
+    return mp_builtin___import___default(n_args, args);
+}
+#endif
+
 mp_obj_t mp_micropython_mem_info(size_t n_args, const mp_obj_t *args);
 
 MP_DECLARE_CONST_FUN_OBJ_VAR(mp_builtin___build_class___obj);
diff --git a/py/builtinimport.c b/py/builtinimport.c
@@ -467,7 +467,7 @@ STATIC mp_obj_t process_import_at_level(qstr full_mod_name, qstr level_mod_name,
     return module_obj;
 }
 
-mp_obj_t mp_builtin___import__(size_t n_args, const mp_obj_t *args) {
+mp_obj_t mp_builtin___import___default(size_t n_args, const mp_obj_t *args) {
     #if DEBUG_PRINT
     DEBUG_printf("__import__:\n");
     for (size_t i = 0; i < n_args; i++) {
@@ -566,7 +566,7 @@ mp_obj_t mp_builtin___import__(size_t n_args, const mp_obj_t *args) {
 
 #else // MICROPY_ENABLE_EXTERNAL_IMPORT
 
-mp_obj_t mp_builtin___import__(size_t n_args, const mp_obj_t *args) {
+mp_obj_t mp_builtin___import___default(size_t n_args, const mp_obj_t *args) {
     // Check that it's not a relative import
     if (n_args >= 5 && MP_OBJ_SMALL_INT_VALUE(args[4]) != 0) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("relative import"));
diff --git a/py/mpconfig.h b/py/mpconfig.h
@@ -860,6 +860,13 @@ typedef double mp_float_t;
 #define MICROPY_MODULE_OVERRIDE_MAIN_IMPORT (0)
 #endif
 
+// Whether to allow the port to provide its own mp_builtin___import__
+// implementation. If enabled, the provided implementation can still call
+// mp_builtin___import___default to replicate and extend the default behavior.
+#ifndef MICROPY_MODULE_OVERRIDE_BUILTIN_IMPORT
+#define MICROPY_MODULE_OVERRIDE_BUILTIN_IMPORT (0)
+#endif
+
 // Whether frozen modules are supported in the form of strings
 #ifndef MICROPY_MODULE_FROZEN_STR
 #define MICROPY_MODULE_FROZEN_STR (0)
