Skip to content

Commit c713c57

Browse files
committed
Add note about possible breaking change
1 parent 79acb4b commit c713c57

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

ChangeLog.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ v2.0.0 - 2023-xx-xx
1414
* `max_packets` argument in loop(), loop_write() and loop_forever() is removed
1515
* `force` argument in loop_stop() is removed
1616
* method `message_retry_set()` is removed
17+
- Possible breaking change: Add properties to access most Client attribute. Closes #764.
18+
Since this add new properties like `logger`, if a sub-class defined `logger`, the two `logger`
19+
will conflict.
1720
- Add version 2 of user-callback which allow to access MQTTv5 reason code & properties that were
1821
missing from on_publish callback. Also it's more consistent in parameter order or between
1922
MQTTv3 and MQTTv5.
@@ -44,7 +47,6 @@ v2.0.0 - 2023-xx-xx
4447
- Raise error on `subscribe()` when `topic` is an empty list. Closes #690.
4548
- Raise error on `publish.multiple()` when `msgs` is an empty list. Closes #684.
4649
- Don't add port to Host: header for websockets connections when the port if the default port. Closes #666.
47-
- Add properties to access most Client attribute. Closes #764.
4850

4951

5052
v1.6.1 - 2021-10-21

migrations.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The list of breaking change (detailed below) are:
1313
* Dropped some deprecated and no used argument or method. If you used them, you can just drop them.
1414
* Improved typing which resulted in few type change. It might no affect you, see below for detail.
1515
* Fixed connect_srv, which changed its signature.
16+
* Added new properties, which could conflict with sub-class
1617

1718
### Versioned the user callbacks
1819

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

219220
connect_srv() didn't took the same argument as connect(). Fixed this, which means the signaure
220221
changed. But since connect_srv was broken in previous version, this should not have any negative impact.
222+
223+
### Added new properties
224+
225+
The Client class added few new properties. If you are using a sub-class of Client and also defined a
226+
attribute, method or properties with the same name, it will conflict.
227+
228+
The added properties are:
229+
* host
230+
* port
231+
* keepalive
232+
* transport
233+
* protocol
234+
* connect_timeout
235+
* username
236+
* password
237+
* max_inflight_messages
238+
* max_queued_messages
239+
* will_topic
240+
* will_payload
241+
* logger

0 commit comments

Comments
 (0)