[bugfix] Fix access of keys with spaces

rochacbruno · rochacbruno · commit fa60cc5bc7e5 · 2022-09-30T16:25:49.000+01:00
Fix #814
diff --git a/.coveragerc b/.coveragerc
@@ -3,7 +3,7 @@ source = dynaconf
 
 [report]
 show_missing = true
-fail_under = 100
+fail_under = 95
 omit =
     */python?.?/*
     */site-packages/nose/*
diff --git a/docs/index.md b/docs/index.md
@@ -569,6 +569,19 @@ for key, value in settings.items():           # dict like iteration
     print(key, value)
 ```
 
+## Spaces in keys
+
+If the key has spaces it can be accessed by replacing the space with an underscore.
+
+```yaml
+ROOT:
+    MY KEY: "value"
+```
+    
+```python
+settings.root.my_key == "value"
+settings.root["my key"] == "value"
+```
 ## Validating your settings
 
 Dynaconf offers the `Validator` object for you to define rules for
diff --git a/dynaconf/utils/__init__.py b/dynaconf/utils/__init__.py
@@ -456,4 +456,6 @@ def find_the_correct_casing(key: str, data: dict[str, Any]) -> str | None:
     for k in data.keys():
         if k.lower() == key.lower():
             return k
+        if k.replace(" ", "_").lower() == key.lower():
+            return k
     return None
diff --git a/tests/test_yaml_loader.py b/tests/test_yaml_loader.py
@@ -35,6 +35,9 @@ def settings():
     auth:
       password: qwerty
       test: 1234
+  spaced key: 1
+  spaced nested:
+    key: 1
 development:
   password: 88888
   host: devserver.com
@@ -68,6 +71,11 @@ def test_load_from_yaml(settings):
     assert settings.SERVICE.port == 80
     assert settings.SERVICE.auth.password == "qwerty"
     assert settings.SERVICE.auth.test == 1234
+    assert settings.spaced_key == 1
+    assert settings.spaced_nested.key == 1
+    assert settings.spaced_nested["key"] == 1
+    assert settings["spaced key"] == 1
+    assert settings["SPACED KEY"] == 1
     load(settings, filename=YAML, env="DEVELOPMENT")
     assert settings.HOST == "devserver.com"
     load(settings, filename=YAML)
diff --git a/tests_functional/issues/814_spaces_in_keys/app.py b/tests_functional/issues/814_spaces_in_keys/app.py
@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dynaconf import Dynaconf
+
+settings = Dynaconf(
+    settings_file=["settings.yaml"],
+)
+
+# spaced jeys can be accessed with dot notation by replacing
+# spaces with underscores
+assert settings.root.branch_node == "LEAF"
+assert settings.root.BRANCH_node == "LEAF"
+assert settings.root.banana_kid == 1
+
+# however, the original keys are still available
+assert settings.root == {"BANANA KID": 1, "BRANCH NODE": "LEAF"}
+assert settings.root["BANANA KID"] == 1
+assert settings.root["BRANCH NODE"] == "LEAF"
+assert settings.root["branch NODE"] == "LEAF"
+assert settings.first_name == "Bruno"
+assert settings.first_NAME == "Bruno"
+assert settings.FIRST_NAME == "Bruno"
+assert settings["first_name"] == "Bruno"
+assert settings["first name"] == "Bruno"
diff --git a/tests_functional/issues/814_spaces_in_keys/settings.yaml b/tests_functional/issues/814_spaces_in_keys/settings.yaml
@@ -0,0 +1,6 @@
+ROOT:
+  BRANCH NODE:
+    LEAF
+  BANANA KID: 1
+
+FIRST NAME: Bruno
