Router feature (and some general improvements) (#8)

* Add endpoint code

* Add operation class

* Update connection file

* Update utils

* Add path property to the operation

* Rewrite codegen

* Update base classes

* Start building pubsub  example

* Add blocking to the client

* Fix escaped refs

* Add default amqp_uri into devcontainer

* Fix codegen types

* Fix start/stop cycle

* Fix routingKey mode (anonymous queues)

* Add missing ack on consumer side

* Fix error in template

* Make sender do declarations

* Update RPC example to match new API

* Fix generation of queue names

* Drop declared queue if it is exclusive to sender

* Add a possibility to stop an application from Router or Endpoint

* Implement stop method for both sender and receiver

* Drop outdated library tests

* Outsource correlation id generation from RpcSender to BaseApplication

* Drop unused import

* Add operation struct tests

* Add endpoint tests

* Standardize message generation

* Add copyright notice

* Fix tests

* Update README

* Update minor version

* Add error_queue_name property to EndpointParams

* Move create_message from endpoint params to endpoint

* Move errors do separate module

* Add rejection logic for receivers

* Create codebase for error queue handling

* Drop redundant variable

* Rename Reject to Rejection

* Add debug mode for operation

* Add debug mode for operation

* Add rejection tests for endpoints

* Add copyright notice to files

* Update README

* Allow refs in Channels (according to spec)

* Add support for python 3.13

Author: WiZeYAR

.devcontainer/devcontainer.json

@@ -6,6 +6,9 @@
 	"forwardPorts": [
 		"rabbitmq:15672"
 	],
+	"containerEnv": {
+		"AMQP_URI": "amqp://guest:guest@rabbitmq/"
+	},
 	"customizations": {
 		"vscode": {
 			"extensions": [

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
         matrix:
-          python_version: ["3.9", "3.10", "3.11", "3.12"]
+          python_version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     services:
       rabbitmq:

README.md

@@ -1,9 +1,10 @@
 # AsyncAPI Python Code Generator
+>
 > [!IMPORTANT]
-> Although commits to dev branch might seem infrequent, the project is under active development **as of February 2025**.
+> Although commits to dev branch might seem infrequent, the project is under active development **as of March 2025**.
 >
 > We currently produce only those changes that are required to satisfy our personal use cases.
-> 
+>
 > The number of commits will grow as we see increase in popularity of it, so do not hesitate
 > to star this repo, open issues, and pull requests.
 
@@ -27,7 +28,7 @@ Easily generate type-safe and async Python applications from AsyncAPI 3 specific
 
 ## Requirements
 
-- `python>=3.10`
+- `python>=3.9`
 - `pydantic>=2`
 - `pytz`
 - For `codegen` extra

examples/amqp-pub-sub/.gitignore

@@ -0,0 +1,2 @@
+publisher/
+subscriber/

examples/amqp-pub-sub/Makefile

@@ -0,0 +1,27 @@
+VENV_NAME := .venv
+PYTHON := $(VENV_NAME)/bin/python
+CODEGEN := $(VENV_NAME)/bin/asyncapi-python-codegen
+PIP := $(VENV_NAME)/bin/pip
+PACKAGE_VERSION := 0.1.0
+
+
+venv:
+	python3 -m venv $(VENV_NAME)
+
+install:
+	$(PIP) install asyncapi-python[amqp,codegen]==$(PACKAGE_VERSION)
+
+generate:
+	$(CODEGEN) spec/subscriber.asyncapi.yaml subscriber --force
+	$(CODEGEN) spec/publisher.asyncapi.yaml publisher --force
+
+client:
+	$(PYTHON) main-subscriber.py
+
+server: 
+	$(PYTHON) main-publisher.py
+
+clean:
+	rm -rf $(VENV_NAME)
+
+.PHONY: client server

examples/amqp-pub-sub/README.md

@@ -1,3 +1,42 @@
-# Asyncapi-Python Pub-Sub Example
+# Asyncapi-Python AMQP Pub-Sub Example
 
-This example is a work in progress
+The following example shows how to use `asyncapi-python` package to create publisher-subscriber communications.
+
+## Requirements
+
+1. A working `amqp` broker
+
+   > This example assumes that it will be accessible by `amqp://guest:guest@localhost`.
+   > If this is not true, set `AMQP_URI` envvar accordingly
+
+## Steps
+
+1. `cd` into this directory
+
+1. Create python virtual environment and activate it.
+
+   Alternatively, run `make venv install`.
+
+   ```bash
+   python3 -m venv .venv
+   . .venv/bin/activate
+   ```
+
+1. Generate client and server modules.
+
+   Alternatively, run `make generate`.
+
+   ```bash
+   asyncapi-python-codegen spec/publisher.asyncapi.yaml publisher --force
+   asyncapi-python-codegen spec/subscriber.asyncapi.yaml subscriber --force
+   ```
+
+1. Run subscriber, and then publisher. This requires two terminals.
+
+   ```bash
+   .venv/bin/python main-subscriber.py
+   ```
+
+   ```bash
+   .venv/bin/python main-publisher.py
+   ```

examples/amqp-pub-sub/main-publisher.py

@@ -0,0 +1,22 @@
+import asyncio
+from os import environ
+from publisher import Application
+from publisher.messages import Ping
+
+
+AMQP_URI = environ.get("AMQP_URI", "amqp://guest:guest@localhost")
+NUM_REQUESTS = 3
+
+app = Application(AMQP_URI)
+
+
+async def main() -> None:
+    await app.start(blocking=False)
+    for _ in range(NUM_REQUESTS):
+        req = Ping()
+        print(f"Sending request: {req}")
+        await app.producer.application.ping(req)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/amqp-pub-sub/main-subscriber.py

@@ -0,0 +1,37 @@
+import asyncio
+from os import environ
+from sys import exit
+from subscriber import Application
+from subscriber.messages import Ping
+
+
+AMQP_URI = environ.get("AMQP_URI", "amqp://guest:guest@localhost")
+MAX_REQUESTS = 3
+request_count = 0
+
+app = Application(AMQP_URI)
+
+
+@app.consumer.application.ping
+async def handle_ping_request(msg: Ping) -> None:
+    global request_count
+    print(f"Handling request: {msg}")
+    request_count += 1
+
+
+async def termination_handler():
+    """A function to terminate the app after all requests are handled"""
+    while True:
+        await asyncio.sleep(1)
+        if request_count >= MAX_REQUESTS:
+            exit(0)
+
+
+async def main() -> None:
+    app_handler = app.start(blocking=True)
+    term_handler = termination_handler()
+    await asyncio.gather(app_handler, term_handler)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/amqp-pub-sub/spec/common.asyncapi.yaml

@@ -0,0 +1,19 @@
+asyncapi: "3.0.0"
+info:
+  title: Common part of the Ping service example
+  version: 1.0.0
+
+channels:
+  /ping/pubsub:
+    bindings:
+      amqp:
+        exchange:
+          type: fanout
+    messages:
+      Ping:
+        payload:
+          type: object
+          properties:
+            event:
+              type: string
+              const: ping

examples/amqp-pub-sub/spec/publisher.asyncapi.yaml

@@ -0,0 +1,9 @@
+asyncapi: "3.0.0"
+info:
+  title: Client part of the Ping service example
+  version: 1.0.0
+
+operations:
+  /application/ping:
+    action: send
+    channel: { $ref: "./common.asyncapi.yaml#/channels/~1ping~1pubsub" }