Add notes to docstrings about 'text' vs. 'bytes' semantics. · googleapis/google-cloud-python@d5642c9 · GitHub

googleapis / google-cloud-python Public

• Notifications You must be signed in to change notification settings
• Fork 1.8k
• Star 5.4k

• Code
• Issues 442
• Pull requests 97
• Discussions
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit d5642c9

Browse filesBrowse the repository at this point in the historyBrowse files

tseaver

committed

Add notes to docstrings about 'text' vs. 'bytes' semantics.

Addresses #233.

1 parent 9809589 commit d5642c9
Copy full SHA for d5642c9

2 files changed

+10Lines changed: 10 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• gcloud/datastore
  • _helpers.py
  • entity.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎gcloud/datastore/_helpers.py‎

Copy file name to clipboardExpand all lines: gcloud/datastore/_helpers.py

+5Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -29,6 +29,11 @@ def _get_protobuf_attribute_and_value(val):
29	29	`gcloud.datastore.key.Key` into a Protobuf representation.
30	30	This function handles that for you.
31	31
	32	+ .. note::
	33	+ Values which are "text" ('unicode' in Python2, 'str' in Python3) map
	34	+ to 'string_value' in the datastore; values which are "bytes"
	35	+ ('str' in Python2, 'bytes' in Python3) map to 'blob_value'.
	36	+
32	37	For example:
33	38
34	39	>>> _get_protobuf_attribute_and_value(1234)

Collapse file

‎gcloud/datastore/entity.py‎

Copy file name to clipboardExpand all lines: gcloud/datastore/entity.py

+5Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -208,6 +208,11 @@ def save(self):
208	208	not correspond to keys set on this instance will be removed from
209	209	the datastore.
210	210
	211	+ .. note::
	212	+ Property values which are "text" ('unicode' in Python2, 'str' in
	213	+ Python3) map to 'string_value' in the datastore; values which are
	214	+ "bytes" ('str' in Python2, 'bytes' in Python3) map to 'blob_value'.
	215	+
211	216	:rtype: :class:`gcloud.datastore.entity.Entity`
212	217	:returns: The entity with a possibly updated Key.
213	218	"""

0 commit comments

Comments

0 (0)