Merge pull request adafruit#6117 from dhalbert/__future__

dhalbert · web-flow · commit 05a4d24a0f51 · 2022-03-08T09:33:36.000-05:00
implement `from __future__ import annotations`
diff --git a/ports/atmel-samd/boards/matrixportal_m4/mpconfigboard.mk b/ports/atmel-samd/boards/matrixportal_m4/mpconfigboard.mk
@@ -13,6 +13,7 @@ LONGINT_IMPL = MPZ
 CIRCUITPY_BLEIO = 0
 CIRCUITPY_BLEIO_HCI = 0
 CIRCUITPY_ONEWIREIO = 0
+CIRCUITPY_PARALLELDISPLAY = 0
 CIRCUITPY_SDCARDIO = 0
 CIRCUITPY_SHARPDISPLAY = 0
 
diff --git a/py/circuitpy_defns.mk b/py/circuitpy_defns.mk
@@ -174,6 +174,10 @@ ifeq ($(CIRCUITPY_FREQUENCYIO),1)
 SRC_PATTERNS += frequencyio/%
 endif
 
+ifeq ($(CIRCUITPY_FUTURE),1)
+SRC_PATTERNS += __future__/%
+endif
+
 ifeq ($(CIRCUITPY_GAMEPADSHIFT),1)
 SRC_PATTERNS += gamepadshift/%
 endif
@@ -451,6 +455,7 @@ $(filter $(SRC_PATTERNS), \
 	_bleio/Attribute.c \
 	_bleio/ScanEntry.c \
 	_eve/__init__.c \
+	__future__/__init__.c \
 	camera/ImageFormat.c \
 	canio/Match.c \
 	countio/Edge.c \
diff --git a/py/circuitpy_mpconfig.mk b/py/circuitpy_mpconfig.mk
@@ -217,6 +217,9 @@ CFLAGS += -DCIRCUITPY__EVE=$(CIRCUITPY__EVE)
 CIRCUITPY_FREQUENCYIO ?= $(CIRCUITPY_FULL_BUILD)
 CFLAGS += -DCIRCUITPY_FREQUENCYIO=$(CIRCUITPY_FREQUENCYIO)
 
+CIRCUITPY_FUTURE ?= 1
+CFLAGS += -DCIRCUITPY_FUTURE=$(CIRCUITPY_FUTURE)
+
 CIRCUITPY_GAMEPADSHIFT ?= 0
 CFLAGS += -DCIRCUITPY_GAMEPADSHIFT=$(CIRCUITPY_GAMEPADSHIFT)
 
diff --git a/shared-bindings/__future__/__init__.c b/shared-bindings/__future__/__init__.c
@@ -0,0 +1,60 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries
+ *
+ * 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.
+ */
+
+#include "extmod/vfs.h"
+#include "py/mpstate.h"
+#include "py/obj.h"
+#include "py/objstr.h"
+#include "py/runtime.h"
+#include "shared-bindings/__future__/__init__.h"
+
+//| """Language features module
+//|
+//| The `__future__` module is used by other Python implementations to
+//| enable forward compatibility for features enabled by default in an upcoming version.
+//| """
+//|
+//| annotations: Any
+//| """In CPython, ``from __future import annotations``
+//| indicates that evaluation of annotations is postponed, as described in PEP 563.
+//| CircuitPython (and MicroPython) ignore annotations entirely, whether or not this feature is imported.
+//| This is a limitation of CircuitPython and MicroPython for efficiency reasons.
+//| """
+
+STATIC const mp_rom_map_elem_t future_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR___future__) },
+
+    { MP_ROM_QSTR(MP_QSTR_annotations), mp_const_true },
+};
+
+STATIC MP_DEFINE_CONST_DICT(future_module_globals, future_module_globals_table);
+
+const mp_obj_module_t future_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&future_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR___future__, future_module, CIRCUITPY_FUTURE);
diff --git a/shared-bindings/__future__/__init__.h b/shared-bindings/__future__/__init__.h
@@ -0,0 +1,30 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022 Dan Halbert for Adafruit Industries
+ *
+ * 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.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS___FUTURE_____INIT___H
+#define MICROPY_INCLUDED_SHARED_BINDINGS___FUTURE_____INIT___H
+
+#endif  // MICROPY_INCLUDED_SHARED_BINDINGS___FUTURE_____INIT___H
diff --git a/tools/extract_pyi.py b/tools/extract_pyi.py
@@ -21,7 +21,9 @@
 import circuitpython_typing.socket
 
 
-IMPORTS_IGNORE = frozenset(
+PATHS_IGNORE = frozenset({"shared-bindings/__future__"})
+
+TYPE_MODULE_IMPORTS_IGNORE = frozenset(
     {
         "array",
         "bool",
@@ -115,7 +117,7 @@ def collect_annotations(anno_tree):
             return
         for node in ast.walk(anno_tree):
             if isinstance(node, ast.Name):
-                if node.id in IMPORTS_IGNORE:
+                if node.id in TYPE_MODULE_IMPORTS_IGNORE:
                     continue
                 for module, imports in AVAILABLE_TYPE_MODULE_IMPORTS.items():
                     if node.id in imports:
@@ -158,6 +160,9 @@ def convert_folder(top_level, stub_directory):
 
     for filename in filenames:
         full_path = os.path.join(top_level, filename)
+        if full_path in PATHS_IGNORE:
+            continue
+
         file_lines = []
         if os.path.isdir(full_path):
             (mok, mtotal) = convert_folder(full_path, os.path.join(stub_directory, filename))
