Skip to content

[Storage] Fix datetime parsing docstring #34926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vincenttran-msft merged 5 commits into from
Mar 26, 2024
Merged

[Storage] Fix datetime parsing docstring #34926

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3c4eb6
Fix docstring for datetime parsing in Blobs
vincenttran-msft Mar 26, 2024
6acc29f
Fix docstring for datetime parsing in Datalake
vincenttran-msft Mar 26, 2024
8988c1d
Fix docstring for datetime parsing in Fileshare
vincenttran-msft Mar 26, 2024
b2cdae0
Fix docstring for datetime parsing in Queue
vincenttran-msft Mar 26, 2024
fa147d8
Adjust docstring
vincenttran-msft Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -792,9 +792,8 @@ class AccessPolicy(GenAccessPolicy):
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
"""
def __init__(self, permission=None, expiry=None, start=None):
Expand Down
5 changes: 2 additions & 3 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_shared/shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,8 @@ def generate_account(self, services, resource_types, permission, expiry, start=N
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down
28 changes: 11 additions & 17 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,8 @@ def generate_blob(self, container_name, blob_name, snapshot=None, version_id=Non
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -178,9 +177,8 @@ def generate_container(self, container_name, permission=None, expiry=None,
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -337,15 +335,13 @@ def generate_account_sas(
:type permission: str or ~azure.storage.blob.AccountSasPermissions
:param expiry:
The time at which the shared access signature becomes invalid.
Azure will always convert values to UTC. If a date is passed in
without timezone info, it is assumed to be UTC.
Azure will always interpret all dates specified to be UTC.
:type expiry: ~datetime.datetime or str
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down Expand Up @@ -433,9 +429,8 @@ def generate_container_sas(
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -560,9 +555,8 @@ def generate_blob_sas(
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down
5 changes: 2 additions & 3 deletions sdk/storage/azure-storage-file-datalake/azure/storage/filedatalake/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,9 +656,8 @@ class AccessPolicy(BlobAccessPolicy):
:keyword start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:paramtype start: ~datetime.datetime or str
"""

Expand Down
5 changes: 2 additions & 3 deletions ...azure-storage-file-datalake/azure/storage/filedatalake/_shared/shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,8 @@ def generate_account(self, services, resource_types, permission, expiry, start=N
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down
23 changes: 9 additions & 14 deletions ...torage/azure-storage-file-datalake/azure/storage/filedatalake/_shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,13 @@ def generate_account_sas(
:type permission: str or ~azure.storage.filedatalake.AccountSasPermissions
:param expiry:
The time at which the shared access signature becomes invalid.
Azure will always convert values to UTC. If a date is passed in
without timezone info, it is assumed to be UTC.
Azure will always interpret all dates specified to be UTC.
:type expiry: ~datetime.datetime or str
:keyword start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:paramtype start: ~datetime.datetime or str
:keyword str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down Expand Up @@ -137,9 +135,8 @@ def generate_file_system_sas(
:keyword start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:paramtype start: datetime or str
:keyword str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -245,9 +242,8 @@ def generate_directory_sas(
:keyword start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:paramtype start: ~datetime.datetime or str
:keyword str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -360,9 +356,8 @@ def generate_file_sas(
:keyword start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:paramtype start: ~datetime.datetime or str
:keyword str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down
5 changes: 2 additions & 3 deletions sdk/storage/azure-storage-file-share/azure/storage/fileshare/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,8 @@ class AccessPolicy(GenAccessPolicy):
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
"""
def __init__(self, permission=None, expiry=None, start=None):
Expand Down
5 changes: 2 additions & 3 deletions ...orage/azure-storage-file-share/azure/storage/fileshare/_shared/shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,8 @@ def generate_account(self, services, resource_types, permission, expiry, start=N
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down
28 changes: 11 additions & 17 deletions sdk/storage/azure-storage-file-share/azure/storage/fileshare/_shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,8 @@ def generate_file(self, share_name, directory_name=None, file_name=None,
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -157,9 +156,8 @@ def generate_share(self, share_name, permission=None, expiry=None,
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -269,15 +267,13 @@ def generate_account_sas(
user is restricted to operations allowed by the permissions.
:param expiry:
The time at which the shared access signature becomes invalid.
Azure will always convert values to UTC. If a date is passed in without
timezone info, it is assumed to be UTC.
Azure will always interpret all dates specified to be UTC.
:type expiry: ~datetime.datetime or str
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down Expand Up @@ -355,9 +351,8 @@ def generate_share_sas(
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -452,9 +447,8 @@ def generate_file_sas(
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down
5 changes: 2 additions & 3 deletions sdk/storage/azure-storage-queue/azure/storage/queue/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,9 +325,8 @@ class AccessPolicy(GenAccessPolicy):
:param Optional[Union["datetime", str]] start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
"""

permission: Optional[Union[QueueSasPermissions, str]] #type: ignore [assignment]
Expand Down
5 changes: 2 additions & 3 deletions sdk/storage/azure-storage-queue/azure/storage/queue/_shared/shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,8 @@ def generate_account(self, services, resource_types, permission, expiry, start=N
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down
18 changes: 7 additions & 11 deletions sdk/storage/azure-storage-queue/azure/storage/queue/_shared_access_signature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ def generate_queue(
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down Expand Up @@ -161,15 +160,13 @@ def generate_account_sas(
:type permission: ~azure.storage.queue.AccountSasPermissions or str
:param expiry:
The time at which the shared access signature becomes invalid.
Azure will always convert values to UTC. If a date is passed in
without timezone info, it is assumed to be UTC.
Azure will always interpret all dates specified to be UTC.
:type expiry: ~datetime.datetime or str
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str ip:
Specifies an IP address or a range of IP addresses from which to accept requests.
Expand Down Expand Up @@ -236,9 +233,8 @@ def generate_queue_sas(
:param start:
The time at which the shared access signature becomes valid. If
omitted, start time for this call is assumed to be the time when the
storage service receives the request. Azure will always convert values
to UTC. If a date is passed in without timezone info, it is assumed to
be UTC.
storage service receives the request. Azure will always interpret all
dates specified to be UTC.
:type start: ~datetime.datetime or str
:param str policy_id:
A unique value up to 64 characters in length that correlates to a
Expand Down