serverwamp 1.1.2__tar.gz → 2.0.0__tar.gz

serverwamp-2.0.0/.gitignore

@@ -0,0 +1,101 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains IDEs
+.idea/

{serverwamp-1.1.2 → serverwamp-2.0.0}/LICENSE.md

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 =====================
 
-Copyright © 2020 Justin Turner Arthur
+Copyright © 2020-2026 Justin Turner Arthur
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

{serverwamp-1.1.2 → serverwamp-2.0.0}/PKG-INFO

@@ -1,29 +1,35 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.5
 Name: serverwamp
-Version: 1.1.2
+Version: 2.0.0
 Summary: Components that add Web Application Messaging Protocol features to WebSocket servers.
-Home-page: https://github.com/JustinTArthur/serverwamp
-Author: Justin Turner Arthur
-Author-email: justinarthur@gmail.com
-License: MIT
+Project-URL: Homepage, https://github.com/JustinTArthur/serverwamp
 Project-URL: Documentation, https://serverwamp.readthedocs.io/
-Keywords: WAMP,WebSockets,aiohttp,RPC,pubsub,broker,dealer,ASGI
-Platform: UNKNOWN
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
+Author-email: Justin Turner Arthur <justinarthur@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: ASGI,RPC,WAMP,WebSockets,aiohttp,broker,dealer,pubsub
 Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Internet
 Classifier: Framework :: AsyncIO
 Classifier: Framework :: Trio
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: msgpack<2,>=1.0.0
+Provides-Extra: anyio
+Requires-Dist: anyio>=4.0; extra == 'anyio'
 Provides-Extra: docs
