refactor: rename _has_provider to _has_feature_key for better generalization

Author: chalmerlowe

packages/google-api-core/google/api_core/_feature_gating_helpers.py

@@ -57,7 +57,7 @@ def _get_env_bool(name: str) -> bool | None:
         return None
 
 
-def _has_provider(
+def _has_feature_key(
     *, configuration: ClientOptions | dict[str, Any] | None, feature_key: str
 ) -> bool:
     """Checks if a specific feature key is present and not None in configuration."""
@@ -104,8 +104,8 @@ def resolve_feature_flags(
         ValueError: If a provider is provided for an experimental feature without enabling the experimental environment variable.
     """
 
-    # Check for programmatic feature provider
-    has_provider = _has_provider(
+    # Check for programmatic feature configuration
+    has_feature = _has_feature_key(
         configuration=configuration, feature_key=feature_key
     )
 
@@ -117,8 +117,8 @@ def resolve_feature_flags(
     #   1. EXPERIMENTAL Environment Variable
     #   2. Fail Fast if Provider present but EXPERIMENTAL Environment Variable is not enabled
     if "EXPERIMENTAL" in env_var:
-        # Fail Fast if provider present but experimental environment variable is not enabled
-        if env_var_setting is not True and has_provider:
+        # Fail Fast if feature key present but experimental environment variable is not enabled
+        if env_var_setting is not True and has_feature:
             raise FeatureGatingError(
                 f"Experimental feature requires {env_var} to be set to 'true' to use programmatic providers."
             )
@@ -127,11 +127,11 @@ def resolve_feature_flags(
 
     # GENERAL AVAILABILITY PATH:
     # Resolution Hierarchy:
-    #   1. Programmatic Provider
+    #   1. Programmatic Configuration (Feature Key)
     #   2. Environment Variable
 
-    # Check Programmatic Provider
-    if has_provider:
+    # Check Programmatic Configuration
+    if has_feature:
         return True
 
     # Check Environment Variable

packages/google-api-core/tests/unit/test_feature_gating_helpers.py

@@ -84,10 +84,10 @@ def test_resolve_feature_flags_ga_enabled_via_env(monkeypatch):
 
 
 @pytest.mark.parametrize("exp_env_state", [None, "false"], ids=["missing", "disabled"])
-def test_resolve_feature_flags_exp_blocked_with_provider_fails_fast(
+def test_resolve_feature_flags_exp_blocked_with_feature_key_fails_fast(
     monkeypatch, exp_env_state
 ):
-    """Verify that passing a provider to an experimental feature raises ValueError if the experimental environment variable is disabled or missing."""
+    """Verify that passing a feature_key to an experimental feature raises FeatureGatingError if the experimental environment variable is disabled or missing."""
     # Setup: Experimental env var is set to exp_env_state (None means not set)
     if exp_env_state is not None:
         monkeypatch.setenv(
@@ -108,8 +108,8 @@ def test_resolve_feature_flags_exp_blocked_with_provider_fails_fast(
         )
 
 
-def test_resolve_feature_flags_exp_enabled_with_provider(monkeypatch):
-    """Verify that experimental feature is enabled if the experimental environment variable is enabled and a provider is provided."""
+def test_resolve_feature_flags_exp_enabled_with_feature_key(monkeypatch):
+    """Verify that experimental feature is enabled if the experimental environment variable is enabled and a feature_key is provided."""
     monkeypatch.setenv("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", "true")
     configuration = {"tracer_provider": object()}
 
@@ -121,8 +121,8 @@ def test_resolve_feature_flags_exp_enabled_with_provider(monkeypatch):
     assert result is True
 
 
-def test_resolve_feature_flags_exp_enabled_without_provider(monkeypatch):
-    """Verify that experimental feature is enabled if the experimental environment variable is enabled and NO provider is provided."""
+def test_resolve_feature_flags_exp_enabled_without_feature_key(monkeypatch):
+    """Verify that experimental feature is enabled if the experimental environment variable is enabled and NO feature_key is provided."""
     monkeypatch.setenv("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", "true")
 
     result = _feature_gating_helpers.resolve_feature_flags(
@@ -133,8 +133,8 @@ def test_resolve_feature_flags_exp_enabled_without_provider(monkeypatch):
     assert result is True
 
 
-def test_resolve_feature_flags_exp_disabled_without_provider(monkeypatch):
-    """Verify that experimental feature is disabled if the experimental environment variable is disabled and NO provider is provided."""
+def test_resolve_feature_flags_exp_disabled_without_feature_key(monkeypatch):
+    """Verify that experimental feature is disabled if the experimental environment variable is disabled and NO feature_key is provided."""
     monkeypatch.setenv("GOOGLE_SDK_EXPERIMENTAL_PYTHON_TRACING_ENABLED", "false")
 
     result = _feature_gating_helpers.resolve_feature_flags(
@@ -145,9 +145,9 @@ def test_resolve_feature_flags_exp_disabled_without_provider(monkeypatch):
     assert result is False
 
 
-def test_resolve_feature_flags_ga_enabled_via_provider(monkeypatch):
-    """Verify that a GA feature is enabled if a provider is provided, ignoring the environment variable."""
-    # Env var is False, but provider is present
+def test_resolve_feature_flags_ga_enabled_via_feature_key(monkeypatch):
+    """Verify that a GA feature is enabled if a feature_key is provided, ignoring the environment variable."""
+    # Env var is False, but feature_key is present in configuration
     monkeypatch.setenv("GOOGLE_SDK_PYTHON_TRACING_ENABLED", "false")
     configuration = {"tracer_provider": object()}
 
@@ -163,7 +163,7 @@ def test_resolve_feature_flags_ga_enabled_via_provider(monkeypatch):
     "env_val", [None, "false"], ids=["env_not_set", "env_explicit_false"]
 )
 def test_resolve_feature_flags_ga_fallback_to_false(monkeypatch, env_val):
-    """Verify that a GA feature is disabled if neither a provider is provided nor the environment variable is enabled."""
+    """Verify that a GA feature is disabled if neither a feature_key is provided nor the environment variable is enabled."""
     if env_val is not None:
         monkeypatch.setenv("GOOGLE_SDK_PYTHON_TRACING_ENABLED", env_val)
     else:
@@ -190,7 +190,7 @@ def __init__(self):
     ids=["dict_without_key", "object_without_key"],
 )
 def test_resolve_feature_flags_options_without_key(configuration):
-    """Verify behavior when configuration is present but missing the provider key."""
+    """Verify behavior when configuration is present but missing the feature key."""
     # GA Path: should fall through to env var / fallback
     result = _feature_gating_helpers.resolve_feature_flags(
         env_var="GOOGLE_SDK_PYTHON_TRACING_ENABLED",
@@ -201,7 +201,7 @@ def test_resolve_feature_flags_options_without_key(configuration):
 
 
 def test_resolve_feature_flags_rejects_dunder_keys(monkeypatch):
-    """Verify that dunder keys are rejected early in _has_provider."""
+    """Verify that dunder keys are rejected early in _has_feature_key."""
     # We use a dunder key that exists on all objects (__class__)
     # If the guardrail is missing, getattr might return it and return True
     configuration = {"__class__": "some_value"}