feat: add support for 'Blob.custom_time' and lifecycle rules #199

HemangChothani · 2020-07-01T13:04:27Z

Fixes #196

…into storage_issue_196

jkwlui

Thanks @HemangChothani! Please hold until product is ready to move forward.

google/cloud/storage/blob.py

…into storage_issue_196

tseaver · 2020-07-24T17:22:19Z

I have marked this PR as do not merge per @jkwlui .

google/cloud/storage/blob.py

tests/unit/test_blob.py

tseaver · 2020-07-24T17:28:23Z

google/cloud/storage/blob.py

+        See https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :type value: :class:`datetime.datetime`
+        :param value: (Optional) Set the custom time of blob. Datetime object parsed


Document the semantics of None value (which should be to clear any existing property value).

…-storage into storage_issue_196

…into storage_issue_196 Y

tests/unit/test_blob.py

…into storage_issue_196

frankyn

Thanks for your patience @HemangChothani,

Update: The Cloud Storage team has updated type of noncurrent_time_before and custom_time to be a Date format (YYYY-mm-dd) instead of DateTime.

Discovery document with updated documentation with respect to these fields:
https://www.googleapis.com/discovery/v1/apis/storage/v1/rest

HemangChothani · 2020-08-13T04:56:05Z

Update: The Cloud Storage team has updated type of noncurrent_time_before and custom_time to be a Date format (YYYY-mm-dd) instead of DateTime.

@frankyn That change has been already done.

…into storage_issue_196

frankyn · 2020-08-14T16:58:55Z

google/cloud/storage/blob.py

+        See https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :rtype: :class:`datetime.date` or ``NoneType``
+        :returns: Date object parsed from iso8601 valid date, or


This should be dateTime

…into storage_issue_196

frankyn

Have two nits for documentation, otherwise LGTM.

frankyn · 2020-08-24T21:02:40Z

google/cloud/storage/blob.py

+
+        See https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :type value: :class:`datetime.datetime` or ``NoneType``


Once set it can't be unset and only changed to a custom datetime in the future. If the custom_time must be unset, you must either perform a rewrite operation or upload the data again.

I'd state that setter can only be datetime.datetime to not confuse folks.

frankyn · 2020-08-24T21:03:23Z

google/cloud/storage/bucket.py

+
+    :type custom_time_before: :class:`datetime.date`
+    :param custom_time_before: (Optional) Apply rule action to items whose custom time is before this
+                                date. This condition is relevant only for versioned objects.


Please include similar text to noncurrent_time_before with RFC3339 and an example.

…-storage into storage_issue_196

frankyn

1 nit, thanks @HemangChothani

frankyn · 2020-08-25T17:40:52Z

google/cloud/storage/blob.py

+
+        See https://cloud.google.com/storage/docs/json_api/v1/objects
+
+        :type value: :class:`datetime.datetime` or ``NoneType``


I'd state that setter can only be datetime.datetime to not confuse folks.

tseaver's feedback was addressed and dismissing as the PR LGTM.

tseaver · 2020-08-26T18:58:34Z

google/cloud/storage/blob.py

+
+    @custom_time.setter
+    def custom_time(self, value):
+        """Set the custom time for the object. Once set it can't be unset


Please follow PEP 257 for Multi-line docstrings, i.e., move the non-summary down below.

tseaver · 2020-08-26T18:58:45Z

google/cloud/storage/blob.py

+        """Set the custom time for the object. Once set it can't be unset
+        and only changed to a custom datetime in the future. If the
+        custom_time must be unset, you must either perform a rewrite operation
+        or upload the data again.


These semantics are not enforced by the method.

tseaver · 2020-08-26T18:59:23Z

google/cloud/storage/bucket.py

+    @property
+    def days_since_custom_time(self):
+        """Conditon's 'days_since_custom_time' value."""
+        return self.get("daysSinceCustomTime")


Setter for this property?

tseaver · 2020-08-26T18:59:33Z

google/cloud/storage/bucket.py

+        """Conditon's 'custom_time_before' value."""
+        before = self.get("customTimeBefore")
+        if before is not None:
+            return datetime_helpers.from_iso8601_date(before)


Setter for this property?

Not sure about the setter method for all this properties, because we don't have a method for other properties as well which defined before. Please let me know if needed, so need to create setter method for all the properties of LifecycleRuleConditions class.

Thanks both, looks like setters weren't defined at this level. It will be filed as a feature request for now. It doesn't block customers from using the feature.

…pis#199) * feat(storage): add support of custom time metadata and timestamp * feat(storage): change the return type of custom_time_before * feat(storage): add setter method * feat(storage): add test for None value * feat(storage): changes in unittest * feat(storage): change custom_time type to date * feat: change custom_time to datetime * feat: nit Co-authored-by: Jonathan Lui <jonathanlui@google.com> Co-authored-by: Tres Seaver <tseaver@palladion.com> Co-authored-by: Frank Natividad <frankyn@users.noreply.github.com>

HemangChothani added 2 commits July 1, 2020 18:31

feat(storage): add support of custom time metadata and timestamp

c03d6ae

Merge branch 'master' of https://github.com/googleapis/python-storage …

7347cf2

…into storage_issue_196

HemangChothani requested review from frankyn and jkwlui July 1, 2020 13:04

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 1, 2020

HemangChothani changed the title ~~Storage issue 196~~ feat(storage): add support of custom time metadata and timestamp Jul 1, 2020

jkwlui approved these changes Jul 13, 2020

View reviewed changes

