add return codes to CLI, simplify nbdev export deps

Author: tutankalex

nbs/00_core.ipynb

@@ -25,25 +25,36 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "from nbdev.showdoc import *\n",
-    "from fastcore.test import *\n",
-    "from unittest.mock import patch\n",
-    "\n",
-    "import dotenv\n",
     "import json\n",
+    "import logging\n",
     "import os\n",
     "import os.path\n",
-    "import jsonschema\n",
-    "import logging\n",
-    "from jsonschema import validate, ValidationError\n",
     "from typing import Union\n",
+    "\n",
+    "import dotenv\n",
+    "import jsonschema\n",
     "from fs.base import FS\n",
     "from fs.osfs import OSFS\n",
-    "\n",
+    "from jsonschema import ValidationError, validate\n",
     "\n",
     "logger = logging.getLogger(__name__)"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "\n",
+    "# dev/testing deps\n",
+    "from unittest.mock import patch\n",
+    "\n",
+    "from fastcore.test import *\n",
+    "from nbdev.showdoc import *"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -652,7 +663,7 @@
     "ConfigValidator.DEFAULT_STORAGE_DRIVER = memfs_fallback\n",
     "\n",
     "validated_config5 = ConfigValidator.load_dotenv(\n",
-    "    json_schema='schema.json'\n",
+    "    json_schema='schema.json',\n",
     ")\n",
     "    \n",
     "ConfigValidator.DEFAULT_STORAGE_DRIVER = OLD_DRIVER"
