dotenv becomes settings.toml

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_DOTENV
-#include "shared-module/dotenv/__init__.h"
+#if CIRCUITPY_ENVIRON
+#include "shared-bindings/_environ/__init__.h"
 #endif
 
 #define MSEC_TO_UNITS(TIME, RESOLUTION) (((TIME) * 1000) / (RESOLUTION))
@@ -284,15 +284,15 @@ 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_DOTENV
-    char ble_name[32];
-    name_len = dotenv_get_key("/.env", "CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name) - 1);
-    if (name_len > 0) {
-        self->name = mp_obj_new_str(ble_name, (size_t)name_len);
+    #if CIRCUITPY_ENVIRON
+    mp_obj_t name = common_hal__environ_get_key("CIRCUITPY_BLE_NAME");
+    if (name != mp_const_none) {
+        mp_arg_validate_type_string(name, MP_QSTR_CIRCUITPY_BLE_NAME);
+        self->name = name;
     }
     #endif
 
-    if (name_len <= 0) {
+    if (!self->name) {
         name_len = sizeof(default_ble_name);
         bt_addr_t addr;
         hci_check_error(hci_read_bd_addr(&addr));

docs/environment.rst

@@ -6,24 +6,36 @@ 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 mimicking the `dotenv <https://github.com/theskumar/python-dotenv>`_
-CPython library. Other languages such as Javascript, PHP and Ruby also have
-dotenv libraries.
+CircuitPython supports these by parsing a subset of the `toml <https://toml.io/>`_ file format internally.
 
-These libraries store environment variables in a ``.env`` file. Here is a simple
-example:
+Here is a simple example:
 
 .. code-block:: bash
 
-  KEY1='value1'
+  KEY1="value1"
   # Comment
-  KEY2='value2
-  is multiple lines'
+  KEY2="value2\ncontains a newline"
 
-CircuitPython uses the ``.env`` at the drive root (no folder) as the environment.
+  [SECTION] # Only values in the "root table" are parsed
+  SECTION_VALUE = ... # so this value cannot be seen by 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 ``/.env`` on every access.
+will parse the ``settings.toml`` file contents on every access.
+
+Details of the toml language subset
+-----------------------------------
+
+* The content is required to be in UTF-8 encoding
+* The supported data types are string and integer
+* Only basic strings are supported, not triple-quoted strings
+* Only integers supported by strtol. (no 0o, no 0b, no underscores 1_000, 011
+  is 9, not 11)
+* Only bare keys are supported
+* Duplicate keys are not diagnosed.
+* Comments are supported
+* Only values from the "root table" can be retrieved
 
 CircuitPython behavior
 ----------------------

docs/workflows.md

@@ -46,7 +46,7 @@ connection, the central device can discover two default services. One for file t
 CircuitPython specifically that includes serial characteristics.
 
 To change the default BLE advertising name without (or before) running user code, the desired name
-can be put in the `/.env` file. The key is `CIRCUITPY_BLE_NAME`. It's limited to approximately
+can be put in the `settings.toml` file. The key is `CIRCUITPY_BLE_NAME`. It's limited to approximately
 30 characters depending on the port's settings and will be truncated if longer.
 
 ### File Transfer API
@@ -69,21 +69,21 @@ Read-only characteristic that returns the UTF-8 encoded version string.
 
 ## Web
 
-The web workflow is depends on adding Wi-Fi credentials into the `/.env` file. The keys are
+The web workflow is depends on adding Wi-Fi credentials into the `settings.toml` file. The keys are
 `CIRCUITPY_WIFI_SSID` and `CIRCUITPY_WIFI_PASSWORD`. Once these are defined, CircuitPython will
 automatically connect to the network and start the webserver used for the workflow. The webserver
 is on port 80 unless overridden by `CIRCUITPY_WEB_API_PORT`. It also enables MDNS.
 
-Here is an example `/.env`:
+Here is an example `/settings.toml`:
 
 ```bash
 # To auto-connect to Wi-Fi
-CIRCUITPY_WIFI_SSID='scottswifi'
-CIRCUITPY_WIFI_PASSWORD='secretpassword'
+CIRCUITPY_WIFI_SSID="scottswifi"
+CIRCUITPY_WIFI_PASSWORD="secretpassword"
 
 # To enable modifying files from the web. Change this too!
 # Leave the User field blank in the browser.
-CIRCUITPY_WEB_API_PASSWORD='passw0rd'
+CIRCUITPY_WEB_API_PASSWORD="passw0rd"
 
 CIRCUITPY_WEB_API_PORT=80
 ```
@@ -124,7 +124,7 @@ All file system related APIs are protected by HTTP basic authentication. It is *
 hopefully prevent some griefing in shared settings. The password is sent unencrypted so do not reuse
 a password with something important. The user field is left blank.
 
-The password is taken from `/.env` with the key `CIRCUITPY_WEB_API_PASSWORD`. If this is unset, the
+The password is taken from `settings.toml` with the key `CIRCUITPY_WEB_API_PASSWORD`. If this is unset, the
 server will respond with `403 Forbidden`. When a password is set, but not provided in a request, it
 will respond `401 Unauthorized`.
 

locale/circuitpython.pot

@@ -1002,6 +1002,10 @@ msgstr ""
 msgid "File exists"
 msgstr ""
 
+#: shared-module/dotenv/__init__.c
+msgid "File not found"
+msgstr ""
+
 #: ports/atmel-samd/common-hal/canio/Listener.c
 #: ports/espressif/common-hal/canio/Listener.c
 #: ports/stm/common-hal/canio/Listener.c
@@ -1184,6 +1188,7 @@ msgid "Internal define error"
 msgstr ""
 
 #: ports/espressif/common-hal/paralleldisplay/ParallelBus.c
+#: shared-module/dotenv/__init__.c
 msgid "Internal error"
 msgstr ""
 
@@ -1230,6 +1235,11 @@ msgstr ""
 msgid "Invalid bits per value"
 msgstr ""
 
+#: shared-module/dotenv/__init__.c
+#, c-format
+msgid "Invalid byte %.*s"
+msgstr ""
+
 #: ports/atmel-samd/common-hal/imagecapture/ParallelImageCapture.c
 #, c-format
 msgid "Invalid data_pins[%d]"
@@ -1260,10 +1270,18 @@ msgstr ""
 msgid "Invalid state"
 msgstr ""
 
+#: shared-module/dotenv/__init__.c
+msgid "Invalid unicode escape"
+msgstr ""
+
 #: shared-bindings/aesio/aes.c
 msgid "Key must be 16, 24, or 32 bytes long"
 msgstr ""
 
+#: shared-module/dotenv/__init__.c
+msgid "Key not found"
+msgstr ""
+
 #: shared-module/is31fl3741/FrameBuffer.c
 msgid "LED mappings must match display size"
 msgstr ""

ports/espressif/bindings/esp32_camera/Camera.c

@@ -63,7 +63,7 @@
 //|         """
 //|         Configure and initialize a camera with the given properties
 //|
-//|         This driver requires that the ``CIRCUITPY_RESERVED_PSRAM`` in ``/.env`` be large enough to hold the camera frambuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError or an IDFError, this probably indicates the setting is too small and should be increased.
+//|         This driver requires that the ``CIRCUITPY_RESERVED_PSRAM`` in ``settings.toml`` be large enough to hold the camera frambuffer(s). Generally, boards with built-in cameras will have a default setting that is large enough. If the constructor raises a MemoryError or an IDFError, this probably indicates the setting is too small and should be increased.
 //|
 //|
 //|         .. important::

ports/espressif/bindings/espidf/__init__.c

@@ -132,7 +132,7 @@ STATIC mp_obj_t espidf_get_total_psram(void) {
 MP_DEFINE_CONST_FUN_OBJ_0(espidf_get_total_psram_obj, espidf_get_total_psram);
 
 //| def get_reserved_psram() -> int:
-//|     """Returns number of bytes of psram reserved for use by esp-idf, either a board-specific default value or the value defined in ``/.env``."""
+//|     """Returns number of bytes of psram reserved for use by esp-idf, either a board-specific default value or the value defined in ``settings.toml``."""
 //|
 STATIC mp_obj_t espidf_get_reserved_psram(void) {
     return MP_OBJ_NEW_SMALL_INT(common_hal_espidf_get_reserved_psram());

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

@@ -59,8 +59,8 @@
 #include "esp_bt.h"
 #include "esp_nimble_hci.h"
 
-#if CIRCUITPY_DOTENV
-#include "shared-module/dotenv/__init__.h"
+#if CIRCUITPY_ENVIRON
+#include "shared-module/_environ/__init__.h"
 #endif
 
 bleio_connection_internal_t bleio_connections[BLEIO_TOTAL_CONNECTION_COUNT];
@@ -101,28 +101,24 @@ 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_DOTENV
-        mp_int_t name_len = 0;
-        char ble_name[32];
-        name_len = dotenv_get_key("/.env", "CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name) - 1);
-        if (name_len > 0) {
-            if (name_len > MYNEWT_VAL_BLE_SVC_GAP_DEVICE_NAME_MAX_LENGTH) {
-                name_len = MYNEWT_VAL_BLE_SVC_GAP_DEVICE_NAME_MAX_LENGTH;
-            }
-            ble_name[name_len] = '\0';
+        #if CIRCUITPY_ENVIRON
+        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));
+        if (result == ENVIRON_OK) {
             ble_svc_gap_device_name_set(ble_name);
-        } else {
+        } else
+        #else
+        {
             ble_svc_gap_device_name_set("CIRCUITPY");
         }
-        #else
-        ble_svc_gap_device_name_set("CIRCUITPY");
         #endif
 
-        // Clear all of the internal connection objects.
-        for (size_t i = 0; i < BLEIO_TOTAL_CONNECTION_COUNT; i++) {
-            bleio_connection_internal_t *connection = &bleio_connections[i];
-            // Reset connection.
-            connection->conn_handle = BLEIO_HANDLE_INVALID;
+        {// Clear all of the internal connection objects.
+            for (size_t i = 0; i < BLEIO_TOTAL_CONNECTION_COUNT; i++) {
+                bleio_connection_internal_t *connection = &bleio_connections[i];
+                // Reset connection.
+                connection->conn_handle = BLEIO_HANDLE_INVALID;
+            }
         }
 
         cp_task = xTaskGetCurrentTaskHandle();

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/dotenv/__init__.h"
+#include "shared-module/_environ/__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 (dotenv_get_key_int("/.env", "CIRCUITPY_RESERVED_PSRAM", &reserved)) {
+        if (_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_DOTENV
-#include "shared-module/dotenv/__init__.h"
+#if CIRCUITPY_ENVIRON
+#include "shared-bindings/_environ/__init__.h"
 #endif
 
 #define BLE_MIN_CONN_INTERVAL        MSEC_TO_UNITS(15, UNIT_0_625_MS)
@@ -345,12 +345,11 @@ STATIC void bleio_adapter_reset_name(bleio_adapter_obj_t *self) {
 
     mp_int_t name_len = 0;
 
-    #if CIRCUITPY_DOTENV
-    char ble_name[32];
-    name_len = dotenv_get_key("/.env", "CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name) - 1);
-    if (name_len > 0) {
-        ble_name[name_len] = '\0';
-        common_hal_bleio_adapter_set_name(self, (char *)ble_name);
+    #if CIRCUITPY_ENVIRON
+    mp_obj_t ble_name = common_hal__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;
     }
     #endif
 

ports/unix/variants/coverage/mpconfigvariant.mk

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