plexwebsocket 0.0.14__tar.gz → 0.1.0__tar.gz

plexwebsocket-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 jjlawren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

plexwebsocket-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: plexwebsocket
+Version: 0.1.0
+Summary: Support for issuing callbacks in response to Plex websocket updates.
+Author: Jason Lawrence
+Author-email: Jason Lawrence <jjlawren@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: aiohttp
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/jjlawren/python-plexwebsocket
+Description-Content-Type: text/markdown
+
+# python-plexwebsocket
+Async library to react to events issued over Plex websockets.
+
+## Example use
+```python
+import asyncio
+import logging
+from plexapi.server import PlexServer
+from plexwebsocket import PlexWebsocket, SIGNAL_CONNECTION_STATE
+
+logging.basicConfig(level=logging.DEBUG)
+
+baseurl = "http://<PLEX_SERVER_IP>:32400"
+token = "<YOUR_TOKEN_HERE>"
+plex = PlexServer(baseurl, token)
+
+
+def print_info(msgtype, data, error):
+    if msgtype == SIGNAL_CONNECTION_STATE:
+        print(f"State: {data} / Error: {error}")
+    else:
+        print(f"Data: {data}")
+
+
+async def main():
+    ws = PlexWebsocket(plex, print_info, subscriptions=["playing", "status"])
+    await ws.listen()
+
+
+if __name__ == "__main__":
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main())
+```

{plexwebsocket-0.0.14 → plexwebsocket-0.1.0}/README.md

@@ -10,21 +10,24 @@ from plexwebsocket import PlexWebsocket, SIGNAL_CONNECTION_STATE
 
 logging.basicConfig(level=logging.DEBUG)
 
-baseurl = 'http://<PLEX_SERVER_IP>:32400'
-token = '<YOUR_TOKEN_HERE>'
+baseurl = "http://<PLEX_SERVER_IP>:32400"
+token = "<YOUR_TOKEN_HERE>"
 plex = PlexServer(baseurl, token)
 
+
 def print_info(msgtype, data, error):
     if msgtype == SIGNAL_CONNECTION_STATE:
         print(f"State: {data} / Error: {error}")
     else:
         print(f"Data: {data}")
 
