Skip to content
New issue

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

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

Already on GitHub? # to your account

[ServiceBus] Docstring and Changelog adjustment #11166

Merged
merged 37 commits into from
May 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
cb13bd8
Increment version
Feb 14, 2020
38e9f65
Update Development Status
Feb 14, 2020
aa30bc0
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Feb 15, 2020
c4710ea
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Feb 20, 2020
053f073
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Feb 24, 2020
f0697f7
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 6, 2020
c83241a
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 6, 2020
18c6fba
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 6, 2020
607f134
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 9, 2020
88fd7d1
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 9, 2020
fcbaf65
Remove typing.Deque for Py3.5.3
Mar 9, 2020
f52e2d9
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 10, 2020
8aaaf1e
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 11, 2020
a12351c
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 25, 2020
cc9dbb9
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 27, 2020
932336a
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 30, 2020
2742ca0
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Mar 31, 2020
72ab463
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 2, 2020
213bb9d
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 3, 2020
b312d19
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 6, 2020
0638b9a
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 6, 2020
c7bd430
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 7, 2020
de47f42
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 7, 2020
2fcc005
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 15, 2020
cfa9d81
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 20, 2020
ac224c1
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 23, 2020
1305495
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 27, 2020
2183d32
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 29, 2020
e233d8c
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
Apr 29, 2020
660e518
Merge branch 'master' of github.com:Azure/azure-sdk-for-python
May 1, 2020
dca752b
Update docstring and changelog for exceptions
May 1, 2020
b2c7f45
Adjust change log from review
May 1, 2020
55174c0
small change log adjustment
May 1, 2020
a6c9480
send() doc string adjustment
May 1, 2020
20e87ad
send() doc string adjustment
May 1, 2020
48dabf7
Update release date
May 1, 2020
563b63b
Update :raises: of send()
May 1, 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
9 changes: 6 additions & 3 deletions sdk/servicebus/azure-servicebus/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release History

## 7.0.0b2 (Unreleased)
## 7.0.0b2 (2020-05-04)

**New Features**

Expand All @@ -10,9 +10,12 @@
- Use `ServiceBusSender.schedule(messages, schedule_time_utc)` for scheduling messages.
- Use `ServiceBusSender.cancel_scheduled_messages(sequence_numbers)` for scheduled messages cancellation.
* `ServiceBusSender.send()` can now send a list of messages in one call, if they fit into a single batch. If they do not fit a `ValueError` is thrown.
* `BatchMessage.add()` and `ServiceBusSender.send()` raises `MessageContentTooLarge`, which is a subclass of `ValueError` if the content is over-sized.
* `ServiceBusReceiver.receive()` raises `ValueError` if the max_batch_size is greater than the prefetch of `ServiceBusClient`.
* `BatchMessage.add()` and `ServiceBusSender.send()` would raise `MessageContentTooLarge` if the content is over-sized.
* `ServiceBusReceiver.receive()` raises `ValueError` if its param `max_batch_size` is greater than param `prefetch` of `ServiceBusClient`.
* Added exception classes `MessageError`, `MessageContentTooLarge`, `ServiceBusAuthenticationError`.
- `MessageError`: when you send a problematic message, such as an already sent message or an over-sized message.
- `MessageContentTooLarge`: when you send an over-sized message. A subclass of `ValueError` and `MessageError`.
- `ServiceBusAuthenticationError`: on failure to be authenticated by the service.
* Removed exception class `InvalidHandlerState`.

**BugFixes**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ def add(self, message):
:param message: The Message to be added to the batch.
:type message: ~azure.servicebus.Message
:rtype: None
:raises: :class:`ValueError`, when exceeding the size limit.
:raises: :class: ~azure.servicebus.exceptions.MessageContentTooLarge, when exceeding the size limit.
"""
message_size = message.message.get_message_encoded_size()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,10 +301,14 @@ def send(self, message):
:param message: The ServiceBus message to be sent.
:type message: ~azure.servicebus.Message or ~azure.servicebus.BatchMessage or list[~azure.servicebus.Message]
:rtype: None
:raises: :class: ~azure.servicebus.exceptions.MessageSendFailed if the message fails to
send
:raises:
:class: ~azure.servicebus.exceptions.OperationTimeoutError if sending times out.
:class: `ValueError` if list of messages is provided and cannot fit in a batch.
:class: ~azure.servicebus.exceptions.MessageContentTooLarge if the size of the message is over
service bus frame size limit.
:class: ~azure.servicebus.exceptions.MessageSendFailed if the message fails to send
:class: ~azure.servicebus.exceptions.ServiceBusError when other errors happen such as connection
error, authentication error, and any unexpected errors.
It's also the top-level root class of above errors.

.. admonition:: Example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,10 +244,14 @@ async def send(self, message):
:param message: The ServiceBus message to be sent.
:type message: ~azure.servicebus.Message or ~azure.servicebus.BatchMessage or list[~azure.servicebus.Message]
:rtype: None
:raises: :class: ~azure.servicebus.exceptions.MessageSendFailed if the message fails to
send
:raises:
:class: ~azure.servicebus.exceptions.OperationTimeoutError if sending times out.
:class: `ValueError` if list of messages is provided and cannot fit in a batch.
:class: ~azure.servicebus.exceptions.MessageContentTooLarge if the size of the message is over
service bus frame size limit.
:class: ~azure.servicebus.exceptions.MessageSendFailed if the message fails to send
:class: ~azure.servicebus.exceptions.ServiceBusError when other errors happen such as connection
error, authentication error, and any unexpected errors.
It's also the top-level root class of above errors.

.. admonition:: Example:

Expand Down