improving naming semantics "urlProvider"->"url_provider"

Author: jkyberneees

README.md

@@ -1,13 +1,20 @@
 # Realtime Pub/Sub Client for Python
 
-The `realtime-pubsub-client-python` is a Python client library for interacting with [Realtime Pub/Sub](https://realtime.21no.de) applications. It enables developers to manage real-time WebSocket connections, handle subscriptions, and process messages efficiently. The library provides a simple and flexible API to interact with realtime applications, supporting features like publishing/sending messages, subscribing to topics, handling acknowledgements, and waiting for replies with timeout support.
+The `realtime-pubsub-client-python` is a Python client library for interacting
+with [Realtime Pub/Sub](https://realtime.21no.de) applications. It enables developers to manage real-time WebSocket
+connections, handle subscriptions, and process messages efficiently. The library provides a simple and flexible API to
+interact with realtime applications, supporting features like publishing/sending messages, subscribing to topics,
+handling acknowledgements, and waiting for replies with timeout support.
 
 ## Features
 
-- **WebSocket Connection Management**: Seamlessly connect and disconnect from the Realtime Pub/Sub service with automatic reconnection support.
+- **WebSocket Connection Management**: Seamlessly connect and disconnect from the Realtime Pub/Sub service with
+  automatic reconnection support.
 - **Topic Subscription**: Subscribe and unsubscribe to topics for receiving messages.
-- **Topic Publishing**: [Publish](https://realtime.21no.de/documentation/#publishers) messages to specific topics with optional message types and compression.
-- **Message Sending**: [Send](https://realtime.21no.de/documentation/#websocket-inbound-messaging) messages to backend applications with optional message types and compression.
+- **Topic Publishing**: [Publish](https://realtime.21no.de/documentation/#publishers) messages to specific topics with
+  optional message types and compression.
+- **Message Sending**: [Send](https://realtime.21no.de/documentation/#websocket-inbound-messaging) messages to backend
+  applications with optional message types and compression.
 - **Event Handling**: Handle incoming messages with custom event listeners.
 - **Acknowledgements and Replies**: Wait for gateway acknowledgements or replies to messages with timeout support.
 - **Error Handling**: Robust error handling and logging capabilities.
@@ -37,6 +44,7 @@ from realtime_pubsub_client import RealtimeClient
 
 APP_ID = 'your-app-id'
 
+
 async def main():
     async def get_url():
         # replace with your access token retrieval strategy
@@ -49,7 +57,7 @@ async def main():
     client_options = {
         'logger': logging.getLogger('RealtimeClient'),
         'websocket_options': {
-            'urlProvider': get_url,
+            'url_provider': get_url,
         },
     }
     client = RealtimeClient(client_options)
@@ -65,6 +73,7 @@ async def main():
     await client.connect()
     await client.wait_for('session.started')
 
+
 asyncio.run(main())
 ```
 
@@ -79,6 +88,7 @@ def handle_message(message, reply_fn):
     # Message handling logic here
     print('Received message:', message['data']['payload'])
 
+
 client.on('topic1.action1', handle_message)
 ```
 
@@ -110,6 +120,7 @@ async def handle_message(message, reply_fn):
     # Sending a reply
     await reply_fn('Message received!', 'ok')
 
+
 client.on('topic1.text-message', handle_message)
 ```
 
@@ -157,9 +168,11 @@ Handle errors and disconnections:
 def on_error(error):
     print('WebSocket error:', error)
 
+
 def on_close(event):
     print('WebSocket closed:', event)
 
+
 client.on('error', on_error)
 client.on('close', on_close)
 ```
@@ -192,13 +205,15 @@ Creates a new `RealtimeClient` instance.
   await client.disconnect()
   ```
 
-- **`subscribe_remote_topic(topic)`**: [Subscribes](https://realtime.21no.de/documentation/#subscribers) the connection to a remote topic.
+- **`subscribe_remote_topic(topic)`**: [Subscribes](https://realtime.21no.de/documentation/#subscribers) the connection
+  to a remote topic.
 
   ```python
   await client.subscribe_remote_topic(topic)
   ```
 
-- **`unsubscribe_remote_topic(topic)`**: [Unsubscribes](https://realtime.21no.de/documentation/#subscribers) the connection from a remote topic.
+- **`unsubscribe_remote_topic(topic)`**: [Unsubscribes](https://realtime.21no.de/documentation/#subscribers) the
+  connection from a remote topic.
 
   ```python
   await client.unsubscribe_remote_topic(topic)
@@ -260,17 +275,19 @@ This library is licensed under the MIT License.
 
 ---
 
-For more detailed examples and advanced configurations, please refer to the [documentation](https://realtime.21no.de/docs).
+For more detailed examples and advanced configurations, please refer to
+the [documentation](https://realtime.21no.de/docs).
 
 ## Notes
 
 - Ensure that you have an account and an app set up with [Realtime Pub/Sub](https://realtime.21no.de).
-- Customize the `urlProvider` or URL to retrieve the access token for connecting to your realtime application.
+- Customize the `url_provider` or URL to retrieve the access token for connecting to your realtime application.
 - Implement the `get_auth_token` function according to your authentication mechanism.
 - Optionally use the `logger` option to integrate with your application's logging system.
 - Handle errors and disconnections gracefully to improve the robustness of your application.
 - Make sure to handle timeouts when waiting for replies to avoid hanging operations.
 
 ---
 
-Feel free to contribute to this project by submitting issues or pull requests on [GitHub](https://github.com/BackendStack21/realtime-pubsub-client-python).
+Feel free to contribute to this project by submitting issues or pull requests
+on [GitHub](https://github.com/BackendStack21/realtime-pubsub-client-python).

demos/publish_and_reply.py

@@ -21,7 +21,7 @@ async def get_url():
     config = {
         'logger': logging.getLogger('RealtimeClient'),
         'websocket_options': {
-            'urlProvider': get_url,
+            'url_provider': get_url,
         }
     }
     client = RealtimeClient(config)

demos/rpc/client.py

@@ -23,7 +23,7 @@ async def get_url():
     config = {
         'logger': logging.getLogger('RealtimeClient'),
         'websocket_options': {
-            'urlProvider': get_url,
+            'url_provider': get_url,
         }
     }
     client = RealtimeClient(config)

demos/rpc/server.py

@@ -23,7 +23,7 @@ async def get_url():
     config = {
         'logger': logging.getLogger('RealtimeClient'),
         'websocket_options': {
-            'urlProvider': get_url,
+            'url_provider': get_url,
         }
     }
     client = RealtimeClient(config)

src/client.py

@@ -340,7 +340,7 @@ async def connect(self):
         """
         Establish a connection to the WebSocket server.
 
-        Initiates the WebSocket connection using the provided URL from the `urlProvider` function.
+        Initiates the WebSocket connection using the provided URL from the `url_provider` function.
         Sets up event handlers for incoming messages, errors, and closure events.
 
         Raises:
@@ -354,7 +354,7 @@ async def connect(self):
         max_backoff = 60
 
         while True:
-            url_provider = self.websocket_options.get('urlProvider')
+            url_provider = self.websocket_options.get('url_provider')
             if callable(url_provider):
                 if asyncio.iscoroutinefunction(url_provider):
                     ws_url = await url_provider()
@@ -368,7 +368,7 @@ async def connect(self):
 
             try:
                 max_float = float('inf')
-                self.ws = await connect(ws_url, max_size=2 ** 20, ping_interval=None,  ping_timeout=None)
+                self.ws = await connect(ws_url, max_size=None, ping_interval=None,  ping_timeout=None)
                 self.logger.info(f'Connected to WebSocket URL: {ws_url[:80]}...')  # Masking the URL for security
                 asyncio.ensure_future(self._receive_messages())
 

tests/test_websocket_client.py

@@ -42,7 +42,7 @@ def setUp(self):
         self.client = RealtimeClient({
             'logger': logging.getLogger('TestRealtimeClient'),
             'websocket_options': {
-                'urlProvider': url
+                'url_provider': url
             }
         })
 

tests/test_websocket_client_remote.py

@@ -28,7 +28,7 @@ def setUp(self):
         config = {
             'logger': logging.getLogger('RealtimeClient'),
             'websocket_options': {
-                'urlProvider': f"wss://genesis.r7.21no.de/apps/{app_id}?access_token={access_token}",
+                'url_provider': f"wss://genesis.r7.21no.de/apps/{app_id}?access_token={access_token}",
             }
         }