Skip to content

[API Review] azure-storage-blob 12.31.0b1 (base 12.29.0) #47236

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

Draft
tjprescott wants to merge 1 commit into
base: base_azure-storage-blob_12.29.0
Choose a base branch
from
Draft

[API Review] azure-storage-blob 12.31.0b1 (base 12.29.0) #47236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 21 additions & 28 deletions sdk/storage/azure-storage-blob/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ namespace azure.storage.blob
content_type: Optional[str] = ...,
correlation_id: Optional[str] = ...,
encryption_scope: Optional[str] = ...,
is_directory: Optional[bool] = ...,
protocol: Optional[str] = ...,
request_headers: Optional[Dict[str, str]] = ...,
request_query_params: Optional[Dict[str, str]] = ...,
Expand Down Expand Up @@ -472,7 +473,7 @@ namespace azure.storage.blob
match_condition: Optional[MatchConditions] = ...,
maxsize_condition: Optional[int] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Union[str, datetime, int]]: ...

Expand Down Expand Up @@ -933,7 +934,7 @@ namespace azure.storage.blob
encryption_scope: Optional[str] = ...,
lease: Union[BlobLeaseClient, str] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Any]: ...

Expand Down Expand Up @@ -1024,7 +1025,7 @@ namespace azure.storage.blob
standard_blob_tier: Optional[StandardBlobTier] = ...,
tags: dict(str, str) = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Any]: ...

Expand Down Expand Up @@ -1078,7 +1079,7 @@ namespace azure.storage.blob
lease: Union[BlobLeaseClient, str] = ...,
match_condition: Optional[MatchConditions] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Union[str, datetime]]: ...

Expand Down Expand Up @@ -1292,6 +1293,7 @@ namespace azure.storage.blob
request_server_encrypted: Optional[bool]
server_encrypted: bool
size: int
smart_access_tier: Optional[str]
snapshot: Optional[str]
tag_count: Optional[int]
tags: Optional[Dict[str, str]]
Expand Down Expand Up @@ -1651,10 +1653,8 @@ namespace azure.storage.blob
lease_duration: int = -1,
lease_id: Optional[str] = None,
*,
etag: Optional[str] = ...,
if_modified_since: Optional[datetime] = ...,
if_unmodified_since: Optional[datetime] = ...,
match_condition: Optional[MatchConditions] = ...,
timeout: Optional[int] = ...,
**kwargs: Any
) -> BlobLeaseClient: ...
Expand Down Expand Up @@ -1707,11 +1707,9 @@ namespace azure.storage.blob
def delete_container(
self,
*,
etag: Optional[str] = ...,
if_modified_since: Optional[datetime] = ...,
if_unmodified_since: Optional[datetime] = ...,
lease: Union[BlobLeaseClient, str] = ...,
match_condition: Optional[MatchConditions] = ...,
timeout: Optional[int] = ...,
**kwargs: Any
) -> None: ...
Expand Down Expand Up @@ -1821,9 +1819,7 @@ namespace azure.storage.blob
self,
metadata: Optional[Dict[str, str]] = None,
*,
etag: Optional[str] = ...,
if_modified_since: Optional[datetime] = ...,
if_unmodified_since: Optional[datetime] = ...,
lease: Union[BlobLeaseClient, str] = ...,
timeout: Optional[int] = ...,
**kwargs: Any
Expand Down Expand Up @@ -1879,7 +1875,7 @@ namespace azure.storage.blob
progress_hook: Callable[[int, Optional[int]], None] = ...,
standard_blob_tier: Optional[StandardBlobTier] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs
) -> BlobClient: ...

Expand Down Expand Up @@ -2876,6 +2872,7 @@ namespace azure.storage.blob
COLD = "Cold"
COOL = "Cool"
HOT = "Hot"
SMART = "Smart"


class azure.storage.blob.StaticWebsite(GeneratedStaticWebsite):
Expand Down Expand Up @@ -3117,7 +3114,7 @@ namespace azure.storage.blob
config: StorageConfiguration = None,
start_range: Optional[int] = None,
end_range: Optional[int] = None,
validate_content: bool = None,
validate_content: CV_TYPE_PARSED = None,
encryption_options: Dict[str, Any] = None,
max_concurrency: Optional[int] = None,
name: str = None,
Expand All @@ -3131,18 +3128,18 @@ namespace azure.storage.blob

