pyrpc-django-adapter 0.7.2__tar.gz

pyrpc_django_adapter-0.7.2/.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+!docs/lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Used for packaging Python scripts into standalone executables
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.stats
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   Project-specific python versions
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if Pipfile.lock (and requirements.txt) are not
+#   preferred, then add them into the ignore list.
+# Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+# pdm.lock
+# .pdm-python
+
+# PEP 582; used by e.g. github.com/fannheyward/coc-pyright
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyderformpoint
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# OS X
+.DS_Store
+
+# Node modules
+node_modules
+dist
+
+
+# System design docs (local developer documentation)
+system-design/
+
+# Scripts
+scripts/seed_downloads.py

pyrpc_django_adapter-0.7.2/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: pyrpc-django-adapter
+Version: 0.7.2
+Summary: Django adapter for pyRPC
+Requires-Python: >=3.11
+Requires-Dist: django>=4.2.0
+Requires-Dist: pyrpc-core

pyrpc_django_adapter-0.7.2/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "pyrpc-django-adapter"
+version = "0.7.2"
+description = "Django adapter for pyRPC"
+requires-python = ">=3.11"
+dependencies = [
+    "pyrpc-core",
+    "django>=4.2.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyrpc_django"]

pyrpc_django_adapter-0.7.2/src/pyrpc_django/__init__.py

@@ -0,0 +1,38 @@
+from pyrpc_core import handle_request, Router, rpc, model, default_router
+from typing import Any, Optional
+
+
+def mount_django(urlpatterns: list, router: Optional[Router] = None) -> None:
+    from django.http import HttpRequest, JsonResponse
+    from django.urls import path
+    from django.views.decorators.csrf import csrf_exempt
+    import json
+
+    resolved = router or default_router
+
+    @csrf_exempt
+    async def rpc_endpoint(request: HttpRequest) -> JsonResponse:
+        if request.method != "POST":
+            return JsonResponse({"error": "Method not allowed"}, status=405)
+        try:
+            payload = json.loads(request.body)
+        except json.JSONDecodeError:
+            return JsonResponse({"error": "Invalid JSON"}, status=400)
+        response_dict = await handle_request(payload, router=resolved)
+        return JsonResponse(response_dict)
+
+    @csrf_exempt
+    async def introspection_endpoint(request: HttpRequest) -> JsonResponse:
+        if request.method != "GET":
+            return JsonResponse({"error": "Method not allowed"}, status=405)
+        from pyrpc_core import get_registry_schema
+        schemas = get_registry_schema(resolved)
+        return JsonResponse({
+            name: schema.model_dump() if hasattr(schema, "model_dump") else schema
+            for name, schema in schemas.items()
+        })
+
+    urlpatterns.extend([
+        path("rpc", rpc_endpoint, name="pyrpc-rpc"),
+        path("rpc", introspection_endpoint, name="pyrpc-introspection"),
+    ])

pyrpc_django_adapter-0.7.2/tests/conftest.py

@@ -0,0 +1,12 @@
+import django
+from django.conf import settings
+
+settings.configure(
+    DEBUG=True,
+    SECRET_KEY="test-secret-key-for-pyrpc",
+    ROOT_URLCONF=__name__,
+    ALLOWED_HOSTS=["*"],
+    INSTALLED_APPS=["django.contrib.contenttypes", "django.contrib.auth"],
+    DATABASES={"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}},
+)
+django.setup()

pyrpc_django_adapter-0.7.2/tests/test_django.py

@@ -0,0 +1,82 @@
+import json
+import anyio
+import pytest
+from pyrpc_core import rpc, default_router
+
+
+@pytest.fixture(autouse=True)
+def clear_registry():
+    default_router._procedures.clear()
+
+
+def test_django_mount_success():
+    from pyrpc_django import mount_django
+    from django.test import RequestFactory
+
+    @rpc
+    def greet(name: str) -> str:
+        return f"Hello {name}"
+
+    urlpatterns = []
+    mount_django(urlpatterns)
+
+    factory = RequestFactory()
+    payload = {"id": "d-1", "method": "greet", "params": {"name": "Django"}}
+    request = factory.post("/rpc", json.dumps(payload), content_type="application/json")
+
+    async def run():
+        response = await urlpatterns[0].callback(request)
+        assert response.status_code == 200
+        data = json.loads(response.content)
+        assert data["id"] == "d-1"
+        assert data["result"] == "Hello Django"
+        assert data["error"] is None
+
+    anyio.run(run)
+
+
+def test_django_async_procedure():
+    from pyrpc_django import mount_django
+    from django.test import RequestFactory
+
+    @rpc
+    async def async_greet(name: str) -> str:
+        return f"Async Hello {name}"
+
+    urlpatterns = []
+    mount_django(urlpatterns)
+
+    factory = RequestFactory()
+    payload = {"id": "d-2", "method": "async_greet", "params": {"name": "World"}}
+    request = factory.post("/rpc", json.dumps(payload), content_type="application/json")
+
+    async def run():
+        response = await urlpatterns[0].callback(request)
+        assert response.status_code == 200
+        data = json.loads(response.content)
+        assert data["result"] == "Async Hello World"
+
+    anyio.run(run)
+
+
+def test_django_introspection():
+    from pyrpc_django import mount_django
+    from django.test import RequestFactory
+
+    @rpc
+    def add(a: int, b: int) -> int:
+        return a + b
+
+    urlpatterns = []
+    mount_django(urlpatterns)
+
+    factory = RequestFactory()
+    request = factory.get("/rpc")
+
+    async def run():
+        response = await urlpatterns[1].callback(request)
+        assert response.status_code == 200
+        data = json.loads(response.content)
+        assert "add" in data
+
+    anyio.run(run)