rename env_vars argument to override_env_vars, update corresponding comments

Author: THardy98

temporalio/envconfig.py

@@ -251,7 +251,7 @@ def load(
         disable_file: bool = False,
         disable_env: bool = False,
         config_file_strict: bool = False,
-        env_vars: Optional[Mapping[str, str]] = None,
+        override_env_vars: Optional[Mapping[str, str]] = None,
     ) -> ClientConfigProfile:
         """Load a single client profile from given sources, applying env
         overrides.
@@ -267,13 +267,14 @@ def load(
             disable_file: If true, file loading is disabled. This is only used
                 when ``config_source`` is not present.
             disable_env: If true, environment variable loading and overriding
-                is disabled. This takes precedence over the ``env_vars``
+                is disabled. This takes precedence over the ``override_env_vars``
                 parameter.
             config_file_strict: If true, will error on unrecognized keys.
-            env_vars: The environment to use for loading and overrides. If not
-                provided, environment variables are not used for overrides. To
-                use the current process's environment, :py:attr:`os.environ` can be
-                passed explicitly.
+            override_env_vars: The environment to use for loading and overrides.
+                If not provided, the current process's environment is used. To
+                use a specific set of environment variables, provide them here.
+                To disable environment variable loading, set ``disable_env`` to
+                true.
 
         Returns:
             The client configuration profile.
@@ -287,7 +288,7 @@ def load(
             disable_file=disable_file,
             disable_env=disable_env,
             config_file_strict=config_file_strict,
-            env_vars=env_vars,
+            env_vars=override_env_vars,
         )
         return ClientConfigProfile.from_dict(raw_profile)
 
@@ -331,7 +332,7 @@ def load(
         config_source: Optional[DataSource] = None,
         disable_file: bool = False,
         config_file_strict: bool = False,
-        env_vars: Optional[Mapping[str, str]] = None,
+        override_env_vars: Optional[Mapping[str, str]] = None,
     ) -> ClientConfig:
         """Load all client profiles from given sources.
 
