yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-11-10 00:11:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(sdk): add client_mode and component to DataHubClient.from_env() (#14060)

Browse Source
This commit is contained in:
Harshal Sheth 2025-07-14 08:46:08 -07:00 committed by GitHub
parent 474e3f54a3
commit f4ee5652a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
metadata-ingestion/src/datahub/sdk/main_client.py
View File

@ -66,7 +66,12 @@ class DataHubClient:
self._graph.test_connection() self._graph.test_connection()
@classmethod @classmethod
def from_env(cls) -> "DataHubClient": def from_env(
cls,
*,
client_mode: ClientMode = ClientMode.SDK,
datahub_component: Optional[str] = None,
) -> "DataHubClient":
"""Initialize a DataHubClient from the environment variables or ~/.datahubenv file. """Initialize a DataHubClient from the environment variables or ~/.datahubenv file.
This will first check DATAHUB_GMS_URL and DATAHUB_GMS_TOKEN. If not present, This will first check DATAHUB_GMS_URL and DATAHUB_GMS_TOKEN. If not present,
@ -76,6 +81,10 @@ class DataHubClient:
If you're looking to specify the server/token in code, use the If you're looking to specify the server/token in code, use the
DataHubClient(server=..., token=...) constructor instead. DataHubClient(server=..., token=...) constructor instead.
Args:
client_mode: [internal] The client mode to use. Defaults to "SDK".
datahub_component: [internal] The DataHub component name to include in the user agent.
Returns: Returns:
A DataHubClient instance. A DataHubClient instance.
""" """
@ -83,7 +92,10 @@ class DataHubClient:
# Inspired by the DockerClient.from_env() method. # Inspired by the DockerClient.from_env() method.
# TODO: This one also reads from ~/.datahubenv, so the "from_env" name might be a bit confusing. # TODO: This one also reads from ~/.datahubenv, so the "from_env" name might be a bit confusing.
# That file is part of the "environment", but is not a traditional "env variable". # That file is part of the "environment", but is not a traditional "env variable".
graph = get_default_graph(ClientMode.SDK) graph = get_default_graph(
client_mode=client_mode,
datahub_component=datahub_component,
)
return cls(graph=graph) return cls(graph=graph)