Fix get_workspace_client in GCP #532
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #532 +/- ##
==========================================
- Coverage 57.78% 57.77% -0.02%
==========================================
Files 43 43
Lines 27614 27626 +12
==========================================
+ Hits 15957 15961 +4
- Misses 11657 11665 +8 ☔ View full report in Codecov by Sentry. |
tanmay-db
approved these changes
Feb 12, 2024
.codegen/__init__.py.tmpl
Outdated
| config.account_id = None | ||
| config_inner = self._config.as_dict().copy() | ||
| if 'host' in config_inner: | ||
| del config_inner['host'] |
There was a problem hiding this comment.
using something like:
keys_to_remove = ['host', 'azure_workspace_resource_id', 'account_id']
might be better for readability / extensible in case we want to have more keys we want to remove in future.
tanmay-db
added a commit
that referenced
this pull request
Mar 7, 2024
* Fix get_workspace_client in GCP ([#532](#532)). * Fix integer deserialization for headers ([#553](#553)). * Add Files API docs to the SDK Documentation ([#556](#556)). * Add back enums to docs ([#557](#557)). * Sort index pages by name in docs ([#560](#560)). * Add integration tests for Files API ([#552](#552)). * Distinguish between empty types and fields that can take any value ([#561](#561)). * Support subservices ([#559](#559)). * Use all-apis scope with external-browser ([#563](#563)). * Make a best effort attempt to initialise all Databricks globals ([#562](#562)). * Added tokei.rs badge ([#567](#567)). * New example to list compute resource for SUBMIT_RUN job runs ([#572](#572)). * Update SDK to latest OpenAPI spec ([#576](#576)). API Changes: * Added [w.permission_migration](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/permission_migration.html) workspace-level service. * Added `databricks.sdk.service.iam.PermissionMigrationRequest` dataclass. * Added `databricks.sdk.service.iam.PermissionMigrationResponse` dataclass. * Changed `version` field for `databricks.sdk.service.serving.AppManifest` to `databricks.sdk.service.serving.AnyValue` dataclass. * Removed `delete_personal_compute_setting()` method for [a.account_settings](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings.html) account-level service. * Removed `get_personal_compute_setting()` method for [a.account_settings](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings.html) account-level service. * Removed `update_personal_compute_setting()` method for [a.account_settings](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings.html) account-level service. * Removed `delete_default_namespace_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. * Removed `delete_restrict_workspace_admins_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. * Removed `get_default_namespace_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. * Removed `get_restrict_workspace_admins_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. * Removed `update_default_namespace_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. * Removed `update_restrict_workspace_admins_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. * Added [w.automatic_cluster_update](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/automatic_cluster_update.html) workspace-level service. * Added [w.csp_enablement](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/csp_enablement.html) workspace-level service. * Added [a.csp_enablement_account](https://databricks-sdk-py.readthedocs.io/en/latest/account/csp_enablement_account.html) account-level service. * Added [w.default_namespace](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/default_namespace.html) workspace-level service. * Added [w.esm_enablement](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/esm_enablement.html) workspace-level service. * Added [a.esm_enablement_account](https://databricks-sdk-py.readthedocs.io/en/latest/account/esm_enablement_account.html) account-level service. * Added [a.personal_compute](https://databricks-sdk-py.readthedocs.io/en/latest/account/personal_compute.html) account-level service. * Added [w.restrict_workspace_admins](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/restrict_workspace_admins.html) workspace-level service. * Removed `databricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequest` dataclass. * Removed `databricks.sdk.service.settings.DeletePersonalComputeSettingRequest` dataclass. * Removed `databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequest` dataclass. * Removed `databricks.sdk.service.settings.GetDefaultNamespaceSettingRequest` dataclass. * Removed `databricks.sdk.service.settings.GetPersonalComputeSettingRequest` dataclass. * Removed `databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequest` dataclass. * Added `aws_stable_ip_rule` field for `databricks.sdk.service.settings.NccEgressDefaultRules`. * Added `databricks.sdk.service.settings.AutomaticClusterUpdateSetting` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessage` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetails` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindow` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency` dataclass. * Added `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime` dataclass. * Added `databricks.sdk.service.settings.ComplianceStandard` dataclass. * Added `databricks.sdk.service.settings.CspEnablement` dataclass. * Added `databricks.sdk.service.settings.CspEnablementAccount` dataclass. * Added `databricks.sdk.service.settings.CspEnablementAccountSetting` dataclass. * Added `databricks.sdk.service.settings.CspEnablementSetting` dataclass. * Added `databricks.sdk.service.settings.DeleteDefaultNamespaceRequest` dataclass. * Added `databricks.sdk.service.settings.DeletePersonalComputeRequest` dataclass. * Added `databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminRequest` dataclass. * Added `databricks.sdk.service.settings.EsmEnablement` dataclass. * Added `databricks.sdk.service.settings.EsmEnablementAccount` dataclass. * Added `databricks.sdk.service.settings.EsmEnablementAccountSetting` dataclass. * Added `databricks.sdk.service.settings.EsmEnablementSetting` dataclass. * Added `databricks.sdk.service.settings.GetAutomaticClusterUpdateRequest` dataclass. * Added `databricks.sdk.service.settings.GetCspEnablementAccountRequest` dataclass. * Added `databricks.sdk.service.settings.GetCspEnablementRequest` dataclass. * Added `databricks.sdk.service.settings.GetDefaultNamespaceRequest` dataclass. * Added `databricks.sdk.service.settings.GetEsmEnablementAccountRequest` dataclass. * Added `databricks.sdk.service.settings.GetEsmEnablementRequest` dataclass. * Added `databricks.sdk.service.settings.GetPersonalComputeRequest` dataclass. * Added `databricks.sdk.service.settings.GetRestrictWorkspaceAdminRequest` dataclass. * Added `databricks.sdk.service.settings.NccAwsStableIpRule` dataclass. * Added `databricks.sdk.service.settings.UpdateAutomaticClusterUpdateSettingRequest` dataclass. * Added `databricks.sdk.service.settings.UpdateCspEnablementAccountSettingRequest` dataclass. * Added `databricks.sdk.service.settings.UpdateCspEnablementSettingRequest` dataclass. * Added `databricks.sdk.service.settings.UpdateEsmEnablementAccountSettingRequest` dataclass. * Added `databricks.sdk.service.settings.UpdateEsmEnablementSettingRequest` dataclass. * Removed `planning_phases` field for `databricks.sdk.service.sql.QueryMetrics`. * Changed `delete_endpoint()` method for [w.vector_search_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_endpoints.html) workspace-level service with new required argument order. * Changed `create_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service with new required argument order. * Changed `delete_data_vector_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service with new required argument order. * Changed `upsert_data_vector_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service with new required argument order. * Changed `endpoint_name` field for `databricks.sdk.service.vectorsearch.CreateVectorIndexRequest` to be required. * Removed `name` field for `databricks.sdk.service.vectorsearch.DeleteDataVectorIndexRequest`. * Added `index_name` field for `databricks.sdk.service.vectorsearch.DeleteDataVectorIndexRequest`. * Removed `name` field for `databricks.sdk.service.vectorsearch.DeleteEndpointRequest`. * Removed `databricks.sdk.service.vectorsearch.EmbeddingConfig` dataclass. * Removed `embedding_config` field for `databricks.sdk.service.vectorsearch.EmbeddingSourceColumn`. * Added `embedding_model_endpoint_name` field for `databricks.sdk.service.vectorsearch.EmbeddingSourceColumn`. * Added `score_threshold` field for `databricks.sdk.service.vectorsearch.QueryVectorIndexRequest`. * Removed `name` field for `databricks.sdk.service.vectorsearch.UpsertDataVectorIndexRequest`. * Added `index_name` field for `databricks.sdk.service.vectorsearch.UpsertDataVectorIndexRequest`. * Removed `delta_sync_vector_index_spec` field for `databricks.sdk.service.vectorsearch.VectorIndex`. * Removed `direct_access_vector_index_spec` field for `databricks.sdk.service.vectorsearch.VectorIndex`. * Added `delta_sync_index_spec` field for `databricks.sdk.service.vectorsearch.VectorIndex`. * Added `direct_access_index_spec` field for `databricks.sdk.service.vectorsearch.VectorIndex`. OpenAPI SHA: 1026b998b14fba1b8317528f47778240dc4e9a5d, Date: 2024-03-06
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 7, 2024
### New Features and Improvements * Fixed get_workspace_client in GCP ([#532](#532)). * Use all-apis scope with external-browser ([#563](#563)). * Make a best effort attempt to initialise all Databricks globals ([#562](#562)). * Fixed type issue with widgets.getArgument ([#581](#581)) * Note: Backwards incompatible changes - Settings are now nested, please see the API changes below. ### Documentation * Added Files API docs to the SDK Documentation ([#556](#556)). * Added new example to list compute resource for SUBMIT_RUN job runs ([#572](#572)). * Sorted index pages by name in docs ([#560](#560)). * Added back enums to docs ([#557](#557)). ### API Changes #### Added Services: - [w.permission_migration](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/permission_migration.html) workspace-level service. - [w.settings.automatic_cluster_update](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/automatic_cluster_update.html) workspace-level service. - [w.settings.csp_enablement](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/csp_enablement.html) workspace-level service. - [a.settings.csp_enablement_account](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/csp_enablement_account.html) account-level service. - [w.settings.default_namespace](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/default_namespace.html) workspace-level service. - [w.settings.esm_enablement](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/esm_enablement.html) workspace-level service. - [a.settings.esm_enablement_account](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/esm_enablement_account.html) account-level service. - [a.settings.personal_compute](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/personal_compute.html) account-level service. - [w.settings.restrict_workspace_admins](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/restrict_workspace_admins.html) workspace-level service. Dataclasses: - `databricks.sdk.service.settings.AutomaticClusterUpdateSetting` - `databricks.sdk.service.settings.ClusterAutoRestartMessage` - `databricks.sdk.service.settings.ClusterAutoRestartMessageEnablementDetails` - `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindow` - `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek` - `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule` - `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency` - `databricks.sdk.service.settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime` - `databricks.sdk.service.settings.ComplianceStandard` - `databricks.sdk.service.settings.CspEnablement` - `databricks.sdk.service.settings.CspEnablementAccount` - `databricks.sdk.service.settings.CspEnablementAccountSetting` - `databricks.sdk.service.settings.CspEnablementSetting` - `databricks.sdk.service.settings.DeleteDefaultNamespaceRequest` - `databricks.sdk.service.settings.DeletePersonalComputeRequest` - `databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminRequest` - `databricks.sdk.service.settings.EsmEnablement` - `databricks.sdk.service.settings.EsmEnablementAccount` - `databricks.sdk.service.settings.EsmEnablementAccountSetting` - `databricks.sdk.service.settings.EsmEnablementSetting` - `databricks.sdk.service.settings.GetAutomaticClusterUpdateRequest` - `databricks.sdk.service.settings.GetCspEnablementAccountRequest` - `databricks.sdk.service.settings.GetCspEnablementRequest` - `databricks.sdk.service.settings.GetDefaultNamespaceRequest` - `databricks.sdk.service.settings.GetEsmEnablementAccountRequest` - `databricks.sdk.service.settings.GetEsmEnablementRequest` - `databricks.sdk.service.settings.GetPersonalComputeRequest` - `databricks.sdk.service.settings.GetRestrictWorkspaceAdminRequest` - `databricks.sdk.service.settings.NccAwsStableIpRule` - `databricks.sdk.service.settings.UpdateAutomaticClusterUpdateSettingRequest` - `databricks.sdk.service.settings.UpdateCspEnablementAccountSettingRequest` - `databricks.sdk.service.settings.UpdateCspEnablementSettingRequest` - `databricks.sdk.service.settings.UpdateEsmEnablementAccountSettingRequest` - `databricks.sdk.service.settings.UpdateEsmEnablementSettingRequest` - `databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindow` - `databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek` - `databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule` - `databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency` - `databricks.sdk.service.vectorsearch.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime` - `databricks.sdk.service.vectorsearch.ComplianceStandard` - `databricks.sdk.service.vectorsearch.CspEnablement` - `databricks.sdk.service.vectorsearch.CspEnablementAccount` - `databricks.sdk.service.vectorsearch.CspEnablementAccountSetting` - `databricks.sdk.service.vectorsearch.CspEnablementSetting` - `databricks.sdk.service.vectorsearch.DeleteDefaultNamespaceRequest` - `databricks.sdk.service.vectorsearch.DeletePersonalComputeRequest` - `databricks.sdk.service.vectorsearch.DeleteRestrictWorkspaceAdminRequest` - `databricks.sdk.service.vectorsearch.EsmEnablement` - `databricks.sdk.service.vectorsearch.EsmEnablementAccount` - `databricks.sdk.service.vectorsearch.EsmEnablementAccountSetting` - `databricks.sdk.service.vectorsearch.EsmEnablementSetting` - `databricks.sdk.service.vectorsearch.GetAutomaticClusterUpdateRequest` - `databricks.sdk.service.vectorsearch.GetCspEnablementAccountRequest` - `databricks.sdk.service.vectorsearch.GetCspEnablementRequest` - `databricks.sdk.service.vectorsearch.GetDefaultNamespaceRequest` - `databricks.sdk.service.vectorsearch.GetEsmEnablementAccountRequest` - `databricks.sdk.service.vectorsearch.GetEsmEnablementRequest` - `databricks.sdk.service.vectorsearch.GetPersonalComputeRequest` - `databricks.sdk.service.vectorsearch.GetRestrictWorkspaceAdminRequest` - `databricks.sdk.service.vectorsearch.NccAwsStableIpRule` - `databricks.sdk.service.vectorsearch.UpdateAutomaticClusterUpdateSettingRequest` - `databricks.sdk.service.vectorsearch.UpdateCspEnablementAccountSettingRequest` - `databricks.sdk.service.vectorsearch.UpdateCspEnablementSettingRequest` - `databricks.sdk.service.vectorsearch.UpdateEsmEnablementAccountSettingRequest` - `databricks.sdk.service.vectorsearch.UpdateEsmEnablementSettingRequest` - `databricks.sdk.service.iam.PermissionMigrationRequest` - `databricks.sdk.service.iam.PermissionMigrationResponse` #### Changed - `version` field for `databricks.sdk.service.serving.AppManifest` to `databricks.sdk.service.serving.AnyValue` dataclass. - `delete_endpoint()` method for [w.vector_search_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_endpoints.html) workspace-level service with new required argument order. - `create_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service with new required argument order. - `delete_data_vector_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service with new required argument order. - `upsert_data_vector_index()` method for [w.vector_search_indexes](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/vector_search_indexes.html) workspace-level service with new required argument order. - `endpoint_name` field for `databricks.sdk.service.vectorsearch.CreateVectorIndexRequest` to be required. #### Removed - `delete_personal_compute_setting()` method for [a.account_settings](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings.html) account-level service. - `get_personal_compute_setting()` method for [a.account_settings](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings.html) account-level service. - `update_personal_compute_setting()` method for [a.account_settings](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_settings.html) account-level service. - `delete_default_namespace_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. - `delete_restrict_workspace_admins_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. - `get_default_namespace_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. - `get_restrict_workspace_admins_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. - `update_default_namespace_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. - `update_restrict_workspace_admins_setting()` method for [w.settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings.html) workspace-level service. - `databricks.sdk.service.settings.DeleteDefaultNamespaceSettingRequest` dataclass. - `databricks.sdk.service.settings.DeletePersonalComputeSettingRequest` dataclass. - `databricks.sdk.service.settings.DeleteRestrictWorkspaceAdminsSettingRequest` dataclass. - `databricks.sdk.service.settings.GetDefaultNamespaceSettingRequest` dataclass. - `databricks.sdk.service.settings.GetPersonalComputeSettingRequest` dataclass. - `databricks.sdk.service.settings.GetRestrictWorkspaceAdminsSettingRequest` dataclass. - `databricks.sdk.service.vectorsearch.EmbeddingConfig` dataclass. - `embedding_config` field for `databricks.sdk.service.vectorsearch.EmbeddingSourceColumn`. - `name` field for `databricks.sdk.service.vectorsearch.DeleteDataVectorIndexRequest`. - `name` field for `databricks.sdk.service.vectorsearch.DeleteEndpointRequest`. - `planning_phases` field for `databricks.sdk.service.sql.QueryMetrics`. - `delta_sync_vector_index_spec` field for `databricks.sdk.service.vectorsearch.VectorIndex`. - `direct_access_vector_index_spec` field for `databricks.sdk.service.vectorsearch.VectorIndex`. ### Internal Changes * Added tokei.rs badge ([#567](#567)). * Update SDK to latest OpenAPI spec ([#576](#576)). * Add integration tests for Files API ([#552](#552)). * Fix integer deserialization for headers ([#553](#553)). * Support subservices ([#559](#559)). * Distinguish between empty types and fields that can take any value ([#561](#561)). OpenAPI SHA: 1026b998b14fba1b8317528f47778240dc4e9a5d, Date: 2024-03-06
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
The current implementation of get_workspace_client copies the entire config, critically reusing the cached header factory so as to use the same auth mechanism when getting a workspace client. However, at least in GCP, account-level OAuth tokens can't be used to authenticate to a workspace (probably because the audience for the account-level and workspace-level tokens is different).
This PR fixes this by only copying the exported fields and not copying the header factory. Subsequent use of the config in WorkspaceClient will trigger config resolution. For GCP, this means creating a new token source using the correct host as the audience.
This ports databricks/databricks-sdk-go#803 to the Python SDK.
Tests
Manually ran this integration test in all non-UC (Azure, AWS, GCP) and UC (AWS, GCP) account-level environments.
make testrun locallymake fmtapplied