dotenvplus 0.0.1__py3-none-any.whl

dotenvplus/__init__.py

@@ -0,0 +1,163 @@
+import re
+
+from typing import Any, Iterator, Optional, Tuple, List, Dict
+
+__version__ = "0.0.1"
+
+
+class ParsingError(Exception):
+    pass
+
+
+class DotEnv:
+    """
+    DotEnv is a dotenv parser for Python with additional type support.
+    It supports parsing of string, integer, float, and boolean values.
+
+    Arguments
+    ---------
+    path: `str` | `None`
+        The path to the .env file.
+        If none are provided, it defaults to `./.env`
+    handle_key_not_found: `bool`
+        If True, it will make the object return `None` for any key that is not found.
+        Essentially simulating `dict().get("Key", None)`
+
+    Raises
+    ------
+    `FileNotFoundError`
+        If the file_path is not a valid path.
+    `ParsingError`
+        If one of the values cannot be parsed.
+    """
+    def __init__(
+        self,
+        path: Optional[str] = None,
+        *,
+        handle_key_not_found: bool = False,
+    ):
+        # RegEx patterns
+        self.__re_keyvar = re.compile(r"^\s*([a-zA-Z0-9_]*)\s*=\s*(.+)$")
+        self.__re_isdigit = re.compile(r"^(?:-)?\d+$")
+        self.__re_isfloat = re.compile(r"^(?:-)?\d+\.\d+$")
+        self.__re_var_call = re.compile(r"\$\{([a-zA-Z0-9_]*)\}")
+
+        # General values
+        self.__env: Dict[str, Any] = {}
+        self.__quotes: Tuple[str, ...] = ("\"", "'")
+
+        # Config for the parser
+        self.__path: str = path or ".env"
+        self.__handle_key_not_found: bool = handle_key_not_found
+
+        # Finally, the parser
+        self.__parser()
+
+    def __repr__(self) -> str:
+        return f"<DotEnv data={self.__env}>"
+
+    def __getitem__(self, key: str) -> Any:
+        if self.__handle_key_not_found:
+            return self.__env.get(key, None)
+        return self.__env[key]
+
+    def __str__(self) -> str:
+        return str(self.__env)
+
+    def __int__(self) -> int:
+        return len(self.__env)
+
+    def __len__(self) -> int:
+        return len(self.__env)
+
+    def __iter__(self) -> Iterator[Tuple[str, Any]]:
+        return iter(self.__env.items())
+
+    def to_dict(self) -> Dict[str, Any]:
+        """ `dict`: Returns a dictionary of the parsed values. """
+        return self.__env
+
+    def get(self, key: str, default: Any = None) -> Any:
+        """ `Any`: Return the value for key if key is in the dictionary, else default. """
+        return self.__env.get(key, default)
+
+    @property
+    def keys(self) -> List[str]:
+        """ `list[str]`: Returns a list of the keys. """
+        return list(self.__env.keys())
+
+    @property
+    def values(self) -> List[Any]:
+        """ `list[Any]`: Returns a list of the values. """
+        return list(self.__env.values())
+
+    def items(self) -> List[Tuple[str, Any]]:
+        """ `list[tuple[str, Any]]`: Returns a list of the key-value pairs. """
+        return list(self.__env.items())
+
+    def copy(self) -> Dict[str, Any]:
+        """ `dict[str, Any]`: Returns a shallow copy of the parsed values. """
+        return self.__env.copy()
+
+    def __parser(self) -> None:
+        """
+        Parse the .env file and store the values in a dictionary.
+        The keys are accessible later by using the square bracket notation
+        directly on the DotEnv object.
+
+        Raises
+        ------
+        `FileNotFoundError`
+            If the file_path is not a valid path.
+        `ParsingError`
+            If one of the values cannot be parsed.
+        """
+        with open(self.__path, "r", encoding="utf-8") as f:
+            data: List[str] = f.readlines()
+
+        for line in data:
+            line = line.strip()
+
+            if line.startswith("#") or line == "":
+                # Ignore comment or empty line
+                continue
+
+            _find_kv = self.__re_keyvar.search(line)
+            if not _find_kv:
+                raise ParsingError(f"Expected key=value format, got '{line}'")
+
+            key, value = _find_kv.groups()
+            _force_string = False
+
+            # Replace any variables in the value
+            value = self.__re_var_call.sub(
+                lambda m: str(self.__env.get(m.group(1), "undefined")),
+                str(value)
+            )
+
+            # Remove quotes, but mark it as forced string from now
+            if (
+                value.startswith(self.__quotes) and
+                value.endswith(self.__quotes)
+            ):
+                value = value[1:-1]
+                _force_string = True
+
+            if not _force_string:
+
+                if self.__re_isdigit.search(value):
+                    value = int(value)
+
+                elif self.__re_isfloat.search(value):
+                    value = float(value)
+
+                elif value.lower() in ("true", "false"):
+                    value = value.lower() == "true"
+
+                elif value.lower() in ("null", "none", "nil", "undefined"):
+                    value = None
+
+                else:
+                    value = value
+
+            self.__env[key] = value

dotenvplus-0.0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 AlexFlipnote
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dotenvplus-0.0.1.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.1
+Name: dotenvplus
+Version: 0.0.1
+Summary: Python library that handles interactions from Discord POST requests.
+Author-email: AlexFlipnote <root@alexflipnote.dev>
+License: MIT
+Keywords: discord,http,api,interaction,quart,webhook,slash
+Requires-Python: >=3.6.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Provides-Extra: maintainer
+Requires-Dist: twine; extra == "maintainer"
+Requires-Dist: wheel; extra == "maintainer"
+Requires-Dist: build; extra == "maintainer"
+
+# dotenvplus
+Reads key-value pairs from a .env file and supports multiple values with dynamic interpolation.
+
+The values returned by the DotEnv object is treated like a dictionary, so you can use it like a normal dictionary.
+Some of the usual dictionary methods are also supported like `.items()`, `.keys()`, `.values()`, etc.
+
+Goal is to make it easy to use environment variables in your code, while also supporting multiple values.
+
+## Installing
+> You need **Python >=3.6** to use this library.
+
+```bash
+pip install dotenvplus
+```
+
+## Usage
+```env
+# .env
+
+KEY=value
+```
+
+```python
+# main.py
+
+from dotenvplus import DotEnv
+
+# Create a DotEnv object
+env = DotEnv()
+
+Call it like a dictionary
+env["KEY"]
+>>> "value"
+```

dotenvplus-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+dotenvplus/__init__.py,sha256=Y_PFwwC8uFPpXussHQWeiect1TY6eJ0zxY1cuRnfEyM,5097
+dotenvplus-0.0.1.dist-info/LICENSE,sha256=puF1l3bvJfFbnSlkpuOs1MtXnD9P7CdebKSdOmPc7Fo,1090
+dotenvplus-0.0.1.dist-info/METADATA,sha256=ZUGdvmVzZTXvKm2-Lxp3qU2i2c6-F_4nGm9Q4hW8GeM,1408
+dotenvplus-0.0.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+dotenvplus-0.0.1.dist-info/top_level.txt,sha256=nO-n31rieDIPggQ4AW2MZB9_xgdwWPwoAUUrJE7hsLI,11
+dotenvplus-0.0.1.dist-info/RECORD,,

dotenvplus-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dotenvplus-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+dotenvplus