Fix: Datastore samples: exclude_from_indexes expects a tuple, not a… (GoogleCloudPlatform#8233)

Mariatta · web-flow · commit 1cd2422551b2 · 2022-08-09T20:26:25.000Z
… list Updated the sample to pass in a tuple instead of a list. Also ensure that we call client.put() so the changes persist. Fix internal issue 233485333 ## Description Fixes #<ISSUE-NUMBER> Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google. ## Checklist - [x] I have followed [Sample Guidelines from AUTHORING_GUIDE.MD](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md) - [ ] README is updated to include [all relevant information](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#readme-file) - [x] **Tests** pass: `nox -s py-3.9` (see [Test Environment Setup](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#test-environment-setup)) - [x] **Lint** pass: `nox -s lint` (see [Test Environment Setup](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#test-environment-setup)) - [ ] These samples need a new **API enabled** in testing projects to pass (let us know which ones) - [ ] These samples need a new/updated **env vars** in testing projects set to pass (let us know which ones) - [x] Please **merge** this PR for me once it is approved. - [ ] This sample adds a new sample directory, and I updated the [CODEOWNERS file](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/.github/CODEOWNERS) with the codeowners for this sample
diff --git a/datastore/cloud-client/snippets.py b/datastore/cloud-client/snippets.py
@@ -213,7 +213,7 @@ def entity_with_parent(client):
 def properties(client):
     # [START datastore_properties]
     key = client.key("Task")
-    task = datastore.Entity(key, exclude_from_indexes=["description"])
+    task = datastore.Entity(key, exclude_from_indexes=("description",))
     task.update(
         {
             "category": "Personal",
@@ -224,6 +224,7 @@ def properties(client):
             "percent_complete": 10.5,
         }
     )
+    client.put(task)
     # [END datastore_properties]
 
     return task
diff --git a/datastore/cloud-client/tasks.py b/datastore/cloud-client/tasks.py
@@ -45,7 +45,7 @@ def add_task(client: datastore.Client, description: str):
 
     # Create an unsaved Entity object, and tell Datastore not to index the
     # `description` field
-    task = datastore.Entity(key, exclude_from_indexes=["description"])
+    task = datastore.Entity(key, exclude_from_indexes=("description",))
 
     # Apply new field values and save the Task entity to Datastore
     task.update(

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ def entity_with_parent(client):`
`213`	`213`	`def properties(client):`
`214`	`214`	`# [START datastore_properties]`
`215`	`215`	`key = client.key("Task")`
`216`		`- task = datastore.Entity(key, exclude_from_indexes=["description"])`
	`216`	`+ task = datastore.Entity(key, exclude_from_indexes=("description",))`
`217`	`217`	`task.update(`
`218`	`218`	`{`
`219`	`219`	`"category": "Personal",`
`@@ -224,6 +224,7 @@ def properties(client):`
`224`	`224`	`"percent_complete": 10.5,`
`225`	`225`	`}`
`226`	`226`	`)`
	`227`	`+ client.put(task)`
`227`	`228`	`# [END datastore_properties]`
`228`	`229`
`229`	`230`	`return task`