-License-File: LICENSE.md
+Requires-Dist: sphinx<10,>=5.3; extra == 'docs'
+Provides-Extra: trio
+Requires-Dist: trio>=0.25.0; extra == 'trio'
+Description-Content-Type: text/markdown
 
 # serverwamp
 Adds [Web Application Messaging Protocol](https://wamp-proto.org/) features to
@@ -62,7 +68,6 @@ async def delete_doc(document_id):
 @docs_events.route('docs.changes')
 async def subscribe_to_doc_changes(session, changes_subscribers):
     changes_subscribers.add(session)
-    session.send_event(args=('Thanks for subscribing!',))
     yield
     changes_subscribers.remove(session)
 
@@ -71,8 +76,12 @@ async def server_context(app):
 
     async def watch_for_docs_changes():
         async for event in my_db.watch_changes():
-            for session in app['changes_subscribers']:
-                await session.send_event(f'Document changed: {event}')
+            # A copy, as sessions can unsubscribe while events are sent.
+            for session in list(app['changes_subscribers']):
+                await session.send_event(
+                    'docs.changes',
+                    args=(f'Document changed: {event}',)
+                )
 
     watcher = asyncio.create_task(watch_for_docs_changes())
     try:
@@ -103,7 +112,10 @@ if __name__ == '__main__':
 ## Development
 Unit tests can be run with:
 
-    pip install -e .
+    pip install -e . --group ci
     pytest
 
+Linting and type checking can be run with:
 
+    ruff check serverwamp tests examples
+    mypy serverwamp

{serverwamp-1.1.2 → serverwamp-2.0.0}/README.md

@@ -35,7 +35,6 @@ async def delete_doc(document_id):
 @docs_events.route('docs.changes')
 async def subscribe_to_doc_changes(session, changes_subscribers):
     changes_subscribers.add(session)
-    session.send_event(args=('Thanks for subscribing!',))
     yield
     changes_subscribers.remove(session)
 
@@ -44,8 +43,12 @@ async def server_context(app):
 
     async def watch_for_docs_changes():
         async for event in my_db.watch_changes():
-            for session in app['changes_subscribers']:
-                await session.send_event(f'Document changed: {event}')
+            # A copy, as sessions can unsubscribe while events are sent.
+            for session in list(app['changes_subscribers']):
+                await session.send_event(
+                    'docs.changes',
+                    args=(f'Document changed: {event}',)
+                )
 
     watcher = asyncio.create_task(watch_for_docs_changes())
     try:
@@ -76,5 +79,10 @@ if __name__ == '__main__':
 ## Development
 Unit tests can be run with:
 
-    pip install -e .
+    pip install -e . --group ci
     pytest
+
+Linting and type checking can be run with:
+
+    ruff check serverwamp tests examples
+    mypy serverwamp

serverwamp-2.0.0/docs/changelog.rst

@@ -0,0 +1,264 @@
+Changelog
+=========
+
+.. _serverwamp-changelog-2.0.0:
+
+2.0.0
+-----
+
+* Rename session state handlers to session lifespan handlers
+  (``add_session_lifespan_handler()``, ``SessionLifespanHandler``,
+  ``Realm.session_lifespan_handlers`` and
+  ``authed_session_lifespan_handlers``). The old names are deprecated.
+* Fix session lifespan and subscription handlers getting arguments in the wrong
+  parameters when one isn't ``session``, a default arg, or a subscription
+  handler's ``topic_uri``. Such a parameter now keeps its default value, or the
+  handler fails with a ``TypeError`` naming it.
+* Answer subscription handler errors with ``wamp.error.runtime_error``, and end
+  sessions whose session lifespan handlers fail to start with that reason,
+  instead of failing the connection without a reply. Errors are logged, and no
+  longer stop other teardown.
+* Send events for a subscription only after its SUBSCRIBED. Events sent while
+  its handler runs, such as a first event from the handler, are held until
+  then.
+* Add ``serverwamp.SubscribeError`` for subscription handlers to raise to
+  answer a SUBSCRIBE with an error, such as ``wamp.error.not_authorized``.
+* Require Python 3.11 or newer. ``serverwamp.context``, a backport of
+  ``contextlib.asynccontextmanager`` for older Pythons, is removed.
+* Build the asyncio support on ``asyncio.TaskGroup``. As with Trio and AnyIO,
+  task group failures, including unhandled errors while handling a connection,
+  are raised as an ``ExceptionGroup`` instead of the first error alone, and a
+  failing task interrupts the code that started the group.
+* Support current AnyIO and Trio releases, now requiring AnyIO 4 or newer and
+  Trio 0.25 or newer. They can be installed with serverwamp's ``anyio`` and
+  ``trio`` extras.
+* Abort sessions for protocol errors with ``wamp.error.protocol_violation``,
+  per WAMP spec, instead of ``wamp.error.protocol_error``.
+* Handle these client mistakes instead of failing in the connection handler:
+
+  * WebSocket messages that aren't valid JSON or MessagePack, WAMP messages
+    that are too short or have fields of the wrong type, and HELLO after the
+    session is established abort the session with a protocol violation. Message
+    types must be integers, so ``1.0`` and ``true`` are no longer accepted as
+    HELLO.
+  * UNSUBSCRIBE for a subscription the session doesn't have is answered with
+    ``wamp.error.no_such_subscription``.
+  * SUBSCRIBE for a topic without a route is answered with
+    ``wamp.error.invalid_uri``.
+  * HELLO with a null ``authmethods`` that no transport authenticator
+    identifies is aborted with ``wamp.error.authentication_failed``.
+
+* Fix GOODBYE details and reason being read from the wrong fields.
+  ``WAMPGoodbyeRequest`` no longer has a ``request_id``.
+* Give GOODBYE messages a reason instead of none. Replies to a client's GOODBYE
+  and ``WAMPSession.close()`` without a reason use
+  ``wamp.close.goodbye_and_out``, and ``Application.close_sessions()`` uses
+  ``wamp.close.system_shutdown``.
+* End sessions once GOODBYE has been exchanged, instead of when the client
+  disconnects. Subscription and session lifespan handler teardown run then, and
+  the client can start a new session on the same connection with HELLO, as the
+  WAMP spec allows.
+
+  * After the session sends GOODBYE, messages from the client other than its
+    GOODBYE in reply are ignored, per WAMP spec.
+  * Sending for a session that has ended raises
+    ``serverwamp.ConnectionClosed``, including from call handlers still running
+    and from ``send_event()``.
+  * ``Application.handle_session()`` returns whether the session ended with
+    GOODBYE.
+
+* Fix prefix and regex routes handling URIs they don't match. A call or
+  subscription for a URI without an exact route went to the first prefix or
+  regex route added.
+
+  * Applications relying on this should add a catch-all route such as
+    ``prefix_route('')`` after their other prefix and regex routes.
+
+* Answer SUBSCRIBE for a topic the session is already subscribed to with the
+  existing subscription, without running the subscription handler again.
+* Fix RPCs that finish after their client disconnected logging errors,
+  cancelling the session's other calls, and keeping the session in memory.
+
+  * Sends to a disconnected client raise ``serverwamp.ConnectionClosed``, a
+    ``ConnectionError``, instead of the transport's own exception.
+  * ``WAMPSession.close()`` and ``abort()`` succeed when the client already
+    left.
+  * Unhandled exceptions from a session's tasks are logged. With Trio or AnyIO,
+    they no longer end the session.
+
+* Run progressive RPC handlers' ``finally`` blocks as soon as their call is
+  handled, instead of at garbage collection.
+* Wait for tasks started with ``WAMPSession.spawn_task()`` while a session
+  ends, instead of cancelling them.
+* Fix sessions never being cleaned up with Trio. Teardown after ``yield`` in
+  subscription and session lifespan handlers now runs, and ended sessions are
+  no longer kept in memory.
+* Fix ASGI apps failing on anything other than a WebSocket. HTTP requests are
+  answered with 426 Upgrade Required without an error, and lifespan startup and
+  shutdown are acknowledged, so an app from ``asgi_application()`` can be
+  served directly.
+* Rename ``serverwamp.adapters.asgi.ASGIWebSocketConection`` to
+  ``ASGIWebSocketConnection``.
+* Reject WebSocket connections that offer none of the supported WAMP
+  subprotocols, with 400 Bad Request with aiohttp and 403 Forbidden from ASGI
+  servers. aiohttp upgraded them and then failed in the request handler, and
+  ASGI accepted them with ``wamp.2.msgpack.batched``, which the client hadn't
+  offered.
+* Fix how RPC handlers' parameters are filled:
+
+  * Handlers given to ``set_rpc_handler()`` failed on every call unless their
+    parameter was named ``rpc_request``.
+  * Route handlers with keyword-only parameters failed on every call. ``*args``
+    and ``**kwargs`` now get the call's leftover arguments.
+  * Callers could override default args. Parameters named for a default arg now
+    always get its value.
+
+* Answer RPC arguments that can't be converted to their parameter's annotated
+  type with ``wamp.error.invalid_argument``, per WAMP spec, instead of
+  ``wamp.error.runtime_error``. Only class annotations are converted to, so
+  parameters annotated like ``int | None`` get arguments as they are instead of
+  failing, and parameters' own default values are no longer converted.
+
+.. _serverwamp-changelog-1.2.0:
+
+1.2.0
+-----
+
+* Fix the default realm never being used. Sessions requesting a realm that
+  wasn't added with ``add_realm`` now join the default realm as documented
+  instead of being aborted with ``wamp.error.no_such_realm``.
+
+  * To reject realms that weren't added, use
+    ``Application(allow_default_realm=False)``. Configuring the default realm
+    through the application (e.g. ``add_rpc_routes``) then raises a
+    ``RuntimeError`` instead of an ``AttributeError``.
+
+* Fix single RPC return values (e.g. ``return 'hello'``) being sent as the
+  result arguments themselves instead of as a single-element argument list.
+
+  * Returning ``None`` still sends a result without arguments. Return ``None,``
+    to send ``None`` as the single argument.
+
+* Support Python 3.14 and 3.15, and allow msgpack 1.x releases newer than 1.0.
+* Package with pyproject.toml and hatchling.
+* Fix aiohttp logging request handler errors when the server ended a
+  connection.
+* Fix ``wamp.2.json.batched`` sessions being aborted with a protocol error, and
+  batched JSON messages containing line breaks being dropped.
+* Fix ASGI ``wamp.2.json`` sessions failing on the first message sent to the
+  client.
+* Fix ``Application(synchronize_requests=True)`` failing every session on its
+  first request after the welcome.
+* Fix messages batched in the same WebSocket message as a client's HELLO being
+  dropped.
+* Declare public names in ``__all__`` so strict type checkers accept imports
+  such as ``serverwamp.Application``.
+
+.. _serverwamp-changelog-1.1.2:
+
+1.1.2
+-----
+
+* Fix standard library json support.
+
+.. _serverwamp-changelog-1.1.1:
+
+1.1.1
+-----
+
+* Support session close goodbye message.
+
+.. _serverwamp-changelog-1.0.7:
+
+1.0.7
+-----
+
+* Fix using deprecated collections.Sequence.
+* WAMP-compliant msgpack batch processing
+
+  * Fixes Autobahn|Python out-of-box compatibility.
+
+* Allow unauthenticated sessions if no authenticators configured.
+
+  * ``session.identity`` is ``None`` in this case.
+
+.. _serverwamp-changelog-1.0.6:
+
+1.0.6
+-----
+
+* Server now responds with error when unsubscribing from non-subscribed topic.
+* Temporarily synchronize subscribe/unsubscribe messages.
+
+  * Synchronization will be made configurable by request type in a future
+    version.
+
+* Fix for exception raised in trying to process protocol messages from a
+  canceled connection.
+
+.. _serverwamp-changelog-1.0.5:
+
+1.0.5
+-----
+
+* Fix error in SCRAM nonce generation
+* Fix lack of response to clients' unsubscribe requests
+* Fix for exception raised in trying to process protocol messages from a
+  canceled connection.
+
+.. _serverwamp-changelog-1.0.4:
+
+1.0.4
+-----
+
+* aiohttp sessions now cancellable by server shutdown
+* Session cleanup operations specifically shielded from cancellation
+* Added Application.close_sessions method (undocumented)
+
+.. _serverwamp-changelog-1.0.3:
+
+1.0.3
+-----
+
+* Fix for plain topic routes raising exception during registration. `Issue #4
+  <https://github.com/JustinTArthur/serverwamp/issues/4>`_
+* Exceptions in user-supplied RPC code no longer crash the app, but instead
+  return a wamp.error.runtime_error to the caller like Crossbar.io's toolchain.
+
+.. _serverwamp-changelog-1.0.2:
+
+1.0.2
+-----
+
+* Add "http_headers_raw" transport_info item for aiohttp and ASGI connections.
+
+.. _serverwamp-changelog-1.0.1:
+
+1.0.1
+-----
+
+* Fix stopasynciteration exception on session close with outstanding
+  subscriptions.
+
+.. _serverwamp-changelog-1.0.0:
+
+1.0.0
+-----
+
+Brand new API with…
+
+* Support for multiple realms w/ separate handlers
+* Context-manager-friendly subscription handlers
+* Session state handlers.
+* Routes configuration for topics similar to RPC.
+* Slightly more structured concurrency on the asyncio side.
+* Transport authenticators, ticket authenticators, and CRA auth.
+
+Released 2020-05-07 alongside new documentation.
+
+.. _serverwamp-changelog-0.2.3:
+
+0.2.3
+-----
+
+Transport auth, RPC and subscriptions now working.

serverwamp-2.0.0/pyproject.toml

@@ -0,0 +1,87 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "serverwamp"
+version = "2.0.0"
+description = "Components that add Web Application Messaging Protocol features to WebSocket servers."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "Justin Turner Arthur", email = "justinarthur@gmail.com" },
+]
+keywords = [
+    "WAMP", "WebSockets", "aiohttp", "RPC", "pubsub", "broker", "dealer",
+    "ASGI",
+]
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet",
+    "Framework :: AsyncIO",
+    "Framework :: Trio",
+]
+dependencies = [
+    "msgpack>=1.0.0,<2",
+]
+
+[project.optional-dependencies]
+anyio = [
+    "anyio>=4.0",
+]
+trio = [
+    "trio>=0.25.0",
+]
+docs = [
+    "Sphinx>=5.3,<10",
+]
+
+[project.urls]
+Homepage = "https://github.com/JustinTArthur/serverwamp"
+Documentation = "https://serverwamp.readthedocs.io/"
+
+[dependency-groups]
+ci = [
+    "aiohttp>=3.0.0",
+    "anyio>=4.0",
+    "msgpack-types>=0.8.0",
+    "mypy>=0.770",
+    "pytest>=8.0",
+    "ruff>=0.17.1,<0.18",
+    "trio>=0.25.0",
+]
+
+[tool.ruff]
+line-length = 99
+
+[tool.ruff.lint]
+# Ruff's default rules, as of 0.17, are far broader than these.
+select = ["E4", "E7", "E9", "F", "E501", "I", "Q", "UP"]
+
+[tool.ruff.lint.flake8-quotes]
+inline-quotes = "single"
+
+[tool.ruff.lint.isort]
+# Helper modules the tests import from their own directory.
+known-local-folder = ["memory_connection", "stream_connection"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/serverwamp",
+    "/docs/changelog.rst",
+    "/LICENSE.md",
+    "/README.md",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["serverwamp"]

serverwamp-2.0.0/serverwamp/__init__.py

@@ -0,0 +1,17 @@
+from serverwamp.application import Application, Realm
+from serverwamp.connection import ConnectionClosed
+from serverwamp.events import SubscribeError, TopicRouteSet
+from serverwamp.rpc import RPCErrorResult, RPCProgressReport, RPCRequest, RPCResult, RPCRouteSet
+
+__all__ = (
+    'Application',
+    'ConnectionClosed',
+    'Realm',
+    'RPCErrorResult',
+    'RPCProgressReport',
+    'RPCRequest',
+    'RPCResult',
+    'RPCRouteSet',
+    'SubscribeError',
+    'TopicRouteSet',
+)