Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Router Configurator for you project.

Project description

https://img.shields.io/travis/com/theruziev/urouter.svg?style=flat-square https://img.shields.io/codecov/c/github/theruziev/urouter.svg?style=flat-square

Installation

pip install urouter

Supported web frameworks

Quickstart

Define handler in router

from aiohttp import web
from urouter.exporters.aiohttp_exporter import AioHttpRouter
app = web.Application()

 async def handler(request):
    return web.Response(text="Hello World")

router = AioHttpRouter(app)

router.get("/home", handler)

# At this point aiohttp is ready to register all routes
router.export()

Define global middleware for all routes

from aiohttp import web
from urouter.exporters.aiohttp_exporter import AioHttpRouter
app = web.Application()

@web.middleware
async def info_middleware(request, handler):
    # some operation before handle request
    response = await handler(request)
    return response

 async def handler(request):
    return web.Response(text="Hello World")

router = (AioHttpRouter(app)
            .use(info_middleware))

# Register handler
router.get("/home", handler)

# At this point aiohttp is ready to register all routes
router.export()

Define inline middleware (run only for specific handler)

from aiohttp import web
from urouter.exporters.aiohttp_exporter import AioHttpRouter
app = web.Application()

@web.middleware
async def info_middleware(request, handler):
    # some operation before handle request
    response = await handler(request)
    return response

 async def handler(request):
    return web.Response(text="Hello World")

router = AioHttpRouter(app)

# Middleware registered only for `/home` route
router.include(info_middleware).get("/home", handler)

# At this point aiohttp is ready to register all routes
router.export()

Define subrouter

from aiohttp import web
from urouter.exporters.aiohttp_exporter import AioHttpRouter
app = web.Application()

@web.middleware
async def info_middleware(request, handler):
    # some operation before handle request
    response = await handler(request)
    return response

 async def handler(request):
    return web.Response(text="Hello World")

 async def sub_handler(request):
    return web.Response(text="Hello World")


router = AioHttpRouter(app)

router.include(info_middleware).get("/home", handler)

# Create new router
subrouter = router.make_router()
subrouter.get("/hello", sub_handler)

# All registered router become starts with prefix `/sub/`
# `/hello` becomes `/sub/hello`
router.mount("/sub", subrouter)

# At this point aiohttp is ready to register all routes
router.export()

Private/Public router

from aiohttp import web
from urouter.exporters.aiohttp_exporter import AioHttpRouter
app = web.Application()

async def auth_middleware(request, handler):

    return web.HTTPForbidden()

async def public(request):
    return web.Response(text="Hello World")

async def private(request):
    return web.Response(text="Private Zone")

router = AioHttpRouter(app)
private_route = router.make_router().use(auth_middleware)

# Adding public handler
router.get("/home", public)

# Adding public handler
private_route.get("/private", private)

# Mount private router to main router
router.mount("/", private_route)

# At this point aiohttp is ready to register all routes
router.export()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for urouter, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size urouter-0.1.2-py2.py3-none-any.whl (6.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size urouter-0.1.2.tar.gz (4.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page