@@ -662,22 +673,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "ename": "ResourceNotFound",
-     "evalue": "resource 'special-bespoke-location/my-own.env' not found",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mResourceNotFound\u001b[0m                          Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[97], line 11\u001b[0m\n\u001b[1;32m      4\u001b[0m \u001b[38;5;28;01mwith\u001b[39;00m memfs\u001b[38;5;241m.\u001b[39mopen(\u001b[38;5;124m'\u001b[39m\u001b[38;5;124mfoo.schema.json\u001b[39m\u001b[38;5;124m'\u001b[39m, \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mw\u001b[39m\u001b[38;5;124m'\u001b[39m) \u001b[38;5;28;01mas\u001b[39;00m ofile:\n\u001b[1;32m      5\u001b[0m     ofile\u001b[38;5;241m.\u001b[39mwrite(json\u001b[38;5;241m.\u001b[39mdumps({\n\u001b[1;32m      6\u001b[0m         \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mtype\u001b[39m\u001b[38;5;124m'\u001b[39m: \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mobject\u001b[39m\u001b[38;5;124m'\u001b[39m,\n\u001b[1;32m      7\u001b[0m         \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mproperties\u001b[39m\u001b[38;5;124m'\u001b[39m: {\n\u001b[1;32m      8\u001b[0m             \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mA_NUMERIC_VALUE\u001b[39m\u001b[38;5;124m'\u001b[39m: { \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mtype\u001b[39m\u001b[38;5;124m'\u001b[39m: \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mnumber\u001b[39m\u001b[38;5;124m'\u001b[39m },\n\u001b[1;32m      9\u001b[0m         }\n\u001b[1;32m     10\u001b[0m     }))\n\u001b[0;32m---> 11\u001b[0m validated_dotenv \u001b[38;5;241m=\u001b[39m \u001b[43mConfigValidator\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mload_dotenv\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m     12\u001b[0m \u001b[43m    \u001b[49m\u001b[43mjson_schema\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;124;43m'\u001b[39;49m\u001b[38;5;124;43mfoo.schema.json\u001b[39;49m\u001b[38;5;124;43m'\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m     13\u001b[0m \u001b[43m    \u001b[49m\u001b[43mdotenv_path\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;124;43m'\u001b[39;49m\u001b[38;5;124;43mspecial-bespoke-location/my-own.env\u001b[39;49m\u001b[38;5;124;43m'\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m     14\u001b[0m \u001b[43m    \u001b[49m\u001b[43mstorage_driver\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mmemfs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m     15\u001b[0m \u001b[43m)\u001b[49m\n\u001b[1;32m     16\u001b[0m test_eq(validated_dotenv, {\n\u001b[1;32m     17\u001b[0m     \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mA_NUMERIC_VALUE\u001b[39m\u001b[38;5;124m'\u001b[39m: \u001b[38;5;241m1167.89\u001b[39m,\n\u001b[1;32m     18\u001b[0m })\n\u001b[1;32m     20\u001b[0m test_fail(validator\u001b[38;5;241m.\u001b[39mload_dotenv, kwargs\u001b[38;5;241m=\u001b[39m{\u001b[38;5;124m'\u001b[39m\u001b[38;5;124mdotenv_path\u001b[39m\u001b[38;5;124m'\u001b[39m: \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mnon-existent-location-own.env\u001b[39m\u001b[38;5;124m'\u001b[39m})\n",
-      "Cell \u001b[0;32mIn[80], line 143\u001b[0m, in \u001b[0;36mConfigValidator.load_dotenv\u001b[0;34m(cls, json_schema, dotenv_path, storage_driver, override)\u001b[0m\n\u001b[1;32m    141\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m dotenv_path:\n\u001b[1;32m    142\u001b[0m     dotenv_storage_driver \u001b[38;5;241m=\u001b[39m storage_driver \u001b[38;5;129;01mor\u001b[39;00m \u001b[38;5;28mcls\u001b[39m\u001b[38;5;241m.\u001b[39m_get_maybe_abspath_driver(dotenv_path)\n\u001b[0;32m--> 143\u001b[0m     \u001b[38;5;28;01mwith\u001b[39;00m \u001b[43mdotenv_storage_driver\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mopen\u001b[49m\u001b[43m(\u001b[49m\u001b[43mdotenv_path\u001b[49m\u001b[43m)\u001b[49m \u001b[38;5;28;01mas\u001b[39;00m ifile:\n\u001b[1;32m    144\u001b[0m         config \u001b[38;5;241m=\u001b[39m dotenv\u001b[38;5;241m.\u001b[39mdotenv_values(stream\u001b[38;5;241m=\u001b[39mifile)\n\u001b[1;32m    146\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m config \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m:\n",
-      "File \u001b[0;32m~/Desktop/experiment/python-schematized-config/venv/lib/python3.10/site-packages/fs/base.py:1228\u001b[0m, in \u001b[0;36mFS.open\u001b[0;34m(self, path, mode, buffering, encoding, errors, newline, **options)\u001b[0m\n\u001b[1;32m   1226\u001b[0m validate_open_mode(mode)\n\u001b[1;32m   1227\u001b[0m bin_mode \u001b[38;5;241m=\u001b[39m mode\u001b[38;5;241m.\u001b[39mreplace(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mt\u001b[39m\u001b[38;5;124m\"\u001b[39m, \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[0;32m-> 1228\u001b[0m bin_file \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mopenbin\u001b[49m\u001b[43m(\u001b[49m\u001b[43mpath\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mmode\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mbin_mode\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mbuffering\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mbuffering\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m   1229\u001b[0m io_stream \u001b[38;5;241m=\u001b[39m iotools\u001b[38;5;241m.\u001b[39mmake_stream(\n\u001b[1;32m   1230\u001b[0m     path,\n\u001b[1;32m   1231\u001b[0m     bin_file,\n\u001b[0;32m   (...)\u001b[0m\n\u001b[1;32m   1237\u001b[0m     \u001b[38;5;241m*\u001b[39m\u001b[38;5;241m*\u001b[39moptions\n\u001b[1;32m   1238\u001b[0m )\n\u001b[1;32m   1239\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m io_stream\n",
-      "File \u001b[0;32m~/Desktop/experiment/python-schematized-config/venv/lib/python3.10/site-packages/fs/memoryfs.py:513\u001b[0m, in \u001b[0;36mMemoryFS.openbin\u001b[0;34m(self, path, mode, buffering, **options)\u001b[0m\n\u001b[1;32m    511\u001b[0m parent_dir_entry \u001b[38;5;241m=\u001b[39m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_get_dir_entry(dir_path)\n\u001b[1;32m    512\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m parent_dir_entry \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m \u001b[38;5;129;01mor\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m parent_dir_entry\u001b[38;5;241m.\u001b[39mis_dir:\n\u001b[0;32m--> 513\u001b[0m     \u001b[38;5;28;01mraise\u001b[39;00m errors\u001b[38;5;241m.\u001b[39mResourceNotFound(path)\n\u001b[1;32m    515\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m _mode\u001b[38;5;241m.\u001b[39mcreate:\n\u001b[1;32m    516\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m file_name \u001b[38;5;129;01mnot\u001b[39;00m \u001b[38;5;129;01min\u001b[39;00m parent_dir_entry:\n",
-      "\u001b[0;31mResourceNotFound\u001b[0m: resource 'special-bespoke-location/my-own.env' not found"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| hide\n",
     "# test using custom json schema\n",
@@ -774,8 +770,8 @@
     "possibly due to jupyter environment blackmagicfuddery, mocking builtins.open DOES NOT WORK!\n",
     "take the easy way out and mock an actual file!\n",
     "'''\n",
-    "import tempfile\n",
     "import os.path as _p\n",
+    "import tempfile\n",
     "\n",
     "OLD_DRIVER = ConfigValidator.DEFAULT_STORAGE_DRIVER\n",
     "ConfigValidator.DEFAULT_STORAGE_DRIVER = None\n",

nbs/01_cli.ipynb

@@ -28,18 +28,16 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "from schematized_config.core import (\n",
-    "    ConfigValidator,\n",
-    "    ConfigValidatorException,\n",
-    "    extract_declared_items,\n",
-    ")\n",
-    "\n",
+    "import argparse\n",
     "import os\n",
     "import sys\n",
-    "import argparse\n",
-    "import dotenv\n",
     "from typing import Union\n",
-    "from fastcore.script import call_parse, anno_parser"
+    "\n",
+    "import dotenv\n",
+    "from fastcore.script import anno_parser, call_parse\n",
+    "\n",
+    "from schematized_config.core import (ConfigValidator, ConfigValidatorException,\n",
+    "                                     extract_declared_items)"
    ]
   },
   {
@@ -50,7 +48,7 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def validate_env(json_schema: Union[str, dict], dotenv_path: str=None):\n",
+    "def validate_env(json_schema: Union[str, dict], dotenv_path: str=None) -> bool:\n",
     "    validator = ConfigValidator(json_schema)\n",
     "    try:\n",
     "        validator.load_config(dotenv.dotenv_values(dotenv_path))\n",
@@ -70,7 +68,7 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def generate_sample_dotenv(json_schema: Union[str, dict], seed_config: dict=None):\n",
+    "def generate_sample_dotenv(json_schema: Union[str, dict], seed_config: dict=None) -> str:\n",
     "    schema_dict = ConfigValidator.load_json(json_schema)\n",
     "    merged_config = dict(os.environ)\n",
     "    default_dotenv = dotenv.dotenv_values()\n",
@@ -163,9 +161,12 @@
     "        sys.stdout.write(generate_sample_dotenv(generate))\n",
     "    elif schema and validate:\n",
     "        dotenv_path = validate\n",
-    "        validate_env(schema, dotenv_path)\n",
+    "        if validate_env(schema, dotenv_path):\n",
+    "            sys.exit(0)\n",
+    "        else:\n",
+    "            sys.exit(1)\n",
     "    else:\n",
-    "        anno_parser(main, EXECUTABLE_NAME).print_help()\n"
+    "        anno_parser(main, EXECUTABLE_NAME).print_help()"
    ]
   },
   {

schematized_config/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.10"
+__version__ = "0.0.11"

schematized_config/cli.py

@@ -4,21 +4,19 @@
 __all__ = ['VERSION', 'EXECUTABLE_NAME', 'validate_env', 'generate_sample_dotenv', 'main']
 
 # %% ../nbs/01_cli.ipynb 2
-from schematized_config.core import (
-    ConfigValidator,
-    ConfigValidatorException,
-    extract_declared_items,
-)
-
+import argparse
 import os
 import sys
-import argparse
-import dotenv
 from typing import Union
-from fastcore.script import call_parse, anno_parser
+
+import dotenv
+from fastcore.script import anno_parser, call_parse
+
+from .core import (ConfigValidator, ConfigValidatorException,
+                                     extract_declared_items)
 
 # %% ../nbs/01_cli.ipynb 3
-def validate_env(json_schema: Union[str, dict], dotenv_path: str=None):
+def validate_env(json_schema: Union[str, dict], dotenv_path: str=None) -> bool:
     validator = ConfigValidator(json_schema)
     try:
         validator.load_config(dotenv.dotenv_values(dotenv_path))
@@ -30,7 +28,7 @@ def validate_env(json_schema: Union[str, dict], dotenv_path: str=None):
         return False
 
 # %% ../nbs/01_cli.ipynb 4
-def generate_sample_dotenv(json_schema: Union[str, dict], seed_config: dict=None):
+def generate_sample_dotenv(json_schema: Union[str, dict], seed_config: dict=None) -> str:
     schema_dict = ConfigValidator.load_json(json_schema)
     merged_config = dict(os.environ)
     default_dotenv = dotenv.dotenv_values()
@@ -78,7 +76,9 @@ def main(
         sys.stdout.write(generate_sample_dotenv(generate))
     elif schema and validate:
         dotenv_path = validate
-        validate_env(schema, dotenv_path)
+        if validate_env(schema, dotenv_path):
+            sys.exit(0)
+        else:
+            sys.exit(1)
     else:
         anno_parser(main, EXECUTABLE_NAME).print_help()
-

schematized_config/core.py

@@ -4,25 +4,21 @@
 __all__ = ['logger', 'coerce_primitive_values', 'extract_declared_items', 'ConfigValidatorException', 'ConfigValidator']
 
 # %% ../nbs/00_core.ipynb 2
-from nbdev.showdoc import *
-from fastcore.test import *
-from unittest.mock import patch
-
-import dotenv
 import json
+import logging
 import os
 import os.path
-import jsonschema
-import logging
-from jsonschema import validate, ValidationError
 from typing import Union
+
+import dotenv
+import jsonschema
 from fs.base import FS
 from fs.osfs import OSFS
-
+from jsonschema import ValidationError, validate
 
 logger = logging.getLogger(__name__)
 
-# %% ../nbs/00_core.ipynb 3
+# %% ../nbs/00_core.ipynb 4
 def coerce_primitive_values(json_schema: dict, data: dict) -> dict:
     """
     Given a JSON schema dictionary, return a dictionary where the values that have
@@ -68,7 +64,7 @@ def coerce_primitive_values(json_schema: dict, data: dict) -> dict:
             continue
     return out
 
-# %% ../nbs/00_core.ipynb 6
+# %% ../nbs/00_core.ipynb 7
 def extract_declared_items(json_schema: dict, data: dict) -> dict:
     """
     Given a JSON schema dict, return a dict following specified rules:
@@ -92,7 +88,7 @@ def extract_declared_items(json_schema: dict, data: dict) -> dict:
             out[required_property] = property_schema['default']
     return out
 
-# %% ../nbs/00_core.ipynb 8
+# %% ../nbs/00_core.ipynb 9
 class ConfigValidatorException(Exception):
 
     def __init__(self, errors):

settings.ini

@@ -1,7 +1,7 @@
 [DEFAULT]
 repo = python-schematized-config
 lib_name = python-schematized-config
-version = 0.0.10
+version = 0.0.12
 min_python = 3.7
 license = apache2
 black_formatting = False
@@ -26,7 +26,7 @@ keywords = nbdev jupyter notebook python
 language = English
 status = 3
 user = tutankalex
-requirements = jsonschema>=4.17.3 python-dotenv>=1.0.0 fs>=2.4.16 nbdev>=2.3.12
+requirements = jsonschema>=4.17.3 python-dotenv>=1.0.0 fs>=2.4.16
 readme_nb = index.ipynb
 allowed_metadata_keys = 
 allowed_cell_metadata_keys =