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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hatch-env-plus
-Version: 0.1.0
+Version: 1.0.0
 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
@@ -28,7 +28,7 @@ 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 environment variable version source does not allow to define a fallback.
+since the built-in `env` version source does not allow to define a fallback.
 
 ## Installation
 
@@ -57,13 +57,17 @@ Then, configure the version source:
 [tool.hatch.version]
 source = "env-plus"
 variable = "PACKAGE_VERSION"  # optional, default shown
-fallback = "0.0.0dev0"            # optional, default shown
+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. 
+Use the `variable` field to set the environment variable to use, and set `fallback` to the desired fallback version.
 
-**Note: An empty version string is treated as undefined. Therefore, this will throw an error if the configured environment
-variable as well as the fallback are both empty.**
+**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`.  
 
 ## Usage
 

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

@@ -1,7 +1,7 @@
 # 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 environment variable version source does not allow to define a fallback.
+since the built-in `env` version source does not allow to define a fallback.
 
 ## Installation
 
@@ -30,13 +30,17 @@ Then, configure the version source:
 [tool.hatch.version]
 source = "env-plus"
 variable = "PACKAGE_VERSION"  # optional, default shown
-fallback = "0.0.0dev0"            # optional, default shown
+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. 
+Use the `variable` field to set the environment variable to use, and set `fallback` to the desired fallback version.
 
-**Note: An empty version string is treated as undefined. Therefore, this will throw an error if the configured environment
-variable as well as the fallback are both empty.**
+**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`.  
 
 ## Usage
 

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

@@ -24,8 +24,7 @@ classifiers = [
     "Framework :: Hatch",
 ]
 dependencies = [
-    # Package dependencies go here, e.g.
-    # "pandas>=1,<3",
+    # Package dependencies go here.
 ]
 
 [project.urls]
@@ -42,7 +41,7 @@ dev = [
 ]
 
 [build-system]
-requires = ["hatchling>=1.21.1"]
+requires = ["hatchling>=1.21.1", "hatch-env-plus>=0.1.0"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.sdist]
@@ -60,8 +59,7 @@ sources = ["src"]
 only-include = ["src/hatch_env_plus"]
 
 [tool.hatch.version]
-source = "env"
-variable = "PACKAGE_VERSION"
+source = "env-plus"
 
 [tool.pytest.ini_options]
 addopts = "--cov=hatch_env_plus --cov-report=term-missing --cov-report=html"

{hatch_env_plus-0.1.0 → hatch_env_plus-1.0.0}/src/hatch_env_plus/plugin.py

@@ -8,7 +8,7 @@ class EnvironmentVariableVersionSource(VersionSourceInterface):
 
     def get_version_data(self) -> dict:
         variable = self.config.get('variable', 'PACKAGE_VERSION')
-        fallback = self.config.get('fallback', '0.0.0dev0')
+        fallback = self.config.get('fallback', '0.0.0dev0') or None
         version = os.environ.get(variable, fallback)
         return {'version': version}
 

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

@@ -1,5 +1,3 @@
-import os
-
 import pytest
 
 from hatchling.version.source.plugin.interface import VersionSourceInterface
@@ -63,3 +61,12 @@ def test_env_var_takes_precedence_over_fallback():
         # Set - uses env var
         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': ''})
+    with pytest.MonkeyPatch().context() as m:
+        m.delenv('PACKAGE_VERSION', raising=False)
+        data = plugin.get_version_data()
+    assert data == {'version': None}