Configuration API for PubNub Python-Twisted SDK
Deprecated
NOTICE: Based on current web trends and our own usage data, PubNub's Python Twisted SDK is deprecated as of May 1, 2019. Deprecation means we will no longer be updating the Python Twisted SDK but will continue to support users currently using it. Please feel free to use our other Python SDK offerings as they will continue to be supported and maintained. If you would like to use the Python Twisted SDK specifically, we would love to work with you on keeping this project alive!
Python-Twisted complete API reference for building real-time applications on PubNub, including basic usage and sample code.
Configuration
PNConfiguration instance is storage for user-provided information which describe further PubNub client behavior. Configuration instance contain additional set of properties which allow to perform precise PubNub client configuration.
Method(s)
To create configuration instance you can use the following function in the Python-Twisted SDK:
pnconfig = PNConfiguration()
| Properties | Type | Required | Default | Description |
|---|---|---|---|---|
subscribe_key | String | Yes | subscribe_key from Admin Portal. | |
publish_key | String | Optional | None | publish_key from Admin Portal (only required if publishing). |
secret_key | String | Optional | None | secret_key (only required for modifying/revealing access permissions) |
cipher_key | String | Optional | None | If cipher_key is passed, all communications to/from PubNub will be encrypted. |
uuid | String | Yes | UUID to use. You should set a unique UUID to identify the user or the device that connects to PubNub. If you don't set the UUID, you won't be able to connect to PubNub. | |
auth_key | String | Optional | None | If Access Manager is utilized, client will use this authKey in all restricted requests. |
ssl | Boolean | Optional | False | Use SSL. |
connect_timeout | Int | Optional | 5 | How long to wait before giving up connection to client.The value is in seconds. |
subscribe_timeout | Int | Optional | 310 | How long to keep the subscribe loop running before disconnect.The value is in seconds. |
non_subscribe_request_timeout | Int | Optional | 10 | On non subscribe operations, how long to wait for server response.The value is in seconds. |
filter_expression | String | Optional | None | Feature to subscribe with a custom filter expression. |
heartbeat_notification_options | PNHeartbeatNotificationOptions | Optional | PNHeartbeatNotificationOptions.FAILURES | Heartbeat notifications, by default, the SDK will alert on failed heartbeats (equivalent to: PNHeartbeatNotificationOptions.FAILURES). Other options such as all heartbeats ( PNHeartbeatNotificationOptions.ALL) or no heartbeats (PNHeartbeatNotificationOptions.NONE) are supported. |
reconnect_policy | PNReconnectionPolicy | Optional | PNReconnectionPolicy.NONE | Set to PNReconnectionPolicy.LINEAR for automatic reconnects. Use option PNReconnectionPolicy.NONE to disable automatic reconnects.Use option PNReconnectionPolicy.EXPONENTIAL to set exponential retry interval. |
origin | String | Optional | ps.pndsn.com | Custom origin if needed. |
suppress_leave_events | Boolean | Optional | False | If True, the client doesn't send presence leave events during the unsubscribe process. |
enable_subscribe | Boolean | Optional | True | You can disable the subscribe loop if you don't need to perform subscribe operations. By default, subscribe loop is enabled and extra threads/loops are started. They should be explicitly stopped by pubnub.stop() method invocation. |
daemon | Boolean | Optional | False | When set to True, spawned thread won't keep the application running after SIGTERM. (ctrl-c from command line, for example) |
disable_token_manager | Boolean | Optional | False | When set to True, the Token Manager System (TMS) will be disabled. Even if there are applicable tokens, no requests will be authorized. |
Basic Usage
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pnconfiguration import PNConfiguration
pn_configuration = PNConfiguration()
# subscribe_key from Admin Portal
pn_configuration.subscribe_key = "my_subscribe_key" // required
# publish_key from Admin Portal (only required if publishing)
pn_configuration.publish_key = "my_publish_key"
# secret_key (only required for modifying/revealing access permissions)
pn_configuration.secret_key = "my_secret_key"
# if cipher_key is passed, all communicatons to/from pubnub will be encrypted
pn_configuration.cipher_key = "my_cipher_key"
# UUID to be used as a device identifier, won't connect if not set
pn_configuration.uuid = "my_custom_uuid"
# if Access Manager is utilized, client will use this authKey in all restricted
# requests
Initialization
Add PubNub to your project using one of the procedures defined in the Getting Started guide.
Dependency
- PyOpenSSL
- Service-Identity
Include the Python SDK in your code
from pubnub.pubnub_twisted import PubNubTwisted
Description
This function is used for initializing the PubNub Client API context. This function must be called before attempting to utilize any API functionality in order to establish account level credentials such as publish_key and subscribe_key.
Note
You must call start() to initiate the PubNub Client API in Python-Twisted.
Method(s)
To Initialize PubNub you can use the following method(s) in the Python-Twisted SDK:
pubnub = PubNubTwisted(my_pnconfig)
| Parameter | Type | Required | Description |
|---|---|---|---|
pn_configuration | PNConfiguration | Yes | Goto Configuration for more details. |
Basic Usage
Initialize the PubNub client API
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = "my_subkey"
pnconfig.publish_key = "my_pubkey"
pnconfig.ssl = True
pnconfig.uuid = "my_custom_uuid"
pubnub = PubNubTwisted(pnconfig)
Returns
It returns the PubNub instance for invoking PubNub APIs like publish(), subscribe(), history(), here_now(), etc.
Other Examples
Initialize a non-secure client
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = "my_subkey"
pnconfig.publish_key = "my_pubkey"
pnconfig.ssl = False
pnconfig.uuid = "my_custom_uuid"
pubnub = PubNubTwisted(pnconfig)
Initialization for a Read-Only client
In the case where a client will only read messages and never publish to a channel, you can simply omit the publish_key when initializing the client:
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = "my_subkey"
pubnub = PubNubTwisted(pnconfig)
Use a custom UUID
Set a custom UUID to identify your users.
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = 'mySubscribeKey'
pnconfig.publish_key = 'myPublishKey'
pnconfig.uuid = 'myUniqueUUID'
pubnub = PubNubTwisted(pnconfig)
Initializing with SSL Enabled
This examples demonstrates how to enable PubNub Transport Layer Encryption with SSL. Just initialize the client with ssl set to True. The hard work is done, now the PubNub API takes care of the rest. Just subscribe and publish as usual and you are good to go.
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = "my_subkey"
pnconfig.publish_key = "my_pubkey"
pnconfig.ssl = True
pnconfig.uuid = "my_custom_uuid"
pubnub = PubNubTwisted(pnconfig)
Initializing with Access Manager
Requires Access Manager add-on
This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.
Note
Anyone with the secret_key can grant and revoke permissions to your app. Never let your secret_key be discovered, and to only exchange it / deliver it securely. Only use the secret_key on secure server-side platforms.
When you init with secret_key, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.
For applications that will administer Access Manager permissions, the API is initialized with the secret_key as in the following example:
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = "my_subkey"
pnconfig.publish_key = "my_pubkey"
pnconfig.secret_key = "my_secretkey"
pnconfig.uuid = "my_custom_uuid"
pnconfig.ssl = True
pubnub = PubNubTwisted(pnconfig)
Now that the pubnub object is instantiated the client will be able to access the Access Manager functions. The pubnub object will use the secret_key to sign all Access Manager messages to the PubNub Network.
Initializing with a custom event loop
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pubnub_twisted import PubNubTwisted
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.subscribe_key = "my_subkey"
pnconfig.publish_key = "my_pubkey"
pubnub = PubNubTwisted(pnconfig, custom_ioloop=my_event_loop)
Filter Expression
Requires Stream Controller add-on
This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.
Stream filtering allows a subscriber to apply a filter to only receive messages that satisfy the conditions of the filter. The message filter is set by the subscribing client(s) but it is applied on the server side thus preventing unwanted messages (those that do not meet the conditions of the filter) from reaching the subscriber.
To set or get message filters, you can use the following methods. To learn more about filtering, refer to the Publish Messages documentation.
Method(s)
Set Filter Expression
The property accepts a string.
Get Filter Expression
The property returns a string.
Basic Usage
Note
Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.
from pubnub.pnconfiguration import PNConfiguration
pnconfig = PNConfiguration()
pnconfig.filter_expression = "such=wow"
filter = pnconfig.filter_expression