Merge pull request #4 from hmohammad2520-org/2-env-mixin

Adding ENVMod to classmods

Author: HMohammad2520

classmods/_env_mod.py

@@ -95,7 +95,7 @@ def register(cls, *, exclude: Optional[List[str]] = None) -> Callable:
         Decorator to register class methods for env parsing.
 
         Raise:
-            TypeError: if a object is not env parsable.
+            TypeError: If an argument is not env parsable.
 
         Example:
         >>> class APIService:
@@ -110,10 +110,9 @@ def register(cls, *, exclude: Optional[List[str]] = None) -> Callable:
                 ) -> none:
         ...        ...
         
-        In this example ENVMod will create env items for each object in init except ssl_key.
+        In this example ENVMod will create env items for each argument except ssl_key.
         
         Note: Make sure you add type hints to get the same type when loading from env file.
-
         """
         exclude = exclude or []
 
@@ -128,7 +127,7 @@ def decorator(func: Callable) -> Callable:
             type_hints = get_type_hints(func)
 
             for param in sig.parameters.values():
-                if param.name == 'self' or param.name in exclude:
+                if param.name in ['self', 'cls'] or param.name in exclude:
                     continue
 
                 param_type = type_hints.get(param.name, str)
@@ -196,17 +195,21 @@ def cast(value: str, _type: Type) -> Any:
                 if value.lower() in ('1', 'true', 'yes'): return True
                 elif value.lower() in ('0', 'false', 'no'): return False
                 else: raise ValueError(f"Casting env is not a valid bool: {value}. valid bool: '0', 'false', 'no', '1', 'true', 'yes'")
+
             return _type(value)
 
         result = {}
         for arg, env_key in mapping.items():
             value = os.environ.get(env_key)
-            if value is None:
+            if value is None or value == '':
                 result[arg] = None
                 continue
 
             result[arg] = cast(value, types.get(arg, str))
 
+        # Remove None from results
+        result = {k: v for k, v in result.items() if v is not None}
+
         return result
 
     @classmethod

test/test_envmod.py

@@ -0,0 +1,70 @@
+import os
+from typing import Callable
+from classmods import ENVMod
+
+class TestClass:
+    @ENVMod.register(exclude=['service'])
+    def __init__(self, name: str, age: int, service: Callable|None = None):
+        """
+        Test Class.
+
+        Args:
+            name: your name.
+            age: your age.
+        """
+        self.name = name
+        self.age = age
+
+    @ENVMod.register()
+    def _connect(self, host: str, timeout: float, port: int = 80):
+        """ No Doc For Args"""
+        self.host = host
+        self.timeout = timeout
+        self.port = port
+
+    @ENVMod.register()
+    def _disconnect(cls):
+        ...
+
+
+def test_file_creations():
+    ENVMod.save_example('dev_env_example.txt')
+    ENVMod.sync_env_file()
+    assert os.path.exists('dev_env_example.txt')
+    assert os.path.exists('.env')
+
+    with open('.env', 'w') as f:
+        f.writelines([
+            'TESTCLASS_NAME=test_name\n',
+            'TESTCLASS_AGE=25\n',
+            'TESTCLASS_HOST=127.0.0.1\n',
+            'TESTCLASS_TIMEOUT=1.43\n',
+        ])
+
+def test_env_vars():
+    ENVMod.sync_env_file()
+    ENVMod.load_dotenv()
+    keys = os.environ.keys()
+    assert 'TESTCLASS_NAME' in keys
+    assert 'TESTCLASS_AGE' in keys
+    assert 'TESTCLASS_HOST' in keys
+    assert 'TESTCLASS_TIMEOUT' in keys
+
+def test_env_values():
+    ENVMod.sync_env_file()
+    ENVMod.load_dotenv()
+    assert os.environ.get('TESTCLASS_NAME') == 'test_name'
+    assert os.environ.get('TESTCLASS_AGE') == '25'
+    assert os.environ.get('TESTCLASS_HOST') == '127.0.0.1'
+    assert os.environ.get('TESTCLASS_TIMEOUT') == '1.43'
+
+def test_load_args():
+    ENVMod.sync_env_file()
+    ENVMod.load_dotenv()
+    test_object = TestClass(**ENVMod.load_args(TestClass.__init__))
+    test_object._connect(**ENVMod.load_args(TestClass._connect))
+    assert test_object.name == 'test_name'
+    assert test_object.age == 25
+    assert test_object.host == '127.0.0.1'
+    assert test_object.timeout == 1.43
+    assert test_object.port == 80