Changelog for PubNub Python SDK

Added

Add custom message type support for the following APIs: Publish, signal, share file, subscribe and history.

Added

BREAKING CHANGES: Automatic reconnecting for subscribe with exponential backoff is now enabled by default.
Access manager v2 endpoints (grant and audit) will no longer be supported after December 31, 2024, and will be removed without further notice. Refer to the documentation to learn more.
BREAKING CHANGES: Once used to instantiate PubNub, the configuration object (PNConfiguration instance) becomes immutable. You will receive exceptions if you rely on modifying the configuration after the PubNub instance is created. Refer to the documentation to learn more.

Modified

Type hints for parameters and return values are now added to provide a better developer experience.
All endpoints are now accessible through the builder pattern and named parameters, providing a more flexible experience suitable for custom solutions.

Added	Option to lock PNConfiguration mutability. Note that mutable config will be deprecated in future major releases.
Fixed	Fix for routing crypto module if custom one was defined.
Modified	Additional Examples.

Added

A new version of subscription and presence handling is enabled by default (enableEventEngine flag is set to true). Please consult the documentation for new PNStatus values that are emitted for subscriptions, as code changes might be required to support this change.
Channels, ChannelGroups, ChannelMetadata and UserMetadata.

Fixed

Fix compatibility issues between EventEngine and Asyncio subscription manager.

Fixed

Fixes in the thread based subscription managers causing to duplicate subscription calls.

Fixed

Add missing status and type fields in app context. Now they are included, by default, in the response for getting channel/uuid metadata .

Fixed

Fixes AsyncioTelemetryManager to avoid creating a task every second.

Added

Optional Event Engine for Subscribe Loop.

Fixed

Gracefully handle decrypting an unencrypted method. If a decryption error occurs when trying to decrypt plain text, the plain text message will be returned and an error field will be set in the response. This works for both history and subscription messages.

Fixed

Changed license type from MIT to PubNub Software Development Kit License.

Added	Add crypto module that allows configure SDK to encrypt and decrypt messages.
Fixed	Improved security of crypto implementation by adding enhanced AES-CBC cryptor.

Added

