dotenvplus 0.0.2__tar.gz → 0.0.4__tar.gz

{dotenvplus-0.0.2 → dotenvplus-0.0.4}/PKG-INFO

@@ -1,25 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dotenvplus
-Version: 0.0.2
-Summary: Python library that handles interactions from Discord POST requests.
+Version: 0.0.4
+Summary: Reads key-value pairs from a .env file and supports multiple values with dynamic interpolation.
 Author-email: AlexFlipnote <root@alexflipnote.dev>
 License: MIT
 Project-URL: Homepage, https://github.com/AlexFlipnote/dotenvplus
 Project-URL: Repository, https://github.com/AlexFlipnote/dotenvplus
 Keywords: dotenv,env,config,environment,variables,key-value,parser
-Requires-Python: >=3.6.0
+Requires-Python: >=3.7.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: pyright; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
+Requires-Dist: ruff; 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
+# 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.
@@ -28,7 +28,7 @@ Some of the usual dictionary methods are also supported like `.items()`, `.keys(
 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.
+> You need **Python >=3.7** to use this library.
 
 ```bash
 pip install dotenvplus

{dotenvplus-0.0.2 → dotenvplus-0.0.4}/README.md

@@ -1,4 +1,4 @@
-# dotenvplus
+# 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.
@@ -7,7 +7,7 @@ Some of the usual dictionary methods are also supported like `.items()`, `.keys(
 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.
+> You need **Python >=3.7** to use this library.
 
 ```bash
 pip install dotenvplus

{dotenvplus-0.0.2 → dotenvplus-0.0.4}/dotenvplus/__init__.py

@@ -1,8 +1,9 @@
+import os
 import re
 
 from typing import Any, Iterator, Optional, Tuple, List, Dict
 
-__version__ = "0.0.2"
+__version__ = "0.0.4"
 
 
 class ParsingError(Exception):
@@ -12,6 +13,7 @@ class ParsingError(Exception):
 class DotEnv:
     """
     DotEnv is a dotenv parser for Python with additional type support.
+
     It supports parsing of string, integer, float, and boolean values.
 
     Arguments
@@ -19,6 +21,9 @@ class DotEnv:
     path: `str` | `None`
         The path to the .env file.
         If none are provided, it defaults to `./.env`
+    update_system_env: `bool`
+        If True, it will load the values to the instance's environment variables.
+        Be warned that this will only support string values.
     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)`
@@ -34,18 +39,24 @@ class DotEnv:
         self,
         path: Optional[str] = None,
         *,
+        update_system_env: bool = False,
         handle_key_not_found: bool = False,
     ):
+        # General values
+        self.__env: dict[str, Any] = {}
+        self.__frozen: bool = False
+
+        # Defined values
+        self.__quotes: Tuple[str, ...] = ('"', "'")
+        self.__bools: Tuple[str, ...] = ("true", "false")
+        self.__none: Tuple[str, ...] = ("null", "none", "nil", "undefined")
+
         # 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
@@ -53,10 +64,16 @@ class DotEnv:
         # Finally, the parser
         self.__parser()
 
+        if update_system_env:
+            os.environ.update({
+                key: str(value)
+                for key, value in self.__env.items()
+            })
+
     def __repr__(self) -> str:
         return f"<DotEnv data={self.__env}>"
 
-    def __getitem__(self, key: str) -> Any:
+    def __getitem__(self, key: str) -> Any:  # noqa: ANN401
         if self.__handle_key_not_found:
             return self.__env.get(key, None)
         return self.__env[key]
@@ -73,6 +90,19 @@ class DotEnv:
     def __iter__(self) -> Iterator[Tuple[str, Any]]:
         return iter(self.__env.items())
 
+    def __contains__(self, key: str) -> bool:
+        return key in self.__env
+
+    def __setitem__(self, key: str, value: Any) -> None:  # noqa: ANN401
+        if self.__frozen:
+            raise AttributeError("This DotEnv object is read-only.")
+        self.__env[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        if self.__frozen:
+            raise AttributeError("This DotEnv object is read-only.")
+        del self.__env[key]
+
     @property
     def keys(self) -> List[str]:
         """ `list[str]`: Returns a list of the keys. """
@@ -83,7 +113,7 @@ class DotEnv:
         """ `list[Any]`: Returns a list of the values. """
         return list(self.__env.values())
 
-    def get(self, key: str, default: Any = None) -> Any:
+    def get(self, key: str, default: Any = None) -> Any:  # noqa: ANN401
         """ `Any`: Return the value for key if key is in the dictionary, else default. """
         return self.__env.get(key, default)
 
@@ -102,6 +132,7 @@ class DotEnv:
     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.
 
@@ -112,22 +143,24 @@ class DotEnv:
         `ParsingError`
             If one of the values cannot be parsed.
         """
