upd: prefer os.environ variables when found; bump to 0.0.5

Author: tutankalex

README.md

@@ -9,6 +9,16 @@ schematized config
 pip install python_schematized_config
 ```
 
+# development
+
+assuming you have [nix](https://nixos.org/download.html) installed and
+ready, make sure `nix-command` and `flake` are enabled (oneliner: run
+`export NIX_CONFIG="experimental-features = nix-command flakes"` in the
+terminal), then enter the dev shell using `nix develop`
+
+start the jupyter notebook using the provided alias or just
+`jupyter notebook`, and hack away
+
 ## How to use
 
 ``` python

nbs/00_core.ipynb

@@ -282,8 +282,25 @@
     "    @classmethod\n",
     "    def load_dotenv(cls, json_schema: Union[str, dict]=None, dotenv_path: str=None, storage_driver: FS=None):\n",
     "        storage_driver = storage_driver or cls.DEFAULT_STORAGE_DRIVER\n",
-    "        with storage_driver.open(dotenv_path) as ifile:\n",
-    "            config = dotenv.dotenv_values(stream=ifile)\n",
+    "        if dotenv_path is None:\n",
+    "            maybe_dotenv_path = dotenv.find_dotenv()  # '' if not exist\n",
+    "            if maybe_dotenv_path:\n",
+    "                logger.debug(f'using detected dotenv path; {maybe_dotenv_path}')\n",
+    "                dotenv_path = maybe_dotenv_path\n",
+    "        if dotenv_path:\n",
+    "            with storage_driver.open(dotenv_path) as ifile:\n",
+    "                config = dotenv.dotenv_values(stream=ifile)\n",
+    "        else:\n",
+    "            config = {}\n",
+    "        loaded_config = config.copy()\n",
+    "        \n",
+    "        json_schema_dict = cls.load_json(json_schema, storage_driver=storage_driver) or {}\n",
+    "        for key in json_schema_dict.get('properties', []):\n",
+    "            if key not in os.environ:\n",
+    "                continue\n",
+    "            if key in config and config[key] != os.environ[key]:\n",
+    "                logger.debug(f'os.environ key \"{key}\" overriding value present in {dotenv_path}')\n",
+    "            config[key] = os.environ[key]\n",
     "        return cls.load_validated_config(\n",
     "            json_schema or cls.get_default_json_schema(storage_driver=storage_driver),\n",
     "            config, storage_driver=storage_driver)"
@@ -350,17 +367,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "$:\t'string_value_with_enum' is a required property\n",
-      "$:\t'MY_INTEGER_VALUE' is a required property\n",
-      "$:\t'A_NUMERIC_VALUE' is a required property\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| hide\n",
     "test_fail(ConfigValidator.load_validated_config, args=(example_properties_schema, {}))"
@@ -408,15 +415,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "$.string_value_with_enum:\t'blah-blah' is not one of ['it', 'can', 'only', 'be', 'one', 'of', 'these']\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| hide\n",
     "test_fail(ConfigValidator.load_validated_config,\n",
@@ -432,15 +431,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "$.MY_INTEGER_VALUE:\t'5555.999' is not of type 'integer'\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| hide\n",
     "test_fail(ConfigValidator.load_validated_config,\n",
@@ -456,15 +447,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "$.A_NUMERIC_VALUE:\t'WHAT???' is not of type 'number'\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| hide\n",
     "test_fail(ConfigValidator.load_validated_config,\n",
@@ -480,15 +463,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "$.A_NUMERIC_VALUE:\t13.0 is less than the minimum of 22\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| hide\n",
     "test_fail(ConfigValidator.load_validated_config,\n",
@@ -590,6 +565,65 @@
     "test_fail(validator.load_dotenv, kwargs={'dotenv_path': 'non-existent-location-own.env'})"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "# test data load precedence\n",
+    "\n",
+    "with memfs.open('bar.schema.json', 'w') as ofile:\n",
+    "    ofile.write(json.dumps({\n",
+    "        'type': 'object',\n",
+    "        'properties': {\n",
+    "            'A_VALUE_TO_OVERRIDE': { 'type': 'string', 'default': 'change me' },\n",
+    "        }\n",
+    "    }))\n",
+    "    \n",
+    "memfs.makedirs('precedence-test', recreate=True)\n",
+    "with memfs.open('precedence-test/.env', 'w') as ofile:\n",
+    "    ofile.write('\\n'.join([\n",
+    "        'A_VALUE_TO_OVERRIDE=in dotenv',\n",
+    "    ]))\n",
+    "\n",
+    "os.environ.pop('A_VALUE_TO_OVERRIDE', None)\n",
+    "validated_dotenv = ConfigValidator.load_dotenv(\n",
+    "    json_schema='bar.schema.json',\n",
+    "    dotenv_path='precedence-test/.env',\n",
+    "    storage_driver=memfs,\n",
+    ")\n",
+    "test_eq(validated_dotenv, {\n",
+    "    'A_VALUE_TO_OVERRIDE': 'in dotenv',\n",
+    "})\n",
+    "\n",
+    "os.environ['A_VALUE_TO_OVERRIDE'] = 'overrode from environ'\n",
+    "test_eq(ConfigValidator.load_dotenv(\n",
+    "    json_schema='bar.schema.json',\n",
+    "    storage_driver=memfs,\n",
+    "), {\n",
+    "    'A_VALUE_TO_OVERRIDE': 'overrode from environ',\n",
+    "})\n",
+    "\n",
+    "test_eq(ConfigValidator.load_dotenv(\n",
+    "    json_schema='bar.schema.json',\n",
+    "    dotenv_path='precedence-test/.env',\n",
+    "    storage_driver=memfs,\n",
+    "), {\n",
+    "    'A_VALUE_TO_OVERRIDE': 'overrode from environ',\n",
+    "})\n",
+    "\n",
+    "os.environ.pop('A_VALUE_TO_OVERRIDE', None)\n",
+    "test_eq(ConfigValidator.load_dotenv(\n",
+    "    json_schema='bar.schema.json',\n",
+    "    dotenv_path='precedence-test/.env',\n",
+    "    storage_driver=memfs,\n",
+    "), {\n",
+    "    'A_VALUE_TO_OVERRIDE': 'in dotenv',\n",
+    "})"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -603,9 +637,21 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "python3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

schematized_config/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"