+
 async def main():
     ws = PlexWebsocket(plex, print_info, subscriptions=["playing", "status"])
     await ws.listen()
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     loop = asyncio.get_event_loop()
     loop.run_until_complete(main())
 ```

plexwebsocket-0.0.14/plexwebsocket.py → plexwebsocket-0.1.0/plexwebsocket/__init__.py

@@ -1,10 +1,15 @@
 """Support for issuing callbacks for Plex client updates via websockets."""
+
 import asyncio
-from datetime import datetime
 import logging
+import re
+from datetime import datetime
+from importlib.metadata import version
 
 import aiohttp
 
+__version__ = version("plexwebsocket")
+
 _LOGGER = logging.getLogger(__name__)
 
 SIGNAL_CONNECTION_STATE = "plexwebsocket_state"
@@ -13,13 +18,22 @@ ERROR_AUTH_FAILURE = "Authorization failure"
 ERROR_TOO_MANY_RETRIES = "Too many retries"
 ERROR_UNKNOWN = "Unknown"
 
-MAX_FAILED_ATTEMPTS = 5
+MAX_FAILED_ATTEMPTS = 8
 
 STATE_CONNECTED = "connected"
 STATE_DISCONNECTED = "disconnected"
 STATE_STARTING = "starting"
 STATE_STOPPED = "stopped"
 
+PLEX_TOKEN_PARAM = "X-Plex-Token"
+
+_TOKEN_RE = re.compile(rf"({PLEX_TOKEN_PARAM}=)[^&'\"\s]+", re.IGNORECASE)
+
+
+def _redact(error):
+    """Return the error text with the Plex token masked."""
+    return _TOKEN_RE.sub(r"\1REDACTED", str(error))
+
 
 class WebsocketPlayer:  # pylint: disable=too-few-public-methods
     """Represent an individual player state in the Plex websocket stream."""
@@ -38,9 +52,7 @@ class WebsocketPlayer:  # pylint: disable=too-few-public-methods
         posdiff = (new_position - self.position) / 1000
         diffdiff = timediff - posdiff
 
-        if abs(diffdiff) > 5:
-            return True
-        return False
+        return abs(diffdiff) > 5
 
 
 class PlexWebsocket:
@@ -52,7 +64,7 @@ class PlexWebsocket:
         self,
         plex_server,
         callback,
-        subscriptions=["playing"],
+        subscriptions=("playing",),
         session=None,
         verify_ssl=True,
     ):
@@ -144,30 +156,22 @@ class PlexWebsocket:
                         break
 
         except aiohttp.ClientResponseError as error:
-            if error.code == 401:
-                _LOGGER.error("Credentials rejected: %s", error)
+            if error.status >= 500:
+                # Transient proxy/server failure, retry
+                await self._retry(error)
+                return
+            if error.status == 401:
+                _LOGGER.error("Credentials rejected: %s", _redact(error))
                 self._error_reason = ERROR_AUTH_FAILURE
             else:
-                _LOGGER.error("Unexpected response received: %s", error)
+                _LOGGER.error("Unexpected response received: %s", _redact(error))
                 self._error_reason = ERROR_UNKNOWN
             self.state = STATE_STOPPED
-        except (aiohttp.ClientConnectionError, asyncio.TimeoutError) as error:
-            if self.failed_attempts >= MAX_FAILED_ATTEMPTS:
-                self._error_reason = ERROR_TOO_MANY_RETRIES
-                self.state = STATE_STOPPED
-            elif self.state != STATE_STOPPED:
-                retry_delay = min(2 ** (self.failed_attempts - 1) * 30, 300)
-                self.failed_attempts += 1
-                _LOGGER.error(
-                    "Websocket connection failed, retrying in %ds: %s",
-                    retry_delay,
-                    error,
-                )
-                self.state = STATE_DISCONNECTED
-                await asyncio.sleep(retry_delay)
-        except Exception as error:  # pylint: disable=broad-except
+        except (TimeoutError, aiohttp.ClientConnectionError) as error:
+            await self._retry(error)
+        except Exception as error:  # noqa: BLE001
             if self.state != STATE_STOPPED:
-                _LOGGER.exception("Unexpected exception occurred: %s", error)
+                _LOGGER.error("Unexpected exception occurred: %s", _redact(error))
                 self._error_reason = ERROR_UNKNOWN
                 self.state = STATE_STOPPED
         else:
@@ -178,6 +182,22 @@ class PlexWebsocket:
                 self.players.clear()
                 await asyncio.sleep(5)
 
+    async def _retry(self, error):
+        """Retry with backoffs."""
+        if self.failed_attempts >= MAX_FAILED_ATTEMPTS:
+            self._error_reason = ERROR_TOO_MANY_RETRIES
+            self.state = STATE_STOPPED
+        elif self.state != STATE_STOPPED:
+            retry_delay = min(5 * 2**self.failed_attempts, 60)
+            self.failed_attempts += 1
+            _LOGGER.error(
+                "Websocket connection failed, retrying in %ds: %s",
+                retry_delay,
+                _redact(error),
+            )
+            self.state = STATE_DISCONNECTED
+            await asyncio.sleep(retry_delay)
+
     def player_event(self, msg):
         """Determine if messages relate to an interesting player event."""
         should_fire = False

plexwebsocket-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["uv_build>=0.9,<0.14"]
+build-backend = "uv_build"
+
+[project]
+name = "plexwebsocket"
+version = "0.1.0"
+description = "Support for issuing callbacks in response to Plex websocket updates."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = ["aiohttp"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+]
+
+[[project.authors]]
+name = "Jason Lawrence"
+email = "jjlawren@users.noreply.github.com"
+
+[project.urls]
+Homepage = "https://github.com/jjlawren/python-plexwebsocket"
+
+[dependency-groups]
+dev = [
+    "pre-commit",
+    "pytest",
+]
+
+[tool.uv.build-backend]
+module-root = ""

plexwebsocket-0.1.0/pyproject.toml.orig

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["uv_build>=0.9,<0.14"]
+build-backend = "uv_build"
+
+[project]
+name = "plexwebsocket"
+version = "0.1.0"
+description = "Support for issuing callbacks in response to Plex websocket updates."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Jason Lawrence", email = "jjlawren@users.noreply.github.com" }]
+requires-python = ">=3.11"
+dependencies = ["aiohttp"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit",
+    "pytest",
+]
+
+[project.urls]
+Homepage = "https://github.com/jjlawren/python-plexwebsocket"
+
+[tool.uv.build-backend]
+module-root = ""

plexwebsocket-0.0.14/PKG-INFO

@@ -1,46 +0,0 @@
-Metadata-Version: 2.1
-Name: plexwebsocket
-Version: 0.0.14
-Summary: Support for issuing callbacks in response to Plex websocket updates.
-Home-page: https://github.com/jjlawren/python-plexwebsocket/
-Author: Jason Lawrence
-Author-email: jjlawren@users.noreply.github.com
-License: MIT
-Description: # python-plexwebsocket
-        Async library to react to events issued over Plex websockets.
-        
-        ## Example use
-        ```python
-        import asyncio
-        import logging
-        from plexapi.server import PlexServer
-        from plexwebsocket import PlexWebsocket, SIGNAL_CONNECTION_STATE
-        
-        logging.basicConfig(level=logging.DEBUG)
-        
-        baseurl = 'http://<PLEX_SERVER_IP>:32400'
-        token = '<YOUR_TOKEN_HERE>'
-        plex = PlexServer(baseurl, token)
-        
-        def print_info(msgtype, data, error):
-            if msgtype == SIGNAL_CONNECTION_STATE:
-                print(f"State: {data} / Error: {error}")
-            else:
-                print(f"Data: {data}")
-        
-        async def main():
-            ws = PlexWebsocket(plex, print_info, subscriptions=["playing", "status"])
-            await ws.listen()
-        
-        if __name__ == '__main__':
-            loop = asyncio.get_event_loop()
-            loop.run_until_complete(main())
-        ```
-        
-Platform: any
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Description-Content-Type: text/markdown

plexwebsocket-0.0.14/plexwebsocket.egg-info/PKG-INFO

@@ -1,46 +0,0 @@
-Metadata-Version: 2.1
-Name: plexwebsocket
-Version: 0.0.14
-Summary: Support for issuing callbacks in response to Plex websocket updates.
-Home-page: https://github.com/jjlawren/python-plexwebsocket/
-Author: Jason Lawrence
-Author-email: jjlawren@users.noreply.github.com
-License: MIT
-Description: # python-plexwebsocket
-        Async library to react to events issued over Plex websockets.
-        
-        ## Example use
-        ```python
-        import asyncio
-        import logging
-        from plexapi.server import PlexServer
-        from plexwebsocket import PlexWebsocket, SIGNAL_CONNECTION_STATE
-        
-        logging.basicConfig(level=logging.DEBUG)
-        
-        baseurl = 'http://<PLEX_SERVER_IP>:32400'
-        token = '<YOUR_TOKEN_HERE>'
-        plex = PlexServer(baseurl, token)
-        
-        def print_info(msgtype, data, error):
-            if msgtype == SIGNAL_CONNECTION_STATE:
-                print(f"State: {data} / Error: {error}")
-            else:
-                print(f"Data: {data}")
-        
-        async def main():
-            ws = PlexWebsocket(plex, print_info, subscriptions=["playing", "status"])
-            await ws.listen()
-        
-        if __name__ == '__main__':
-            loop = asyncio.get_event_loop()
-            loop.run_until_complete(main())
-        ```
-        
-Platform: any
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Description-Content-Type: text/markdown

plexwebsocket-0.0.14/plexwebsocket.egg-info/SOURCES.txt

@@ -1,8 +0,0 @@
-README.md
-plexwebsocket.py
-setup.py
-plexwebsocket.egg-info/PKG-INFO
-plexwebsocket.egg-info/SOURCES.txt
-plexwebsocket.egg-info/dependency_links.txt
-plexwebsocket.egg-info/requires.txt
-plexwebsocket.egg-info/top_level.txt

plexwebsocket-0.0.14/plexwebsocket.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

plexwebsocket-0.0.14/plexwebsocket.egg-info/requires.txt

@@ -1 +0,0 @@
-aiohttp

plexwebsocket-0.0.14/plexwebsocket.egg-info/top_level.txt

@@ -1 +0,0 @@
-plexwebsocket

plexwebsocket-0.0.14/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

plexwebsocket-0.0.14/setup.py

@@ -1,28 +0,0 @@
-from setuptools import setup
-
-with open('README.md') as f:
-    long_description = f.read()
-
-VERSION="0.0.14"
-
-setup(
-    name='plexwebsocket',
-    version=VERSION,
-    description='Support for issuing callbacks in response to Plex websocket updates.',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    url='https://github.com/jjlawren/python-plexwebsocket/',
-    license='MIT',
-    author='Jason Lawrence',
-    author_email='jjlawren@users.noreply.github.com',
-    platforms='any',
-    py_modules=['plexwebsocket'],
-    install_requires=['aiohttp'],
-    classifiers=[
-        'License :: OSI Approved :: MIT License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-    ]
-)