Skip to content

Commit

Permalink
Add note about possible breaking change
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreF committed Jan 21, 2024
1 parent 79acb4b commit c713c57
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
4 changes: 3 additions & 1 deletion ChangeLog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ v2.0.0 - 2023-xx-xx
* `max_packets` argument in loop(), loop_write() and loop_forever() is removed
* `force` argument in loop_stop() is removed
* method `message_retry_set()` is removed
- Possible breaking change: Add properties to access most Client attribute. Closes #764.
Since this add new properties like `logger`, if a sub-class defined `logger`, the two `logger`
will conflict.
- Add version 2 of user-callback which allow to access MQTTv5 reason code & properties that were
missing from on_publish callback. Also it's more consistent in parameter order or between
MQTTv3 and MQTTv5.
Expand Down Expand Up @@ -44,7 +47,6 @@ v2.0.0 - 2023-xx-xx
- Raise error on `subscribe()` when `topic` is an empty list. Closes #690.
- Raise error on `publish.multiple()` when `msgs` is an empty list. Closes #684.
- Don't add port to Host: header for websockets connections when the port if the default port. Closes #666.
- Add properties to access most Client attribute. Closes #764.


v1.6.1 - 2021-10-21
Expand Down
21 changes: 21 additions & 0 deletions migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The list of breaking change (detailed below) are:
* Dropped some deprecated and no used argument or method. If you used them, you can just drop them.
* Improved typing which resulted in few type change. It might no affect you, see below for detail.
* Fixed connect_srv, which changed its signature.
* Added new properties, which could conflict with sub-class

### Versioned the user callbacks

Expand Down Expand Up @@ -218,3 +219,23 @@ for with both paho-mqtt 1.x and 2.0).

connect_srv() didn't took the same argument as connect(). Fixed this, which means the signaure
changed. But since connect_srv was broken in previous version, this should not have any negative impact.

### Added new properties

The Client class added few new properties. If you are using a sub-class of Client and also defined a
attribute, method or properties with the same name, it will conflict.

The added properties are:
* host
* port
* keepalive
* transport
* protocol
* connect_timeout
* username
* password
* max_inflight_messages
* max_queued_messages
* will_topic
* will_payload
* logger

0 comments on commit c713c57

Please sign in to comment.