jkwlui and others added 2 commits July 13, 2020 15:46

Merge branch 'master' into storage_issue_196

ef32ca2

feat(storage): change the return type of custom_time_before

0212ca4

tseaver suggested changes Jul 21, 2020

View reviewed changes

google/cloud/storage/blob.py Show resolved Hide resolved

HemangChothani added 2 commits July 24, 2020 12:03

feat(storage): add setter method

a6c830c

Merge branch 'master' of https://github.com/googleapis/python-storage …

3dbda6a

…into storage_issue_196

tseaver added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 24, 2020

tseaver previously requested changes Jul 24, 2020

View reviewed changes

tseaver and others added 4 commits July 24, 2020 13:28

Merge branch 'master' into storage_issue_196

04e3a10

feat(storage): add test for None value

75e6067

Merge branch 'storage_issue_196' of https://github.com/q-logic/python…

7ee2796

…-storage into storage_issue_196

Merge branch 'master' of https://github.com/googleapis/python-storage …

e2793ce

…into storage_issue_196 Y

HemangChothani added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 28, 2020

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 28, 2020

busunkim96 closed this Jul 31, 2020

busunkim96 reopened this Jul 31, 2020

tseaver changed the title ~~feat(storage): add support of custom time metadata and timestamp~~ feat: add support for 'Blob.custom_time' and lifecyccle rules. Aug 4, 2020

tseaver changed the title ~~feat: add support for 'Blob.custom_time' and lifecyccle rules.~~ feat: add support for 'Blob.custom_time' and lifecyccle rules Aug 4, 2020

tseaver reviewed Aug 4, 2020

View reviewed changes

tests/unit/test_blob.py Show resolved Hide resolved

HemangChothani added 2 commits August 5, 2020 11:12

Merge branch 'master' of https://github.com/googleapis/python-storage …

43f1f5a

…into storage_issue_196

feat(storage): changes in unittest

0bd9bf4

MaxxleLLC force-pushed the storage_issue_196 branch from 1d96369 to 0bd9bf4 Compare August 5, 2020 05:57

feat(storage): change custom_time type to date

fee993f

frankyn requested changes Aug 12, 2020

View reviewed changes

Merge branch 'master' of https://github.com/googleapis/python-storage …

76457b1

…into storage_issue_196

frankyn requested changes Aug 14, 2020

View reviewed changes

HemangChothani added 2 commits August 17, 2020 11:47

feat: change custom_time to datetime

ae71f29

Merge branch 'master' of https://github.com/googleapis/python-storage …

d99fcb9

…into storage_issue_196

frankyn requested changes Aug 24, 2020

View reviewed changes

frankyn removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Aug 24, 2020

frankyn and others added 4 commits August 24, 2020 14:05

Merge branch 'master' into storage_issue_196

62781a3

Merge branch 'master' into storage_issue_196

0fcf160

feat: nit

39a12f0

Merge branch 'storage_issue_196' of https://github.com/q-logic/python…

285e15b

…-storage into storage_issue_196

frankyn requested changes Aug 25, 2020

View reviewed changes

feat: resolve conflict and nit

780a616

frankyn approved these changes Aug 26, 2020

View reviewed changes

frankyn requested a review from tseaver August 26, 2020 17:19

frankyn changed the title ~~feat: add support for 'Blob.custom_time' and lifecyccle rules~~ feat: add support for 'Blob.custom_time' and lifecycle rules Aug 26, 2020

Merge branch 'master' into storage_issue_196

e76b8bb

frankyn merged commit 180873d into googleapis:master Aug 26, 2020

tseaver reviewed Aug 26, 2020

View reviewed changes

tseaver mentioned this pull request Aug 26, 2020

fix: repair mal-formed docstring #255

Merged

frankyn mentioned this pull request Aug 27, 2020

Add Lifecycle Rule Property Setters #256

Open

release-please bot mentioned this pull request Jan 12, 2022

chore(main): release 3.0.0 #688

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for 'Blob.custom_time' and lifecycle rules #199

feat: add support for 'Blob.custom_time' and lifecycle rules #199

HemangChothani commented Jul 1, 2020

jkwlui left a comment

tseaver commented Jul 24, 2020

tseaver Jul 24, 2020

frankyn left a comment

HemangChothani commented Aug 13, 2020

frankyn Aug 14, 2020

frankyn left a comment

frankyn Aug 24, 2020

frankyn Aug 25, 2020

frankyn Aug 24, 2020 •

edited

frankyn left a comment

frankyn Aug 25, 2020

tseaver Aug 26, 2020

tseaver Aug 26, 2020

tseaver Aug 26, 2020

tseaver Aug 26, 2020

HemangChothani Aug 27, 2020

frankyn Aug 27, 2020


		See https://cloud.google.com/storage/docs/json_api/v1/objects

		:type value: :class:`datetime.datetime` or ``NoneType``

feat: add support for 'Blob.custom_time' and lifecycle rules #199

feat: add support for 'Blob.custom_time' and lifecycle rules #199

Conversation

HemangChothani commented Jul 1, 2020

jkwlui left a comment

Choose a reason for hiding this comment

tseaver commented Jul 24, 2020

Choose a reason for hiding this comment

frankyn left a comment

Choose a reason for hiding this comment

HemangChothani commented Aug 13, 2020

Choose a reason for hiding this comment

frankyn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankyn Aug 24, 2020 • edited

Choose a reason for hiding this comment

frankyn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankyn Aug 24, 2020 •

edited