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

Jump to bottom

Missing docs on timeout in azure-storage #28506

Closed
andrea-cassioli-maersk opened this issue Jan 27, 2023 · 2 comments · Fixed by #28513
Closed

Missing docs on timeout in azure-storage #28506

andrea-cassioli-maersk opened this issue Jan 27, 2023 · 2 comments · Fixed by #28513
Assignees
@jalauzon-msft @vincenttran-msft
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Storage Storage Service (Queues, Blobs, Files)

Comments

@andrea-cassioli-maersk
Copy link

  • Package Name: azure-storage-blob
  • Package Version: [12.14.1]
  • Operating System: OSX
  • Python Version: 3.8

Describe the bug
The docs about timeout parameters, for instance in

https://azuresdkdocs.blob.core.windows.net/$web/python/azure-storage-blob/12.14.1/azure.storage.blob.html#azure.storage.blob.BlobClient.upload_blob

does not describe the default value and what kind of behaviour to expect if left unset.
@ghost ghost added customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jan 27, 2023
@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jan 27, 2023
@xiangyan99 xiangyan99 added Storage Storage Service (Queues, Blobs, Files) Docs CXP Attention and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Jan 27, 2023
@ghost ghost added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Jan 27, 2023
@ghost
Copy link

ghost commented Jan 27, 2023

Thank you for your feedback. This has been routed to the support team for assistance.

@jalauzon-msft
Copy link
Member

Hi @andrea-cassioli-maersk Andrea, thanks for bringing up the issue. I agree that the documentation for the timeout parameter could be improved. We will work on getting a PR to improve this.

In case you wanted some more info now, this timeout parameter is the server-side timeout for the operation. The default and maximum value is usually 30 seconds for most operations, but upload/download have different timeouts that are based on blob size. See the service documentation for more info. This is not a client-side timeout and the client does not do anything with it. To configure client-side timeouts, see our README.

@jalauzon-msft jalauzon-msft added bug This issue requires a change to an existing behavior in the product in order to be resolved. and removed CXP Attention labels Jan 27, 2023
@jalauzon-msft jalauzon-msft mentioned this issue Jan 27, 2023
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Apr 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jalauzon-msft jalauzon-msft

@vincenttran-msft vincenttran-msft

Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Storage] Fix documentation for timeout in all Storage packages jalauzon-msft/azure-sdk-for-python
4 participants
@xiangyan99 @andrea-cassioli-maersk @jalauzon-msft @vincenttran-msft