hatch-env-plus 1.0.0__tar.gz → 1.0.1__tar.gz

{hatch_env_plus-1.0.0 → hatch_env_plus-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hatch-env-plus
-Version: 1.0.0
+Version: 1.0.1
 Summary: A version source for Hatchling that reads the version from a given environment variable, but also allows for a fallback if the variable is not populated.
 Project-URL: homepage, https://github.com/jenskeiner/hatch_env_plus/
 Project-URL: repository, https://github.com/jenskeiner/hatch_env_plus.git
@@ -27,8 +27,9 @@ Description-Content-Type: text/markdown
 
 # Hatchling Environment Variable Version Source
 
-A Hatchling version source plugin that reads the version from an environment variable with a configurable fallback value,
-since the built-in `env` version source does not allow to define a fallback.
+A [Hatchling](https://github.com/pypa/hatch) version source plugin that reads the version from an environment variable
+with a configurable fallback value, since the built-in [`env`](https://hatch.pypa.io/latest/plugins/version-source/env/)
+version source does not allow to define a fallback.
 
 ## Installation
 
@@ -62,12 +63,13 @@ fallback = "0.0.0dev0"  # optional, default shown
 
 Use the `variable` field to set the environment variable to use, and set `fallback` to the desired fallback version.
 
-**Note: An empty string, whether from the configured environment variable or from the fallback, is an 
+**Note: An empty string, whether from the configured environment variable or from the fallback, is an
 undefined version.**
 
 If you explicitly set the configured environment variable to the empty string, your build will fail as no valid version
-is set. If you explicitly set `fallback` to an empty string, your build will fail when the configured environment 
-variable is not set. This is the default behavior of Hatchling's built-in enviroment variable version source `env`.  
+is set. If you explicitly set `fallback` to an empty string, your build will fail when the configured environment
+variable is not set. This is the default behavior of [Hatchling]([Hatchling](https://github.com/pypa/hatch))'s built-in
+enviroment variable version source [`env`](https://hatch.pypa.io/latest/plugins/version-source/env/).
 
 ## Usage
 

{hatch_env_plus-1.0.0 → hatch_env_plus-1.0.1}/README.md

@@ -1,7 +1,8 @@
 # Hatchling Environment Variable Version Source
 
-A Hatchling version source plugin that reads the version from an environment variable with a configurable fallback value,
-since the built-in `env` version source does not allow to define a fallback.
+A [Hatchling](https://github.com/pypa/hatch) version source plugin that reads the version from an environment variable
+with a configurable fallback value, since the built-in [`env`](https://hatch.pypa.io/latest/plugins/version-source/env/)
+version source does not allow to define a fallback.
 
 ## Installation
 
@@ -35,12 +36,13 @@ fallback = "0.0.0dev0"  # optional, default shown
 
 Use the `variable` field to set the environment variable to use, and set `fallback` to the desired fallback version.
 
-**Note: An empty string, whether from the configured environment variable or from the fallback, is an 
+**Note: An empty string, whether from the configured environment variable or from the fallback, is an
 undefined version.**
 
 If you explicitly set the configured environment variable to the empty string, your build will fail as no valid version
-is set. If you explicitly set `fallback` to an empty string, your build will fail when the configured environment 
-variable is not set. This is the default behavior of Hatchling's built-in enviroment variable version source `env`.  
+is set. If you explicitly set `fallback` to an empty string, your build will fail when the configured environment
+variable is not set. This is the default behavior of [Hatchling]([Hatchling](https://github.com/pypa/hatch))'s built-in
+enviroment variable version source [`env`](https://hatch.pypa.io/latest/plugins/version-source/env/).
 
 ## Usage
 

{hatch_env_plus-1.0.0 → hatch_env_plus-1.0.1}/pyproject.toml

@@ -1,3 +1,7 @@
+[build-system]
+requires = ["hatchling>=1.21.1", "hatch-env-plus>=1.0.0"]
+build-backend = "hatchling.build"
+
 [project]
 name = "hatch-env-plus"
 dynamic = ["version"]
@@ -40,10 +44,6 @@ dev = [
     "pytest-cov>=7,<8",
 ]
 
-[build-system]
-requires = ["hatchling>=1.21.1", "hatch-env-plus>=0.1.0"]
-build-backend = "hatchling.build"
-
 [tool.hatch.build.targets.sdist]
 include = [
   "src/hatch_env_plus/**",

hatch_env_plus-1.0.1/src/hatch_env_plus/plugin.py

@@ -0,0 +1,16 @@
+import os
+
+from hatchling.version.source.plugin.interface import VersionSourceInterface
+
+
+class EnvironmentVariableVersionSource(VersionSourceInterface):
+    PLUGIN_NAME = "env-plus"
+
+    def get_version_data(self) -> dict:
+        variable = self.config.get("variable", "PACKAGE_VERSION")
+        fallback = self.config.get("fallback", "0.0.0dev0") or None
+        version = os.environ.get(variable, None) or fallback
+        return {"version": version}
+
+    def set_version(self, version: str, version_data: dict) -> None:
+        version_data["version"] = version

{hatch_env_plus-1.0.0 → hatch_env_plus-1.0.1}/tests/test_plugin.py

@@ -9,64 +9,73 @@ def test_plugin_is_version_source():
 
 
 def test_plugin_name():
-    assert EnvironmentVariableVersionSource.PLUGIN_NAME == 'env-plus'
+    assert EnvironmentVariableVersionSource.PLUGIN_NAME == "env-plus"
 
 
 def test_version_from_env_var():
     """Version is read from environment variable when set."""
-    plugin = EnvironmentVariableVersionSource('', {})
+    plugin = EnvironmentVariableVersionSource("", {})
     with pytest.MonkeyPatch().context() as m:
-        m.setenv('PACKAGE_VERSION', '2.0.0')
+        m.setenv("PACKAGE_VERSION", "2.0.0")
         data = plugin.get_version_data()
-    assert data == {'version': '2.0.0'}
+    assert data == {"version": "2.0.0"}
 
 
 def test_fallback_when_env_var_not_set():
     """Fallback value is used when environment variable is not set."""
-    plugin = EnvironmentVariableVersionSource('', {})
+    plugin = EnvironmentVariableVersionSource("", {})
     with pytest.MonkeyPatch().context() as m:
-        m.delenv('PACKAGE_VERSION', raising=False)
+        m.delenv("PACKAGE_VERSION", raising=False)
         data = plugin.get_version_data()
-    assert data == {'version': '0.0.0dev0'}
+    assert data == {"version": "0.0.0dev0"}
+
+
+def test_fallback_when_env_var_empty_string():
+    """Fallback value is used when environment variable is set to the empty string."""
+    plugin = EnvironmentVariableVersionSource("", {})
+    with pytest.MonkeyPatch().context() as m:
+        m.setenv("PACKAGE_VERSION", "")
+        data = plugin.get_version_data()
+    assert data == {"version": "0.0.0dev0"}
 
 
 def test_custom_env_var_name():
     """Custom environment variable name is respected."""
-    plugin = EnvironmentVariableVersionSource('', {'variable': 'MY_VERSION'})
+    plugin = EnvironmentVariableVersionSource("", {"variable": "MY_VERSION"})
     with pytest.MonkeyPatch().context() as m:
-        m.setenv('MY_VERSION', '3.5.0')
+        m.setenv("MY_VERSION", "3.5.0")
         data = plugin.get_version_data()
-    assert data == {'version': '3.5.0'}
+    assert data == {"version": "3.5.0"}
 
 
 def test_custom_fallback_value():
     """Custom fallback value is used when configured."""
-    plugin = EnvironmentVariableVersionSource('', {'fallback': '1.0.0'})
+    plugin = EnvironmentVariableVersionSource("", {"fallback": "1.0.0"})
     with pytest.MonkeyPatch().context() as m:
-        m.delenv('PACKAGE_VERSION', raising=False)
+        m.delenv("PACKAGE_VERSION", raising=False)
         data = plugin.get_version_data()
-    assert data == {'version': '1.0.0'}
+    assert data == {"version": "1.0.0"}
 
 
 def test_env_var_takes_precedence_over_fallback():
     """Environment variable takes precedence over fallback when both are set."""
     plugin = EnvironmentVariableVersionSource(
-        '', {'variable': 'CUSTOM_VER', 'fallback': '0.1.0'}
+        "", {"variable": "CUSTOM_VER", "fallback": "0.1.0"}
     )
     with pytest.MonkeyPatch().context() as m:
         # Not set - uses fallback
-        m.delenv('CUSTOM_VER', raising=False)
-        assert plugin.get_version_data() == {'version': '0.1.0'}
+        m.delenv("CUSTOM_VER", raising=False)
+        assert plugin.get_version_data() == {"version": "0.1.0"}
 
         # Set - uses env var
-        m.setenv('CUSTOM_VER', '5.0.0')
-        assert plugin.get_version_data() == {'version': '5.0.0'}
+        m.setenv("CUSTOM_VER", "5.0.0")
+        assert plugin.get_version_data() == {"version": "5.0.0"}
 
 
 def test_empty_fallback_string_treated_as_none():
     """Empty fallback string is converted to None."""
-    plugin = EnvironmentVariableVersionSource('', {'fallback': ''})
+    plugin = EnvironmentVariableVersionSource("", {"fallback": ""})
     with pytest.MonkeyPatch().context() as m:
-        m.delenv('PACKAGE_VERSION', raising=False)
+        m.delenv("PACKAGE_VERSION", raising=False)
         data = plugin.get_version_data()
-    assert data == {'version': None}
+    assert data == {"version": None}

hatch_env_plus-1.0.0/src/hatch_env_plus/plugin.py

@@ -1,16 +0,0 @@
-import os
-
-from hatchling.version.source.plugin.interface import VersionSourceInterface
-
-
-class EnvironmentVariableVersionSource(VersionSourceInterface):
-    PLUGIN_NAME = 'env-plus'
-
-    def get_version_data(self) -> dict:
-        variable = self.config.get('variable', 'PACKAGE_VERSION')
-        fallback = self.config.get('fallback', '0.0.0dev0') or None
-        version = os.environ.get(variable, fallback)
-        return {'version': version}
-
-    def set_version(self, version: str, version_data: dict) -> None:
-        version_data['version'] = version