-        with open(self.__path, "r", encoding="utf-8") as f:
-            data: List[str] = f.readlines()
+        with open(self.__path, encoding="utf-8") as f:
+            data: list[str] = f.readlines()
 
-        for line in data:
+        for line_no, line in enumerate(data, start=1):
             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}'")
+            find_kv = self.__re_keyvar.search(line)
+            if not find_kv:
+                raise ParsingError(
+                    f"Error at line {line_no}: "
+                    f"Expected key=value format, got '{line}'"
+                )
 
-            key, value = _find_kv.groups()
-            _force_string = False
+            key, value = find_kv.groups()
 
             # Replace any variables in the value
             value = self.__re_var_call.sub(
@@ -135,29 +168,30 @@ class DotEnv:
                 str(value)
             )
 
-            # Remove quotes, but mark it as forced string from now
+            # Remove comment on the value itself too (if any)
+            value = value.split("#")[0].strip()
+
             if (
                 value.startswith(self.__quotes) and
                 value.endswith(self.__quotes)
             ):
+                # Remove quotes and skip the parsing step
                 value = value[1:-1]
-                _force_string = True
-
-            if not _force_string:
 
+            else:
+                # String is not forced, go ahead and parse it
                 if self.__re_isdigit.search(value):
                     value = int(value)
 
                 elif self.__re_isfloat.search(value):
                     value = float(value)
 
-                elif value.lower() in ("true", "false"):
+                elif value.lower() in self.__bools:
                     value = value.lower() == "true"
 
-                elif value.lower() in ("null", "none", "nil", "undefined"):
+                elif value.lower() in self.__none:
                     value = None
 
-                else:
-                    value = value
-
             self.__env[key] = value
+
+        self.__frozen = True

{dotenvplus-0.0.2 → dotenvplus-0.0.4}/dotenvplus.egg-info/PKG-INFO

@@ -1,25 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dotenvplus
-Version: 0.0.2
-Summary: Python library that handles interactions from Discord POST requests.
+Version: 0.0.4
+Summary: Reads key-value pairs from a .env file and supports multiple values with dynamic interpolation.
 Author-email: AlexFlipnote <root@alexflipnote.dev>
 License: MIT
 Project-URL: Homepage, https://github.com/AlexFlipnote/dotenvplus
 Project-URL: Repository, https://github.com/AlexFlipnote/dotenvplus
 Keywords: dotenv,env,config,environment,variables,key-value,parser
-Requires-Python: >=3.6.0
+Requires-Python: >=3.7.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: pyright; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
+Requires-Dist: ruff; 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
+# 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.
@@ -28,7 +28,7 @@ Some of the usual dictionary methods are also supported like `.items()`, `.keys(
 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.
+> You need **Python >=3.7** to use this library.
 
 ```bash
 pip install dotenvplus

{dotenvplus-0.0.2 → dotenvplus-0.0.4}/dotenvplus.egg-info/requires.txt

@@ -1,7 +1,7 @@
 
 [dev]
 pyright
-flake8
+ruff
 toml
 
 [maintainer]

dotenvplus-0.0.4/pyproject.toml