Introduced option to select ciphering method for encoding messages and files. The default behavior is unchanged. More can be read [in this comment](https://github.com/pubnub/python/pull/156#issuecomment-1623307799).

Added

Add optional TTL parameter for publish endpoint.

Fixed

This change fixes typo in consumer models user and space resulting in setting invalid flags for the request.
This change fixes error in calling and returning value of status.is_error() method.
This change adds additional informations to PyPi package. Informations include URLs to source code and documentation, required python version (at least 3.7) and updates a list of supported python versions (removed 3.6 and added 3.10).

Fixed

Remove deprecation warning of Event.is_set and Thread.deamon.

Modified

Update build process to include python v3.10-dev and remove v3.6.
Fix of randomly failing tests of where_now feature.

Fixed

Fix bugs in Spaces Membership endpoints.

Added

Grant token now supports Users and Spaces.

Fixed

This addresses the issue #130 - a problem with importing module.

Added

Spaces Users and Membership endpoint implementation. This functionality is hidden behind a feature flag. By default it is disabled. To enable it there should be an environment variable named PN_ENABLE_ENTITIES set to True.

Fixed

Fixed error which happened when random initialization vector has been used. Request path was encrypted two times, once to prepare signage and second one when sending the request.
Fixed exception while receiving empty message field in FileMessageResult.

Fixed

Fix issue with signing objects requests containing filter.

Fixed

This issue was mentioned in issue #118 and replaces PR #119 to match our PR policy.

Added

Add methods to include additional fields in fetch_messages.

Added

Add methods to change use compression option on chosen endpoints.

Added

Add config option to set Content-Encoding to 'gzip'.

Fixed

Remove unwanted output while calling fetch_messages.

Modified

BREAKING CHANGES: uuid is required parameter while creating an instance of PubNub.

Added

Revoke token functionality.

Added

Parse_token method refactored.

Added

Grant result object __str__ message unified.

Added

Extend grant_token method to enable control of Objects API permission. Enhance granularity of permission control to enable permissions per UUID.

Fixed

Encoding of the double quote character fixed.

Added

PAMv3 support for Objects_v2 added (beta). Furthermore PAMv3 tokens can now be used within other PubNub features.

Added

SDK metadata was added. Additionally, example code for the FastAPI integration was added.

Fixed

Disabling default request headers within the Endpoint.

Fixed

Request headers required by the Grant Token functionality added.

Fixed

Multiple community Pull Requests for Asyncio related code applied.

Added

BREAKING CHANGE: Add randomized initialization vector usage by default for data encryption / decryption in publish / subscribe / history API calls.

Added

User defined 'origin'(custom domain) value was not used in all required places within this SDK.

Modified

Support for Python 2.7 was removed, support for the contemporary versions of Python was added. Apart from bringing the whole SDK up to date, support for Tornado and Twisted was removed and dependencies were simplified.

Added

New v3 History endpoint allows to fetch 100 messages per channel.

Added

Objects v2 implementation added to the PythonSDK with additional improvements to the test isolation within whole test suite.

Fixed

Within this release problems with double PAM calls encoding and Publish oriented bugs were fixed.

Fixed

Passing uuid to the get_state endpoint call added.

Added

File Upload added to the Python SDK.

Added	Add `suppress_leave_events` configuration option which can be used to opt-out presence leave call on unsubscribe.
Modified	Log out message decryption error and pass received message with `PNDecryptionErrorCategory` category to status listeners.

Modified

Allocating separate thread that basically waits a certain amount of time to clean telemetry data is a waste of memory/OS data structures. Cleaning mentioned data can be incorporated into regular logic.

Fixed

Fix bug with max message count parameter for Fetch Messages endpoint. Rename maximum_per_channel parameter to count for Fetch Messages, keeping the old name for compatibility.

Fixed

Using SSL by default from the Python SDK to be more consistent and encourage best practices.

Added

Implemented Objects Filtering API

Added

Add support for APNS2 Push API

Added

Implemented Message Actions API
Implemented Fetch Messages API
Added 'include_meta' to history()
Added 'include_meta' to fetch_messages()
Added 'include_message_actions' to fetch_messages()

Fixed

Excluded the tilde symbol from being encoded by the url_encode method to fix invalid PAM signature issue.

Modified	Introduced delete permission to Grant endpoint. Migrated to v2 endpoints for old PAM methods. Resolved warnings caused by the use of deprecated methods.
Added	Added TokenManager and GrantToken method.
Fixed	Removed Audit tests. Resolved incorrectly reported SDK version.

Modified

Add users join, leave and timeout fields to interval event

Modified

implement Objects API

Modified

implement Signal

Modified

implement Fire

Modified

implement history Message Counts

Modified

Rename await to pn_await

Modified

Rename async to pn_async

Modified	Add history delete Add telemetry manager
Fixed	Fix linter warnings Fix plugins versions and remove unused plugins

Modified

Added daemon option for PNConfig

Fixed

Fixed issues with managing push notifications

Fixed

Fix typo on announce_status.

Fixed

Fix aiohttp v1.x.x and v2.x.x compatibility

Fixed	Fix missing encoder for path elements
Added

Added

Support log_verbosity in pnconfiguration to enable HTTP logging.

Fixed	Handle interval presence messages gracefully if they do not contain a UUID.
Added	Support custom cryptography module when using GAE
Modified	designate the request thread as non-daemon to keep the SDK running.

Fixed

Fix on state object type definition.

Modified

new pubnub domain
native demo app
fixed HTTPAdapter config
add a new Python 3.6.0 config to travis builds
fix blocking Ctrl+C bug

Modified

Add reconnection managers

Modified

do not strip plus sign when encoding message.

Modified

Adjusting maximum pool size for requests installations
Adding Publisher UUID

Modified

Fixing up packaging configuration for py3

Modified

Initial Release

v9.1.0

v9.0.0

v8.1.0

v8.0.0

v7.4.4

v7.4.3

v7.4.2

v7.4.1

v7.4.0

v7.3.2

v7.3.1

v7.3.0

7.2.0

7.1.0

7.0.2

7.0.1

7.0.0

v6.5.1

v6.5.0

v6.4.1

v6.4.0

v6.3.3

v6.3.2

v6.3.1

v6.3.0

v6.2.0

v6.1.0

v6.0.1

v6.0.0

v5.5.0

v5.4.0

v5.3.1

v5.3.0

v5.2.1

v5.2.0

v5.1.4

v5.1.3

v5.1.2

v5.1.1

v5.1.0

v5.0.1

v5.0.0

v4.8.1

v4.8.0

v4.7.0

v4.6.1

v4.6.0

v4.5.4

v4.5.3

v4.5.2

v4.5.1

v4.5.0

v4.4.0

v4.3.0

v4.2.1

v4.2.0

v4.1.7

v4.1.6

v4.1.5

v4.1.4

v4.1.3

v4.1.2

v4.1.1

v4.1.0

v4.0.13

v4.0.12

v4.0.11

v4.0.10

v4.0.9

v4.0.8

v4.0.7

v4.0.6

v4.0.5

v4.0.4

v4.0.3

v4.0.2

v4.0.1

v4.0.0