Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

aiohug
======

|pipeline status| |coverage report|

.. |pipeline status| image:: https://gitlab.com/nonamenix/aiohug/badges/master/pipeline.svg
:target: https://gitlab.com/nonamenix/aiohug/commits/master
.. |coverage report| image:: https://gitlab.com/nonamenix/aiohug/badges/master/coverage.svg
:target: https://gitlab.com/nonamenix/aiohug/commits/master

Goals:
=====

- Unpack aiohttp request to arguments with annotations
- Validate handlers arguments
- Generate swagger specification

Examples
========

Run ping pong application
-------------------------

.. code:: python

from aiohttp import web
from aiohug import RouteTableDef

routes = RouteTableDef()


@routes.get("/ping/")
async def ping():
return "pong"


app = web.Application()
app.add_routes(routes)


if __name__ == "__main__":
web.run_app(app)

There is no more ``request`` object in handler.

Arguments from path and query
-----------------------------

.. code:: python


@routes.get("/hello/{name}/")
async def hello(name: fields.String(), greeting: fields.String() = "Hello"):
return {"msg": f"{greeting}, {name}"}

Body with schema
----------------

.. code:: python

from aiohttp import web
from aiohug import RouteTableDef

routes = RouteTableDef()

class PayloadSchema(Schema):
count = fields.Int()

@routes.get("/")
async def with_body(body: PayloadSchema()):
return body

app = create_app()
app.add_routes(routes)

client = await test_client(app)
resp = await client.get("/", json={"count": "5", "another": 7})

assert await resp.json() == {"count": 5}

Another shortcuts
-----------------

.. code:: python

@routes.post("/ping/")
async def ping():
return 201, "pong"

Swagger
-------

Use `aiohug_swagger` package.


Why aiohug?
===========

It's just hug_ API implementation for aiohttp

.. _hug: https://github.com/timothycrosley/hug

TODO:
=====

- don’t pass default arguments
- default websocket handler with ping/pong and schemas support

.. code:: python

ws = aiohug.WSHandler()


@ws("hello") # match message by `type` field
async def hello(name: str, greeting: str="Hi"):
""" Just send {"type": "hello", "name": "Lucy", "greeting": "Hi"} """
return {"text", f"{greeting}, {name}"}


app = create_app()
app.add_routes([web.get('/ws', ws)])

Metadata

Release files for aiohug 0.4.0.dev37498435

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiohug 0.4.0.dev37498435
File Size Uploaded Provenance Actions
aiohug-0.4.0.dev37498435.tar.gz 5.9 kB Without provenance Details for aiohug-0.4.0.dev37498435.tar.gz

Release files / aiohug-0.4.0.dev37498435.tar.gz

Download URL aiohug-0.4.0.dev37498435.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c3f038ac87f1e55ee8506bf6d78eba719f7f0da1ffd9e615e54c1b05df79bc50
BLAKE2b-256 checksum
How to use checksums
a6935cb2f592b51c008c5a85aaa00dc4bc8c75a17e1cebce9e7527a4e374de8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

Security for aiohug 0.4.0.dev37498435

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page