Withdraw the _environ module

This existed solely for testing, so expose it a different way during
the unix coverage build

Also turn off os.getenv support on samd21.

Author: jepler

devices/ble_hci/common-hal/_bleio/Adapter.c

@@ -49,8 +49,8 @@
 #include "shared-bindings/_bleio/ScanEntry.h"
 #include "shared-bindings/time/__init__.h"
 
-#if CIRCUITPY_ENVIRON
-#include "shared-bindings/_environ/__init__.h"
+#if CIRCUITPY_OS_GETENV
+#include "shared-bindings/os/__init__.h"
 #endif
 
 #define MSEC_TO_UNITS(TIME, RESOLUTION) (((TIME) * 1000) / (RESOLUTION))
@@ -284,8 +284,8 @@ char default_ble_name[] = { 'C', 'I', 'R', 'C', 'U', 'I', 'T', 'P', 'Y', 0, 0, 0
 STATIC void bleio_adapter_hci_init(bleio_adapter_obj_t *self) {
     mp_int_t name_len = 0;
 
-    #if CIRCUITPY_ENVIRON
-    mp_obj_t name = common_hal__environ_get_key("CIRCUITPY_BLE_NAME");
+    #if CIRCUITPY_OS_GETENV
+    mp_obj_t name = common_hal_os_getenv("CIRCUITPY_BLE_NAME", mp_const_none);
     if (name != mp_const_none) {
         mp_arg_validate_type_string(name, MP_QSTR_CIRCUITPY_BLE_NAME);
         self->name = name;

docs/environment.rst

@@ -6,23 +6,33 @@ variables are commonly used to store "secrets" such as Wi-Fi passwords and API
 keys. This method *does not* make them secure. It only separates them from the
 code.
 
-CircuitPython supports these by parsing a subset of the `toml <https://toml.io/>`_ file format internally.
+CircuitPython uses a file called ``settings.toml`` at the drive root (no
+folder) as the environment.  User code can access the values from the file
+using `os.getenv()`. It is recommended to save any values used repeatedly in a
+variable because `os.getenv()` will parse the ``settings.toml`` file contents
+on every access.
 
-Here is a simple example:
+CircuitPython only supports a subset of the full toml specification, see below
+for more details. The subset is very "Python-like", which is a key reason we
+selected the format.
 
-.. code-block:: bash
+Due to technical limitations it probably also accepts some files that are
+not valid TOML files; bugs of this nature are subject to change (i.e., be
+fixed) without the usual deprecation period for incompatible changes.
 
-  KEY1="value1"
-  # Comment
-  KEY2="value2\ncontains a newline"
+File format example:
 
-  [SECTION] # Only values in the "root table" are parsed
-  SECTION_VALUE = ... # so this value cannot be seen by getenv
+.. code-block::
+
+   str_key="Hello world" # with trailing comment
+   int_key = 7
+   unicode_key="👨"
+   unicode_key2="\\U0001f468" # same as above
+   escape_codes="supported, including \\r\\n\\"\\\\"
+   # comment
+   [subtable]
+   subvalue="cannot retrieve this using _environ or getenv"
 
-CircuitPython uses the ``settings.toml`` at the drive root (no folder) as the environment.
-User code can access the values from the file using `os.getenv()`. It is
-recommended to save any values used repeatedly in a variable because `os.getenv()`
-will parse the ``settings.toml`` file contents on every access.
 
 Details of the toml language subset
 -----------------------------------
@@ -36,6 +46,8 @@ Details of the toml language subset
 * Duplicate keys are not diagnosed.
 * Comments are supported
 * Only values from the "root table" can be retrieved
+* due to technical limitations, the content of multi-line
+  strings can erroneously be parsed as a value.
 
 CircuitPython behavior
 ----------------------

ports/atmel-samd/mpconfigport.mk

@@ -33,6 +33,7 @@ CIRCUITPY_BLEIO_HCI = 0
 CIRCUITPY_BUILTINS_POW3 ?= 0
 CIRCUITPY_COMPUTED_GOTO_SAVE_SPACE ?= 1
 CIRCUITPY_COUNTIO ?= 0
+CIRCUITPY_OS_GETENV ?= 0
 # Not enough RAM for framebuffers
 CIRCUITPY_FRAMEBUFFERIO ?= 0
 CIRCUITPY_FREQUENCYIO ?= 0

ports/espressif/common-hal/_bleio/Adapter.c

@@ -59,8 +59,8 @@
 #include "esp_bt.h"
 #include "esp_nimble_hci.h"
 
-#if CIRCUITPY_ENVIRON
-#include "shared-module/_environ/__init__.h"
+#if CIRCUITPY_OS_GETENV
+#include "shared-module/os/__init__.h"
 #endif
 
 bleio_connection_internal_t bleio_connections[BLEIO_TOTAL_CONNECTION_COUNT];
@@ -101,9 +101,9 @@ void common_hal_bleio_adapter_set_enabled(bleio_adapter_obj_t *self, bool enable
         ble_hs_cfg.sync_cb = _on_sync;
         // ble_hs_cfg.store_status_cb = ble_store_util_status_rr;
 
-        #if CIRCUITPY_ENVIRON
+        #if CIRCUITPY_OS_GETENV
         char ble_name[1 + MYNEWT_VAL_BLE_SVC_GAP_DEVICE_NAME_MAX_LENGTH];
-        _environ_err_t result = _environ_get_key_str("CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name));
+        os_environ_err_t result = common_hal_os_environ_get_key_str("CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name));
         if (result == ENVIRON_OK) {
             ble_svc_gap_device_name_set(ble_name);
         } else

ports/espressif/supervisor/port.c

@@ -55,7 +55,7 @@
 #include "shared-bindings/microcontroller/RunMode.h"
 #include "shared-bindings/rtc/__init__.h"
 #include "shared-bindings/socketpool/__init__.h"
-#include "shared-module/_environ/__init__.h"
+#include "shared-module/os/__init__.h"
 
 #include "peripherals/rmt.h"
 #include "peripherals/timer.h"
@@ -519,7 +519,7 @@ void port_idle_until_interrupt(void) {
 void port_post_boot_py(bool heap_valid) {
     if (!heap_valid && filesystem_present()) {
         mp_int_t reserved;
-        if (_environ_get_key_int("CIRCUITPY_RESERVED_PSRAM", &reserved) == ENVIRON_OK) {
+        if (common_hal_os_environ_get_key_int("CIRCUITPY_RESERVED_PSRAM", &reserved) == ENVIRON_OK) {
             common_hal_espidf_set_reserved_psram(reserved);
         }
         common_hal_espidf_reserve_psram();

ports/nrf/common-hal/_bleio/Adapter.c

@@ -52,8 +52,8 @@
 #include "shared-bindings/_bleio/ScanEntry.h"
 #include "shared-bindings/time/__init__.h"
 
-#if CIRCUITPY_ENVIRON
-#include "shared-bindings/_environ/__init__.h"
+#if CIRCUITPY_OS_GETENV
+#include "shared-bindings/os/getenv.h"
 #endif
 
 #define BLE_MIN_CONN_INTERVAL        MSEC_TO_UNITS(15, UNIT_0_625_MS)
@@ -345,8 +345,8 @@ STATIC void bleio_adapter_reset_name(bleio_adapter_obj_t *self) {
 
     mp_int_t name_len = 0;
 
-    #if CIRCUITPY_ENVIRON
-    mp_obj_t ble_name = common_hal__environ_get_key("CIRCUITPY_BLE_NAME");
+    #if CIRCUITPY_OS_GETENV
+    mp_obj_t ble_name = common_hal_os_environ_get_key("CIRCUITPY_BLE_NAME");
     if (ble_name != mp_const_none) {
         common_hal_bleio_adapter_set_name(self, mp_obj_str_get_str(ble_name));
         return;

ports/unix/coverage.c

@@ -95,6 +95,7 @@ STATIC const mp_rom_map_elem_t rawfile_locals_dict_table[] = {
     { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
     { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
     { MP_ROM_QSTR(MP_QSTR_ioctl), MP_ROM_PTR(&mp_stream_ioctl_obj) },
+    { MP_ROM_QSTR(MP_QSTR_ioctl), MP_ROM_PTR(&mp_stream_ioctl_obj) },
 };
 
 STATIC MP_DEFINE_CONST_DICT(rawfile_locals_dict, rawfile_locals_dict_table);

ports/unix/main.c

@@ -420,6 +420,13 @@ STATIC void set_sys_argv(char *argv[], int argc, int start_arg) {
 #define PATHLIST_SEP_CHAR ':'
 #endif
 
+mp_obj_t common_hal_os_getenv_path(const char *path, const char *key, mp_obj_t default_);
+STATIC mp_obj_t get_key(mp_obj_t path_in, mp_obj_t key_to_get_in) {
+    return common_hal_os_getenv_path(mp_obj_str_get_str(path_in),
+        mp_obj_str_get_str(key_to_get_in), mp_const_none);
+}
+MP_DEFINE_CONST_FUN_OBJ_2(get_key_obj, get_key);
+
 MP_NOINLINE int main_(int argc, char **argv);
 
 int main(int argc, char **argv) {
@@ -540,6 +547,7 @@ MP_NOINLINE int main_(int argc, char **argv) {
         MP_DECLARE_CONST_FUN_OBJ_0(extra_cpp_coverage_obj);
         mp_store_global(MP_QSTR_extra_coverage, MP_OBJ_FROM_PTR(&extra_coverage_obj));
         mp_store_global(MP_QSTR_extra_cpp_coverage, MP_OBJ_FROM_PTR(&extra_cpp_coverage_obj));
+        mp_store_global(MP_QSTR_get_key, MP_OBJ_FROM_PTR(&get_key_obj));
     }
     #endif
 

ports/unix/variants/coverage/mpconfigvariant.mk

@@ -33,7 +33,6 @@ SRC_BITMAP := \
 	shared-bindings/aesio/__init__.c \
 	shared-bindings/bitmaptools/__init__.c \
 	shared-bindings/displayio/Bitmap.c \
-	shared-bindings/_environ/__init__.c \
 	shared-bindings/rainbowio/__init__.c \
 	shared-bindings/traceback/__init__.c \
 	shared-bindings/util.c \
@@ -45,7 +44,7 @@ SRC_BITMAP := \
 	shared-module/displayio/Bitmap.c \
 	shared-module/displayio/ColorConverter.c \
 	shared-module/displayio/ColorConverter.c \
-	shared-module/_environ/__init__.c \
+	shared-module/os/getenv.c \
 	shared-module/rainbowio/__init__.c \
 	shared-module/traceback/__init__.c \
 	shared-module/zlib/__init__.c \
@@ -56,7 +55,7 @@ CFLAGS += \
 	-DCIRCUITPY_AESIO=1 \
 	-DCIRCUITPY_BITMAPTOOLS=1 \
 	-DCIRCUITPY_DISPLAYIO_UNIX=1 \
-	-DCIRCUITPY_ENVIRON=1 \
+	-DCIRCUITPY_OS_GETENV=1 \
 	-DCIRCUITPY_GIFIO=1 \
 	-DCIRCUITPY_RAINBOWIO=1 \
 	-DCIRCUITPY_TRACEBACK=1 \

py/circuitpy_defns.mk

@@ -182,9 +182,6 @@ endif
 ifeq ($(CIRCUITPY_DISPLAYIO),1)
 SRC_PATTERNS += displayio/%
 endif
-ifeq ($(CIRCUITPY_ENVIRON),1)
-SRC_PATTERNS += _environ/%
-endif
 ifeq ($(CIRCUITPY__EVE),1)
 SRC_PATTERNS += _eve/%
 endif
@@ -618,6 +615,7 @@ SRC_SHARED_MODULE_ALL = \
 	onewireio/__init__.c \
 	onewireio/OneWire.c \
 	os/__init__.c \
+	os/getenv.c \
 	paralleldisplay/ParallelBus.c \
 	qrio/__init__.c \
 	qrio/QRDecoder.c \