azure-iot-sdk-python

Fixes

• Removed artificial restriction on version of requests dependency
• Replaced the abandoned requests-unixsocket dependency with the requests-unixsocket2 fork
• Removed restriction on urllib3 dependency, allowing support for modern versions
• Added support for Python 3.11 and 3.12

Notice

Support for Python 3.7 was dropped with this release

Fixes

• Restricted a non-compatible release of requests that was breaking IoT Edge

Features

• Added support for typed static analysis tooling

Fixes

• Fixed a bug where ensure_desired_properties keyword argument was being ignored
• Fixed a bug where under certain conditions published messages were duplicated

Notes

• As of this release, Python 3.6 is no longer supported.

Features

• Fetching the latest twin when reconnecting is now optional (using the ensure_desired_properties kwarg)

Fixes

• Timeout is now implemented on HTTP requests
• Inaccurate log messages from MQTT (CONNACK rc==16) now provide the correct information
• KeyError is no longer thrown if two responses to the same request are received
• Reconnecting while using twin patches now only results in one twin request instead of two
• Prevented infinite twin request loop
• TlsAuthExchangeErrors are now automatically retriable
• General improvements to connection stability + resilience

IoTHub Clients Change Log

NOTICE

• Support for Python 2.7 and 3.5 has been dropped as of this release

Features

• Added support for providing gateway_hostname in most constructors

Fixes

• Fixed a memory leak if no handlers were set on the client

IoTHub Clients Change Log

Features

• Support for server verification cert for Provisioning Clients
• Removal of socks library from user-facing API
• Support for proxies when using .invoke_method(), .get_storage_info_for_blob() and .notify_blob_upload_status() on IoTHub Clients

Fixes

• Fixed an issue where sufficiently long SAS token expiry or retry interval could cause a OverflowError due to exceeding the max value supported by a waiting thread.
• Fixed an issue where alarms were incorrectly triggering, now they will trigger correctly at the specified time, even if the system goes to sleep.
• Fixed an issue where disconnect notifications were sometimes happening twice for a single disconnection.
• Fixed an issue where after a failed reauthorization, the re-attempt of the reauthorization happened on the wrong thread.

IoTHub Clients Change Log

Features

• Added support for the .on_background_exception handler to the clients. If set, this handler will be invoked when an exception occurs from non-user-initiated actions (e.g. connection drop)

Fixes

• Fixed a compatibility issue with Python 3.10
• Timeout of network calls now will result in a OperationTimeout exception rather than a OperationCancelled
• Fixed an issue where disconnect notifications were sometimes happening twice for a single disconnection

IoTHub Clients Change Log

Features

• Added support for an .on_new_sastoken_required handler which will be invoked 2 minutes prior to the expiration of a user-provided sastoken (only relevant when using a client created with the .create_from_sastoken() method)

Fixes

• General stability improvements to connections
• Adjusted CONACK timeout to 60 seconds for cross-language parity with other IoT Device Clients
• Added missing docstrings for handler attributes

Hub Library Change Log

• Added strict bounds on dependencies
• Updated dependency formatting for greater compatibility with package indexes
• Fixed a bug where connection string credentials were expiring after a few minutes

Hub Library Change Log

Feature

• Add support for C2D messages with AAD authentication

IoTHub Clients Change Log

Fixes

• Fixed a bug where in-flight operations would hang after a disconnect if not using connection_retry

IoTHub Clients Change Log

Features

• Added support for an .on_connection_state_change handler which will be invoked every time the client connection state changes

Fixes

• Increased required version of urllib3 to prevent vulnerabilities

IoTHub Clients Change Log

Features

• Added the ability to disable client auto-connect via the auto_connect keyword argument
• Added the ability to disable client automatic connection retry via the connection_retry keyword argument
• Added the ability to configure the connection retry interval with the connection_retry_interval keyword argument
• Added support for the iothub-ack system property on Cloud-to-Device (C2D) messages. This will appear on the ack attribute of the Message object

Fixes

• .disconnect() and .shutdown() now cancel any in-flight operations
• Modified verison of urllib3 dependency for greater compatibility

Hub Library Change Log

Feature

• Add CRUD support for AAD tokens
• Support user assigned managed identities for import/export jobs

Hub Library Change Log

Feature

• Add parent_scopes parameter on RegistryManager create and update methods in order to support nested Edge

Fixes

• Normalize treatment of etags in RegistryManager

Device Library Change Log

Fixes

• Fixed missing documentation for client handlers
• Removed distribution for unsupported Python versions

Device Library Change Log

Features

• Added a new API for graceful exit of the IoTHub clients - .shutdown()

Fixes

• Fixed a bug where SAS token renewal was broken by system sleep
• Improved some erroneous logging messages

Code Examples

https://github.com/Azure/azure-iot-sdk-python/tree/master/azure-iot-device/samples

Device Library Change Log

Features

• Added APIs for user-provided SAS tokens on IoTHub clients
  • .create_from_sastoken() allows the creation of a Device/Module client from a SAS token string
  • .update_sastoken() allows for a new sastoken to be provided to the Device/Module client

Fixes

• Fixed bugs related to device/module ids with special characters on IoTHub clients
• Fixed issues on the Provisioning clients related to invalid arguments
• Various documentation fixes

Code Examples

https://github.com/Azure/azure-iot-sdk-python/tree/master/azure-iot-device/samples

Device Library Change Log

Features

• Added handlers for receive message
  • Deprecated receive message API
• Added handlers for receive twin desired patch
  • Deprecated receive twin desired patch API
• Added handlers for receive method request
  • Deprecated receive method request API

Samples

• Added samples for plug and play utilizing existing device SDK functionality

Code Examples

Device

https://github.com/Azure/azure-iot-sdk-python/tree/master/azure-iot-device/samples

Hub Library Change Log

Feature

• Added a DigitalTwinClient

Samples

• Added sample for getting digital twin.
• Added sample for updating digital twin.
• Added sample for invoking command on digital twin.
• Added sample for invoking command on the component of a digital twin
• Updated sample for showing how digital twin model id can be retrieved from normal twin.

Code Examples

Hub

https://github.com/Azure/azure-iot-sdk-python/tree/master/azure-iot-hub/samples