From 64fe5f61853a051bfcc48c62df329b8f6915c206 Mon Sep 17 00:00:00 2001 From: swathipil Date: Thu, 5 Jan 2023 12:02:15 -0800 Subject: [PATCH 1/4] update uamqp_transport docstring --- sdk/eventhub/azure-eventhub/CHANGELOG.md | 2 +- .../azure/eventhub/_consumer_client.py | 18 +++++++++++++----- .../azure/eventhub/_producer_client.py | 15 ++++++++++----- .../eventhub/aio/_consumer_client_async.py | 18 +++++++++++++----- .../eventhub/aio/_producer_client_async.py | 18 +++++++++++++----- 5 files changed, 50 insertions(+), 21 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/CHANGELOG.md b/sdk/eventhub/azure-eventhub/CHANGELOG.md index d0ca49ff82eb..bab6935303e0 100644 --- a/sdk/eventhub/azure-eventhub/CHANGELOG.md +++ b/sdk/eventhub/azure-eventhub/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 5.11.0 (Unreleased) +## 5.11.0 (2022-01-10) ### Features Added diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py index 07309007369d..66f44066e6c9 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py @@ -118,16 +118,19 @@ class EventHubConsumerClient( evaluation regardless of the load balancing strategy. Greedy strategy is used by default. :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :keyword bool uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None .. admonition:: Example: @@ -281,14 +284,19 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs): evaluation regardless of the load balancing strategy. Greedy strategy is used by default. :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None :rtype: ~azure.eventhub.EventHubConsumerClient diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py index 656b68042957..ced4c205103a 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py @@ -113,16 +113,19 @@ class EventHubProducerClient( :keyword Dict http_proxy: HTTP proxy settings. This must be a dictionary with the following keys: `'proxy_hostname'` (str value) and `'proxy_port'` (int value). Additionally the following keys may also be present: `'username', 'password'`. - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :keyword bool uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None .. admonition:: Example: @@ -485,14 +488,16 @@ def from_connection_string( :keyword Dict http_proxy: HTTP proxy settings. This must be a dictionary with the following keys: `'proxy_hostname'` (str value) and `'proxy_port'` (int value). Additionally the following keys may also be present: `'username', 'password'`. - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. + :paramtype connection_verify: str or None :rtype: ~azure.eventhub.EventHubProducerClient .. admonition:: Example: diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py index 8e33b705dacb..7b6365f7378a 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py @@ -123,16 +123,19 @@ class EventHubConsumerClient( evaluation regardless of the load balancing strategy. Greedy strategy is used by default. :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :keyword bool uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None .. admonition:: Example: @@ -300,14 +303,19 @@ def from_connection_string( evaluation regardless of the load balancing strategy. Greedy strategy is used by default. :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None :rtype: ~azure.eventhub.aio.EventHubConsumerClient .. admonition:: Example: diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py index a47dd81dc5ff..89a6f846122c 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py @@ -100,16 +100,19 @@ class EventHubProducerClient( :keyword dict http_proxy: HTTP proxy settings. This must be a dictionary with the following keys: `'proxy_hostname'` (str value) and `'proxy_port'` (int value). Additionally the following keys may also be present: `'username', 'password'`. - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :keyword bool uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None .. admonition:: Example: @@ -469,14 +472,19 @@ def from_connection_string( If the port 5671 is unavailable/blocked in the network environment, `TransportType.AmqpOverWebsocket` could be used instead which uses port 443 for communication. :paramtype transport_type: ~azure.eventhub.TransportType - :keyword str custom_endpoint_address: The custom endpoint address to use for establishing a connection to + :keyword custom_endpoint_address: The custom endpoint address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :keyword str connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to + :paramtype custom_endpoint_address: str or None + :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. + :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool or None :rtype: ~azure.eventhub.aio.EventHubProducerClient .. admonition:: Example: From 94c2ef1839c34cf7852ca5c36e58774fb529129b Mon Sep 17 00:00:00 2001 From: swathipil Date: Thu, 5 Jan 2023 12:39:59 -0800 Subject: [PATCH 2/4] update date + docstring --- sdk/eventhub/azure-eventhub/CHANGELOG.md | 2 +- .../azure-eventhub/azure/eventhub/_consumer_client.py | 4 ++-- .../azure-eventhub/azure/eventhub/_producer_client.py | 5 ++++- .../azure/eventhub/aio/_consumer_client_async.py | 4 ++-- .../azure/eventhub/aio/_producer_client_async.py | 4 ++-- 5 files changed, 11 insertions(+), 8 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/CHANGELOG.md b/sdk/eventhub/azure-eventhub/CHANGELOG.md index bab6935303e0..a22d3b8ab6a2 100644 --- a/sdk/eventhub/azure-eventhub/CHANGELOG.md +++ b/sdk/eventhub/azure-eventhub/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 5.11.0 (2022-01-10) +## 5.11.0 (2023-01-10) ### Features Added diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py index 66f44066e6c9..9020e9550398 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py @@ -130,7 +130,7 @@ class EventHubConsumerClient( :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool .. admonition:: Example: @@ -296,7 +296,7 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs): :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool :rtype: ~azure.eventhub.EventHubConsumerClient diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py index ced4c205103a..764d4fe8da7f 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py @@ -125,7 +125,7 @@ class EventHubProducerClient( :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool .. admonition:: Example: @@ -498,6 +498,9 @@ def from_connection_string( authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. :paramtype connection_verify: str or None + :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is + False and the Pure Python AMQP library will be used as the underlying transport. + :paramtype uamqp_transport: bool :rtype: ~azure.eventhub.EventHubProducerClient .. admonition:: Example: diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py index 7b6365f7378a..3945a9de1e2c 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py @@ -135,7 +135,7 @@ class EventHubConsumerClient( :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool .. admonition:: Example: @@ -315,7 +315,7 @@ def from_connection_string( :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool :rtype: ~azure.eventhub.aio.EventHubConsumerClient .. admonition:: Example: diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py index 89a6f846122c..6e2c53a26b26 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py @@ -112,7 +112,7 @@ class EventHubProducerClient( :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool .. admonition:: Example: @@ -484,7 +484,7 @@ def from_connection_string( :paramtype connection_verify: str or None :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. - :paramtype uamqp_transport: bool or None + :paramtype uamqp_transport: bool :rtype: ~azure.eventhub.aio.EventHubProducerClient .. admonition:: Example: From e1748105fc251bb5d48004c0c635a770c92bf9a9 Mon Sep 17 00:00:00 2001 From: swathipil Date: Thu, 5 Jan 2023 12:44:23 -0800 Subject: [PATCH 3/4] update str or None docstring to Optional[str] for apiview, fix with typing later --- .../azure-eventhub/azure/eventhub/_consumer_client.py | 8 ++++---- .../azure-eventhub/azure/eventhub/_producer_client.py | 8 ++++---- .../azure/eventhub/aio/_consumer_client_async.py | 8 ++++---- .../azure/eventhub/aio/_producer_client_async.py | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py index 9020e9550398..4346a9e740ed 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py @@ -123,11 +123,11 @@ class EventHubConsumerClient( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool @@ -289,11 +289,11 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs): other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py index 764d4fe8da7f..c4815f1f2b3e 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py @@ -118,11 +118,11 @@ class EventHubProducerClient( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool @@ -493,11 +493,11 @@ def from_connection_string( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py index 3945a9de1e2c..d63ed81dd491 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py @@ -128,11 +128,11 @@ class EventHubConsumerClient( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool @@ -308,11 +308,11 @@ def from_connection_string( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py index 6e2c53a26b26..96323c3cda0b 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py @@ -105,11 +105,11 @@ class EventHubProducerClient( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool @@ -477,11 +477,11 @@ def from_connection_string( other paths needed for the host environment. Default is None. The format would be like "sb://:". If port is not specified in the `custom_endpoint_address`, by default port 443 will be used. - :paramtype custom_endpoint_address: str or None + :paramtype custom_endpoint_address: Optional[str] :keyword connection_verify: Path to the custom CA_BUNDLE file of the SSL certificate which is used to authenticate the identity of the connection endpoint. Default is None in which case `certifi.where()` will be used. - :paramtype connection_verify: str or None + :paramtype connection_verify: Optional[str] :keyword uamqp_transport: Whether to use the `uamqp` library as the underlying transport. The default value is False and the Pure Python AMQP library will be used as the underlying transport. :paramtype uamqp_transport: bool From 453c926ab32bc3c891dbef8f4e1c12eaded5a127 Mon Sep 17 00:00:00 2001 From: swathipil Date: Thu, 5 Jan 2023 14:10:34 -0800 Subject: [PATCH 4/4] update changelog --- sdk/eventhub/azure-eventhub/CHANGELOG.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/CHANGELOG.md b/sdk/eventhub/azure-eventhub/CHANGELOG.md index a22d3b8ab6a2..ff4edfc14189 100644 --- a/sdk/eventhub/azure-eventhub/CHANGELOG.md +++ b/sdk/eventhub/azure-eventhub/CHANGELOG.md @@ -4,13 +4,16 @@ ### Features Added -### Breaking Changes +- A new boolean keyword argument `uamqp_transport` has been added to sync and async `EventHubProducerClient`/`EventHubConsumerClient` constructors which indicates whether to use the `uamqp` library or the default pure Python AMQP library as the underlying transport. ### Bugs Fixed +- Fixed a bug that caused an error when sending batches with tracing enabled (issue #27986). + ### Other Changes -- Updated uAMQP dependency to 1.6.3. +- Removed uAMQP from required dependencies. +- Adding `uamqp >= 1.6.3` as an optional dependency for use with the `uamqp_transport` keyword. - Added support for Python 3.11. ## 5.10.1 (2022-08-22)