def chunks(self) -> Iterator[bytes]: ...

def content_as_bytes(self, max_concurrency: int = None) -> bytes: ...
def content_as_bytes(self, max_concurrency: Optional[int] = None) -> bytes: ...

def content_as_text(
self,
max_concurrency: int = None,
max_concurrency: Optional[int] = None,
encoding: str = "UTF-8"
) -> str: ...

def download_to_stream(
self,
stream: IO[T],
max_concurrency: int = None
max_concurrency: Optional[int] = None
) -> Any: ...

@overload
Expand Down Expand Up @@ -3301,7 +3298,7 @@ namespace azure.storage.blob.aio
match_condition: Optional[MatchConditions] = ...,
maxsize_condition: Optional[int] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Union[str, datetime, int]]: ...

Expand Down Expand Up @@ -3761,7 +3758,7 @@ namespace azure.storage.blob.aio
encryption_scope: Optional[str] = ...,
lease: Union[BlobLeaseClient, str] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Any]: ...

Expand Down Expand Up @@ -3853,7 +3850,7 @@ namespace azure.storage.blob.aio
standard_blob_tier: Optional[StandardBlobTier] = ...,
tags: dict(str, str) = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Any]: ...

Expand Down Expand Up @@ -3907,7 +3904,7 @@ namespace azure.storage.blob.aio
lease: Union[BlobLeaseClient, str] = ...,
match_condition: Optional[MatchConditions] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs: Any
) -> Dict[str, Union[str, datetime]]: ...

Expand Down Expand Up @@ -4302,10 +4299,8 @@ namespace azure.storage.blob.aio
lease_duration: int = -1,
lease_id: Optional[str] = None,
*,
etag: Optional[str] = ...,
if_modified_since: Optional[datetime] = ...,
if_unmodified_since: Optional[datetime] = ...,
match_condition: Optional[MatchConditions] = ...,
timeout: Optional[int] = ...,
**kwargs: Any
) -> BlobLeaseClient: ...
Expand Down Expand Up @@ -4358,11 +4353,9 @@ namespace azure.storage.blob.aio
async def delete_container(
self,
*,
etag: Optional[str] = ...,
if_modified_since: Optional[datetime] = ...,
if_unmodified_since: Optional[datetime] = ...,
lease: Union[BlobLeaseClient, str] = ...,
match_condition: Optional[MatchConditions] = ...,
timeout: Optional[int] = ...,
**kwargs: Any
) -> None: ...
Expand Down Expand Up @@ -4528,7 +4521,7 @@ namespace azure.storage.blob.aio
progress_hook: Callable[[int, Optional[int]], Awaitable[None]] = ...,
standard_blob_tier: Optional[StandardBlobTier] = ...,
timeout: Optional[int] = ...,
validate_content: Optional[bool] = ...,
validate_content: Union[bool, Literal[auto, crc64, md5]] = ...,
**kwargs
) -> BlobClient: ...

Expand Down Expand Up @@ -4627,7 +4620,7 @@ namespace azure.storage.blob.aio
config: StorageConfiguration = None,
start_range: Optional[int] = None,
end_range: Optional[int] = None,
validate_content: bool = None,
validate_content: CV_TYPE_PARSED = None,
encryption_options: Dict[str, Any] = None,
max_concurrency: Optional[int] = None,
name: str = None,
Expand All @@ -4641,18 +4634,18 @@ namespace azure.storage.blob.aio

def chunks(self) -> AsyncIterator[bytes]: ...

async def content_as_bytes(self, max_concurrency: int = None) -> bytes: ...
async def content_as_bytes(self, max_concurrency: Optional[int] = None) -> bytes: ...

async def content_as_text(
self,
max_concurrency: int = None,
max_concurrency: Optional[int] = None,
encoding: str = "UTF-8"
) -> str: ...

async def download_to_stream(
self,
stream: IO[T],
max_concurrency: int = None
max_concurrency: Optional[int] = None
) -> Any: ...

@overload
Expand Down