Troubleshooting Python-Asyncio SDK

This page explains how to find the version of the PubNub Python-Asyncio Software Development Kit (SDK) and how to log it for troubleshooting and support.

How to find the version of your SDK

Knowing your Software Development Kit (SDK) version helps with troubleshooting and reporting bugs. You can access the SDK version using the SDK_VERSION constant.

Access your SDK version via constant

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

Steps to access the SDK version

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

1import asyncio
2import os
3from pubnub.pnconfiguration import PNConfiguration
4from pubnub.pubnub_asyncio import PubNubAsyncio
5

6

7async def display_sdk_info(pubnub: PubNubAsyncio):
8    # Get and display the SDK version
9    sdk_version = PubNubAsyncio.SDK_VERSION
10    print(f"PubNub Asyncio SDK Version: {sdk_version}")
11

12

13if __name__ == "__main__":
14    # Configuration for PubNub instance
15    pn_config = PNConfiguration()
16    pn_config.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')  # Replace 'demo' with your subscribe key from PubNub Admin Portal
17    pn_config.publish_key = os.getenv('PUBLISH_KEY', 'demo')      # Replace 'demo' with your publish key from PubNub Admin Portal
18    pn_config.user_id = "sdk_version_demo_user"
19

20    # Create and configure the event loop
21    loop = asyncio.new_event_loop()
22    asyncio.set_event_loop(loop)
23    
24    # Initialize PubNub
25    pubnub = PubNubAsyncio(pn_config)
26    
27    try:
28        # Display SDK version information
29        loop.run_until_complete(display_sdk_info(pubnub))
30    finally:
31        # Clean up resources
32        loop.run_until_complete(pubnub.stop())
33        loop.close()

show all 33 lines

Once you retrieve the SDK version, you can use this information for several tasks. For example:

• Reporting issues to support
• Diagnosing compatibility problems
• Verifying if a specific feature is available
• Checking if your application needs an upgrade

Log the SDK version during initialization

You can also log the SDK version during initialization to keep a record of versions used across deployments.

1import os
2import logging
3import asyncio
4from pubnub import set_stream_logger
5from pubnub.pnconfiguration import PNConfiguration
6from pubnub.pubnub_asyncio import PubNubAsyncio
7

8# Set up logging
9logging.basicConfig(level=logging.INFO)
10set_stream_logger('pubnub', logging.INFO)
11logger = logging.getLogger('pubnub_app')
12

13async def init_and_log_version(pubnub):
14    logger.info(f"Initializing PubNub with SDK version: {PubNubAsyncio.SDK_VERSION}")
15    
16    # Demonstrate a basic operation to show logging in action
17    try:
18        time_response = await pubnub.time().future()
19        logger.info(f"Current PubNub time: {time_response.result}")
20    except Exception as e:
21        logger.error(f"Error getting PubNub time: {e}")
22        
23    return pubnub
24

25if __name__ == "__main__":
26    loop = asyncio.new_event_loop()
27    asyncio.set_event_loop(loop)
28    
29    # Configure PubNub
30    pnconfig = PNConfiguration()
31    pnconfig.subscribe_key = os.getenv('SUBSCRIBE_KEY', 'demo')  # Replace 'demo' with your subscribe key from PubNub Admin Portal
32    pnconfig.publish_key = os.getenv('PUBLISH_KEY', 'demo')  # Replace 'demo' with your publish key from PubNub Admin Portal
33    pnconfig.user_id = "logging_demo_user"
34    pnconfig.ssl = True
35    
36    pubnub = PubNubAsyncio(pnconfig)
37    
38    try:
39        loop.run_until_complete(init_and_log_version(pubnub))
40        # Additional operations would go here
41    finally:
42        loop.run_until_complete(pubnub.stop())
43        loop.close()

show all 43 lines