@@ -0,0 +1,167 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pdm.source]
+name = "public"
+url = "https://github.com/AlexFlipnote/dotenvplus"
+
+[project]
+name = "dotenvplus"
+description = "Reads key-value pairs from a .env file and supports multiple values with dynamic interpolation."
+requires-python = ">=3.7.0"
+license = {text = "MIT"}
+
+dynamic = ["version"]
+readme = "README.md"
+keywords = ["dotenv", "env", "config", "environment", "variables", "key-value", "parser"]
+authors = [{name = "AlexFlipnote", email = "root@alexflipnote.dev"}]
+
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/AlexFlipnote/dotenvplus"
+Repository = "https://github.com/AlexFlipnote/dotenvplus"
+
+[project.optional-dependencies]
+dev = ["pyright", "ruff", "toml"]
+maintainer = ["twine", "wheel", "build"]
+
+[tool.setuptools]
+packages = [
+  "dotenvplus",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "dotenvplus.__version__"}
+readme = {file = ["README.md"]}
+
+[tool.ruff]
+target-version = "py37"
+indent-width = 4
+line-length = 256  # Debating to change this.. not sure yet
+output-format = "concise"
+
+# Files to include/exclude
+include = [
+  "dotenvplus/*",
+]
+exclude = [
+  "**/__pycache__",
+  "**/*.pyc",
+  "*.egg-info",
+  ".venv",
+  "build",
+  "docs",
+  "dist",
+  "tests",
+  "examples",
+]
+
+[tool.ruff.lint]
+select = [
+  "A",     # flake8-builtins
+  "ANN",   # Annotations
+  "ARG",   # flake8-unused-arguments
+  "B",     # flake8-bugbear
+  "D",     # pydocstyle
+  "DTZ",   # flake8-datetimez
+  "E",     # Error
+  "ERA",   # eradicate
+  "F",     # Pyflakes
+  "FIX",   # flake8-fixme
+  "FLY",   # flynt
+  "FURB",  # refurb
+  "ICN",   # flake8-import-conventions
+  "ISC",   # flake8-implicit-str-concat
+  "N",     # pep8-naming
+  "PIE",   # flake8-pie
+  "PLE",   # Pylint Errors
+  "PLW",   # Pylint Warnings
+  "Q",     # flake8-quotes
+  "RET",   # flake8-return
+  "RUF",   # Ruff-specific rules
+  "SIM",   # flake8-simplify
+  "T",     # flake8-print
+  "TC",    # type-checking
+  "UP",    # pyupgrade
+  "W",     # Warning
+]
+
+extend-select = ["W", "E"]
+preview = true
+
+ignore = [
+  # Docstring: function
+  "D100",  # docstring in public module
+  "D104",  # Missing docstring in public package
+  "D203",  # 1 blank line required before class docstring
+  "D204",  # 1 blank line required after class docstring
+  "D210",  # No whitespaces surrounding docstring text
+  "D212",  # Multi-line docstring start at first line
+  "D400",  # Strictly must end with a period
+  "D401",  # First line should be in imperative mood
+  "D413",  # Missing blank line after last section
+  "D416",  # Section name should end with a colon
+
+  # Annotations
+  "ANN003",  # Missing type annotation for **kwargs
+  "ANN204",  # Missing for __init__ method
+
+  # Type-checking
+  "TC001", "TC002", "TC003", "TC004",  # Moving imports
+
+  # Docstring: Missing docs
+  "D101",  # class
+  "D105",  # magic method docstring required (__str__, __int__, etc)
+  "D107",  # __init__ docstring required
+
+  # Except cases
+  "B904",  # raise in except
+
+  # Simplify
+  "SIM105",  # Use contextlib.suppress
+  "SIM114",  # Merge if-else to one-liner
+
+  # Refurb
+  "FURB101",  # read-whole-file
+  "FURB103",  # write-whole-file
+
+  # Pylint Warnings
+  "PLW2901",  # Overwrite loop control variable
+
+  # Type hints
+  "UP037",  # type hints with quotes
+
+  # Variable shadowing
+  "A005",  # Files
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
+
+[tool.pyright]
+reportOptionalOperand = "none"
+reportOptionalSubscript = "none"
+reportOptionalMemberAccess = "none"
+reportUnnecessaryTypeIgnoreComment = "warning"
+typeCheckingMode = "basic"
+pythonVersion = "3.7"
+
+include = [
+  "dotenvplus/*",
+]
+
+exclude = [
+  "**/__pycache__",
+  "**/*.pyc",
+  "*.egg-info",
+  ".venv",
+  "build",
+  "docs",
+  "dist",
+  "tests",
+  "examples",
+]

{dotenvplus-0.0.2 → dotenvplus-0.0.4}/tests/test_usage.py

@@ -11,9 +11,11 @@ class TestDotEnv(unittest.TestCase):
             "# Comment line\n"
             "STRING_KEY=HelloWorld\n"
             "INT_KEY=1234\n"
+            "STR_INT_KEY='1234'\n"
             "FLOAT_KEY=12.34\n"
             "BOOL_TRUE_KEY=true\n"
             "BOOL_FALSE_KEY=false\n"
+            "COMMENT_KEY=comment # Comment here\n"
             "NULL_KEY=null\n"
             "NONE_KEY=none\n"
             "NIL_KEY=nil\n"
@@ -35,6 +37,7 @@ class TestDotEnv(unittest.TestCase):
         self.assertIsInstance(dotenv, DotEnv)
         self.assertIsInstance(dotenv.get("STRING_KEY"), str)
         self.assertIsInstance(dotenv.get("INT_KEY"), int)
+        self.assertIsInstance(dotenv.get("STR_INT_KEY"), str)
         self.assertIsInstance(dotenv.get("FLOAT_KEY"), float)
         self.assertIsInstance(dotenv.get("BOOL_TRUE_KEY"), bool)
         self.assertIsInstance(dotenv.get("BOOL_FALSE_KEY"), bool)
@@ -42,6 +45,14 @@ class TestDotEnv(unittest.TestCase):
         self.assertIsInstance(dotenv.get("NONE_KEY"), type(None))
         self.assertIsInstance(dotenv.get("NIL_KEY"), type(None))
 
+    def test_comment_removed(self):
+        dotenv = DotEnv(self.file_path)
+        self.assertNotIn("#", dotenv.get("COMMENT_KEY"))
+
+    def test_key_in_env(self):
+        dotenv = DotEnv(self.file_path)
+        self.assertIn("STRING_KEY", dotenv)
+
     def test_raises_error_on_missing_file(self):
         with self.assertRaises(FileNotFoundError):
             DotEnv("missing_file.env")

dotenvplus-0.0.2/pyproject.toml

@@ -1,62 +0,0 @@
-[build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[tool.pdm.source]
-name = "public"
-url = "https://github.com/AlexFlipnote/dotenvplus"
-
-[project]
-name = "dotenvplus"
-description = "Python library that handles interactions from Discord POST requests."
-requires-python = ">=3.6.0"
-license = {text = "MIT"}
-
-dynamic = ["version"]
-readme = "README.md"
-keywords = ["dotenv", "env", "config", "environment", "variables", "key-value", "parser"]
-authors = [{name = "AlexFlipnote", email = "root@alexflipnote.dev"}]
-
-dependencies = []
-
-[project.urls]
-Homepage = "https://github.com/AlexFlipnote/dotenvplus"
-Repository = "https://github.com/AlexFlipnote/dotenvplus"
-
-[project.optional-dependencies]
-dev = ["pyright", "flake8", "toml"]
-maintainer = ["twine", "wheel", "build"]
-
-[tool.setuptools]
-packages = [
-  "dotenvplus",
-]
-
-[tool.setuptools.dynamic]
-version = {attr = "dotenvplus.__version__"}
-readme = {file = ["README.md"]}
-
-[tool.flake8]
-max-line-length = 128
-ignore = [
-  "D210", "D400", "D401", "D100", "D202", "D413", "D107",
-  "D101", "D103", "D102", "E121", "D205", "D209", "D105",
-  "E252", "W605", "W504", "E128", "E124", "E999", "W504"
-]
-
-[tool.pyright]
-reportOptionalOperand = "none"
-reportOptionalSubscript = "none"
-reportOptionalMemberAccess = "none"
-reportUnnecessaryTypeIgnoreComment = "warning"
-typeCheckingMode = "basic"
-pythonVersion = "3.6"
-
-include = [
-  "dotenvplus",
-]
-
-exclude = [
-  "**/__pycache__", "**/*.pyc", "*.egg-info",
-  ".venv", "build", "docs", "dist",
-]