Skip to content

Docstring of AzureError #9737

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
lmazuel merged 2 commits into from
Feb 6, 2020
Merged

Docstring of AzureError #9737

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0600e5f
Docstring of AzureError
lmazuel Jan 8, 2020
17002fc
Update exceptions.py
lmazuel Feb 6, 2020
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
18 changes: 17 additions & 1 deletion sdk/core/azure-core/azure/core/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,20 @@ def map_error(status_code, response, error_map):
raise error

class AzureError(Exception):
"""Base exception for all errors."""
"""Base exception for all errors.

:param message: The message object stringified as 'message' attribute
:keyword error: The original exception if any
:paramtype error: Exception

:ivar inner_exception: The exception passed with the 'error' kwarg
:type inner_exception: Exception
:ivar exc_type: The exc_type from sys.exc_info()
:ivar exc_value: The exc_value from sys.exc_info()
:ivar exc_traceback: The exc_traceback from sys.exc_info()
:ivar exc_msg: A string formatting of message parameter, exc_type and exc_value
:ivar str message: A stringified version of the message parameter
"""

def __init__(self, message, *args, **kwargs):
self.inner_exception = kwargs.get('error')
Expand Down Expand Up @@ -120,6 +133,9 @@ class HttpResponseError(AzureError):
:type message: string
:param response: The response that triggered the exception.
:type response: ~azure.core.pipeline.transport.HttpResponse or ~azure.core.pipeline.transport.AsyncHttpResponse

:ivar reason: The HTTP response reason
:type reason: str
:ivar status_code: HttpResponse's status code
:type status_code: int
:ivar response: The response that triggered the exception.
Expand Down