@@ -348,11 +349,12 @@ def load(
                 when ``config_source`` is not present.
             config_file_strict: If true, will TOML file parsing will error on
                 unrecognized keys.
-            env_vars: The environment variables to use for locating the default config
-                file. If not provided, ``TEMPORAL_CONFIG_FILE`` is not checked
-                and only the default path is used (e.g. ``~/.config/temporalio/temporal.toml``).
-                To use the current process's environment, :py:attr:`os.environ` can be passed
-                explicitly.
+            override_env_vars: The environment variables to use for locating the
+                default config file. If not provided, the current process's
+                environment is used to check for ``TEMPORAL_CONFIG_FILE``. To
+                use a specific set of environment variables, provide them here.
+                To disable environment variable loading, set ``disable_file`` to
+                true or pass an empty dictionary for this parameter.
         """
         path, data = _source_to_path_and_data(config_source)
 
@@ -361,7 +363,7 @@ def load(
             data=data,
             disable_file=disable_file,
             config_file_strict=config_file_strict,
-            env_vars=env_vars,
+            env_vars=override_env_vars,
         )
         return ClientConfig.from_dict(loaded_profiles)
 
@@ -392,7 +394,10 @@ def load_client_connect_config(
             config_file_strict: If true, will error on unrecognized keys in the
                 TOML file.
             override_env_vars: A dictionary of environment variables to use for
-                loading and overrides.
+                loading and overrides. If not provided, the current process's
+                environment is used. To use a specific set of environment
+                variables, provide them here. To disable environment variable
+                loading, set ``disable_env`` to true.
 
         Returns:
             TypedDict of keyword arguments for
@@ -408,6 +413,6 @@ def load_client_connect_config(
             disable_file=disable_file,
             disable_env=disable_env,
             config_file_strict=config_file_strict,
-            env_vars=override_env_vars,
+            override_env_vars=override_env_vars,
         )
         return prof.to_client_connect_config()

tests/test_envconfig.py

@@ -138,7 +138,7 @@ def test_load_profile_from_data_env_overrides():
         "TEMPORAL_NAMESPACE": "env-namespace",
     }
     profile = ClientConfigProfile.load(
-        config_source=TOML_CONFIG_BASE, profile="custom", env_vars=env
+        config_source=TOML_CONFIG_BASE, profile="custom", override_env_vars=env
     )
     assert profile.address == "env-address"
     assert profile.namespace == "env-namespace"
@@ -156,7 +156,7 @@ def test_load_profile_env_overrides(base_config_file: Path):
         "TEMPORAL_TLS_SERVER_NAME": "env-server-name",
     }
     profile = ClientConfigProfile.load(
-        config_source=base_config_file, profile="custom", env_vars=env
+        config_source=base_config_file, profile="custom", override_env_vars=env
     )
     assert profile.address == "env-address"
     assert profile.namespace == "env-namespace"
@@ -181,7 +181,7 @@ def test_load_profile_grpc_meta_env_overrides(base_config_file: Path):
         "TEMPORAL_GRPC_META_ANOTHER_HEADER": "another-value",
     }
     profile = ClientConfigProfile.load(
-        config_source=base_config_file, profile="custom", env_vars=env
+        config_source=base_config_file, profile="custom", override_env_vars=env
     )
     assert profile.grpc_meta["custom-header"] == "env-value"
     assert profile.grpc_meta["another-header"] == "another-value"
@@ -197,7 +197,7 @@ def test_load_profile_disable_env(base_config_file: Path):
     """Test that `disable_env` prevents environment variable overrides."""
     env = {"TEMPORAL_ADDRESS": "env-address"}
     profile = ClientConfigProfile.load(
-        config_source=base_config_file, env_vars=env, disable_env=True
+        config_source=base_config_file, override_env_vars=env, disable_env=True
     )
     assert profile.address == "default-address"
 
@@ -209,7 +209,7 @@ def test_load_profile_disable_file(monkeypatch):
     """Test that `disable_file` loads configuration only from environment."""
     monkeypatch.setattr("pathlib.Path.exists", lambda _: False)
     env = {"TEMPORAL_ADDRESS": "env-address"}
-    profile = ClientConfigProfile.load(disable_file=True, env_vars=env)
+    profile = ClientConfigProfile.load(disable_file=True, override_env_vars=env)
     assert profile.address == "env-address"
 
     config = profile.to_client_connect_config()
@@ -263,7 +263,7 @@ def test_load_profiles_no_env_override(tmp_path: Path, monkeypatch):
         "TEMPORAL_CONFIG_FILE": str(config_file),
         "TEMPORAL_ADDRESS": "env-address",  # This should be ignored
     }
-    client_config = ClientConfig.load(env_vars=env)
+    client_config = ClientConfig.load(override_env_vars=env)
     connect_config = client_config.profiles["default"].to_client_connect_config()
     assert connect_config.get("target_host") == "default-address"
 
@@ -272,7 +272,7 @@ def test_load_profiles_no_config_file(monkeypatch):
     """Test that load_profiles works when no config file is found."""
     monkeypatch.setattr("pathlib.Path.exists", lambda _: False)
     monkeypatch.setattr(os, "environ", {})
-    client_config = ClientConfig.load(env_vars={})
+    client_config = ClientConfig.load(override_env_vars={})
     assert not client_config.profiles
 
 
@@ -281,14 +281,14 @@ def test_load_profiles_discovery(tmp_path: Path, monkeypatch):
     config_file = tmp_path / "config.toml"
     config_file.write_text(TOML_CONFIG_BASE)
     env = {"TEMPORAL_CONFIG_FILE": str(config_file)}
-    client_config = ClientConfig.load(env_vars=env)
+    client_config = ClientConfig.load(override_env_vars=env)
     assert "default" in client_config.profiles
 
 
 def test_load_profiles_disable_file():
     """Test load_profiles with file loading disabled."""
     # With no env vars, should be empty
-    client_config = ClientConfig.load(disable_file=True, env_vars={})
+    client_config = ClientConfig.load(disable_file=True, override_env_vars={})
     assert not client_config.profiles