Skip to content
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

Fix Sphinx on azure-storage-blob #36014

Merged
merged 2 commits into from
Jun 11, 2024
Merged

Fix Sphinx on azure-storage-blob #36014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ea57d1
Fix Sphinx on azure-storage-blob
Jun 10, 2024
9262506
Enable Sphinx in CI
Jun 10, 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
95 changes: 50 additions & 45 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class BlobServiceClient(StorageAccountHostsMixin, StorageEncryptionMixin):

For more optional configuration, please click
`here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#optional-configuration>`_.
#optional-configuration>`__.

:param str account_url:
The URL to the blob storage account. Any other entities included
Expand Down Expand Up @@ -216,7 +216,7 @@ def get_user_delegation_key(self, key_start_time, # type: datetime
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: The user delegation key.
:rtype: ~azure.storage.blob.UserDelegationKey
"""
Expand Down Expand Up @@ -282,7 +282,7 @@ def get_service_stats(self, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: The blob service stats.
:rtype: Dict[str, Any]

Expand Down Expand Up @@ -314,7 +314,7 @@ def get_service_properties(self, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An object containing blob service properties such as
analytics logging, hour/minute metrics, cors rules, etc.
:rtype: Dict[str, Any]
Expand Down Expand Up @@ -385,7 +385,7 @@ def set_service_properties(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:rtype: None

.. admonition:: Example:
Expand Down Expand Up @@ -450,7 +450,7 @@ def list_containers(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An iterable (auto-paging) of ContainerProperties.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.ContainerProperties]

Expand Down Expand Up @@ -505,7 +505,7 @@ def find_blobs_by_tags(self, filter_expression, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An iterable (auto-paging) response of BlobProperties.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.FilteredBlob]
"""
Expand Down Expand Up @@ -555,7 +555,7 @@ def create_container(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: A container client to interact with the newly created container.
:rtype: ~azure.storage.blob.ContainerClient

Expand Down Expand Up @@ -617,7 +617,7 @@ def delete_container(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.

.. admonition:: Example:

Expand Down Expand Up @@ -656,7 +656,7 @@ def _rename_container(self, name, new_name, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: A container client for the renamed container.
:rtype: ~azure.storage.blob.ContainerClient
"""
Expand Down Expand Up @@ -692,7 +692,7 @@ def undelete_container(self, deleted_container_name, deleted_container_version,
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: The undeleted ContainerClient.
:rtype: ~azure.storage.blob.ContainerClient
"""
Expand Down
42 changes: 22 additions & 20 deletions sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class ContainerClient(StorageAccountHostsMixin, StorageEncryptionMixin): # py

For more optional configuration, please click
`here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#optional-configuration>`_.
#optional-configuration>`__.

:param str account_url:
The URI to the storage account. In order to create a client given the full URI to the container,
Expand Down Expand Up @@ -306,7 +306,7 @@ def create_container(self, metadata=None, public_access=None, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: A dictionary of response headers.
:rtype: Dict[str, Union[str, datetime]]

Expand Down Expand Up @@ -352,7 +352,7 @@ def _rename_container(self, new_name, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: The renamed container client.
:rtype: ~azure.storage.blob.ContainerClient
"""
Expand Down Expand Up @@ -408,7 +408,7 @@ def delete_container(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:rtype: None

.. admonition:: Example:
Expand Down Expand Up @@ -474,7 +474,7 @@ def acquire_lease(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: A BlobLeaseClient object, that can be run in a context manager.
:rtype: ~azure.storage.blob.BlobLeaseClient

Expand Down Expand Up @@ -524,7 +524,7 @@ def get_container_properties(self, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:return: Properties for the specified container within a container object.
:rtype: ~azure.storage.blob.ContainerProperties

Expand Down Expand Up @@ -562,7 +562,7 @@ def exists(self, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: boolean
:rtype: bool
"""
Expand Down Expand Up @@ -614,7 +614,7 @@ def set_container_metadata( # type: ignore
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: Container-updated property dict (Etag and last modified).
:rtype: dict[str, str or datetime]

Expand Down Expand Up @@ -693,7 +693,7 @@ def get_container_access_policy(self, **kwargs):
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: Access policy information in a dict.
:rtype: dict[str, Any]

Expand Down Expand Up @@ -760,7 +760,7 @@ def set_container_access_policy(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: Container-updated property dict (Etag and last modified).
:rtype: dict[str, str or ~datetime.datetime]

Expand Down Expand Up @@ -823,7 +823,7 @@ def list_blobs(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An iterable (auto-paging) response of BlobProperties.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]

Expand Down Expand Up @@ -872,7 +872,7 @@ def list_blob_names(self, **kwargs: Any) -> ItemPaged[str]:
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An iterable (auto-paging) response of blob names as strings.
:rtype: ~azure.core.paging.ItemPaged[str]
"""
Expand Down Expand Up @@ -929,7 +929,7 @@ def walk_blobs(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An iterable (auto-paging) response of BlobProperties.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
"""
Expand Down Expand Up @@ -975,7 +975,7 @@ def find_blobs_by_tags(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:returns: An iterable (auto-paging) response of FilteredBlob.
:rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
"""
Expand Down Expand Up @@ -1062,7 +1062,7 @@ def upload_blob(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
#other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
the timeout will apply to each call individually.
:keyword ~azure.storage.blob.PremiumPageBlobTier premium_page_blob_tier:
A page blob tier value to set the blob to. The tier correlates to the size of the
Expand Down Expand Up @@ -1163,6 +1163,7 @@ def delete_blob(
value that, when present, specifies the version of the blob to delete.

.. versionadded:: 12.4.0

This keyword argument was introduced in API version '2019-12-12'.

:keyword lease:
Expand Down Expand Up @@ -1197,7 +1198,7 @@ def delete_blob(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:rtype: None
"""
if isinstance(blob, BlobProperties):
Expand Down Expand Up @@ -1261,6 +1262,7 @@ def download_blob(
value that, when present, specifies the version of the blob to download.

.. versionadded:: 12.4.0

This keyword argument was introduced in API version '2019-12-12'.

:keyword bool validate_content:
Expand Down Expand Up @@ -1319,7 +1321,7 @@ def download_blob(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
#other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
the timeout will apply to each call individually.
multiple calls to the Azure service and the timeout will apply to
each call individually.
Expand Down Expand Up @@ -1538,7 +1540,7 @@ def delete_blobs( # pylint: disable=delete-operation-wrong-return-type
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:return: An iterator of responses, one for each blob in order
:rtype: Iterator[~azure.core.pipeline.transport.HttpResponse]

Expand Down Expand Up @@ -1708,7 +1710,7 @@ def set_standard_blob_tier_blobs(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:keyword bool raise_on_any_failure:
This is a boolean param which defaults to True. When this is set, an exception
is raised even if there is a single operation failure.
Expand Down Expand Up @@ -1761,7 +1763,7 @@ def set_premium_page_blob_tier_blobs(
https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
This value is not tracked or validated on the client. To configure client-side network timesouts
see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
#other-client--per-operation-configuration>`_.
#other-client--per-operation-configuration>`__.
:keyword bool raise_on_any_failure:
This is a boolean param which defaults to True. When this is set, an exception
is raised even if there is a single operation failure.
Expand Down
Loading