Troubleshooting Python SDK

This page explains how to identify your SDK version and handle errors in the PubNub Python Software Development Kit (SDK).

How to find the version of your SDK

Access your SDK version via constant

The following snippet demonstrates how to retrieve and display the SDK version using the PubNub class.

Steps to access the SDK version

1. Import the required modules.
2. Retrieve the version with PubNub.SDK_VERSION.
3. Log or print the version for future reference.

1import os
2from pubnub.pnconfiguration import PNConfiguration
3from pubnub.pubnub import PubNub
4

5def main():
6    # Display the current SDK version
7    print(f"Current PubNub SDK Version: {PubNub.SDK_VERSION}")
8    
9    # Optional: You can also initialize a PubNub instance and check the version
10    pn_config = PNConfiguration()
11    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')  # Replace 'demo' with your subscribe key from the PubNub Admin Portal
12    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
13    
14    pubnub = PubNub(pn_config)
15    print(f"Initialized PubNub with SDK Version: {pubnub.SDK_VERSION}")
16

17if __name__ == "__main__":
18    main()

show all 18 lines

Error handling with sync()

When you call sync(), errors are wrapped by either Envelope or PubNubException. Both provide the following fields:

• e.result - a request result object in case of success, otherwise None

• e.status - a PNStatus object with useful information about the finished request. You can check whether it was an error or a success using the e.is_error() helper.

sync() usage

1import os
2from pubnub.pnconfiguration import PNConfiguration
3from pubnub.pubnub import PubNub
4from pubnub.exceptions import PubNubException
5

6def publish_message(pubnub: PubNub):
7    try:
8        envelope = pubnub.publish() \
9            .channel("my_channel") \
10            .message("hello!") \
11            .sync()
12        print(f"Published message with timetoken: {envelope.result.timetoken}")
13        print(f"Full result: {str(envelope.result)}")
14    except PubNubException as e:
15        print(f"Error: {str(e)}")
16        print(f"Error category: {e.status.category}")
17

18def main():
19    # Configuration for PubNub instance
20    pn_config = PNConfiguration()
21    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')  # Replace 'demo' with your subscribe key from the PubNub Admin Portal
22    pn_config.publish_key = os.getenv('PUBLISH_KEY', 'demo')  # Replace 'demo' with your publish key from the PubNub Admin Portal
23    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
24

25    # Initialize PubNub client
26    pubnub = PubNub(pn_config)
27

28    # Publish a message
29    publish_message(pubnub)
30

31if __name__ == "__main__":
32    main()

show all 32 lines

Error handling with async()

When you call async(), you can check for errors using the status.is_error() helper:

1import os
2import time
3from pubnub.pnconfiguration import PNConfiguration
4from pubnub.pubnub import PubNub
5from pubnub.callbacks import SubscribeCallback
6from pubnub.enums import PNStatusCategory, PNOperationType
7

8class MySubscribeCallback(SubscribeCallback):
9    def status(self, pubnub, status):
10        if status.is_error():
11            print(f"Error: {str(status.error_data.exception)}")
12            print(f"Error category: {status.category}")
13        elif status.category == PNStatusCategory.PNConnectedCategory:
14            print("Connected to PubNub!")
15        elif status.category == PNStatusCategory.PNReconnectedCategory:
16            print("Reconnected to PubNub!")
17        elif status.category == PNStatusCategory.PNDisconnectedCategory:
18            print("Disconnected from PubNub!")
19

20    def message(self, pubnub, message):
21        print(f"Received message: {str(message.message)}")
22        print(f"Channel: {message.channel}")
23        print(f"Publisher: {message.publisher}")
24        print(f"Timetoken: {message.timetoken}")
25

26    def presence(self, pubnub, presence):
27        print(f"Presence event: {presence.event}")
28        print(f"UUID: {presence.uuid}")
29        print(f"Channel: {presence.channel}")
30        print(f"Occupancy: {presence.occupancy}")
31

32def main():
33    # Configuration for PubNub instance
34    pn_config = PNConfiguration()
35    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')  # Replace 'demo' with your subscribe key from the PubNub Admin Portal
36    pn_config.publish_key = os.getenv('PUBLISH_KEY', 'demo')  # Replace 'demo' with your publish key from the PubNub Admin Portal
37    pn_config.user_id = os.getenv('USER_ID', 'my_custom_user_id')
38

39    # Initialize PubNub client
40    pubnub = PubNub(pn_config)
41

42    # Add listener
43    listener = MySubscribeCallback()
44    pubnub.add_listener(listener)
45

46    # Subscribe to channel
47    pubnub.subscribe().channels("my_channel").execute()
48    
49    print("Subscribed to 'my_channel'. Waiting for messages...")
50    
51    # Example of a publish operation with a callback
52    def publish_callback(result, status):
53        if status.is_error():
54            print(f"Error: {str(status.error_data.exception)}")
55            print(f"Error category: {status.category}")
56        else:
57            print(f"Publish successful: {str(result)}")
58    
59    # Publish a message with the callback
60    pubnub.publish().channel("my_channel").message("Hello from callback example!").pn_async(publish_callback)
61    
62    # Keep the program running to receive messages
63    try:
64        time.sleep(10)  # Run for 10 seconds
65    except KeyboardInterrupt:
66        pass
67    finally:
68        pubnub.unsubscribe_all()
69        pubnub.stop()
70

71if __name__ == "__main__":
72    main()

show all 72 lines