# aiohttp-fast-url-dispatcher
<p align="center">
<a href="https://github.com/bdraco/aiohttp-fast-url-dispatcher/actions/workflows/ci.yml?query=branch%3Amain">
<img src="https://img.shields.io/github/actions/workflow/status/bdraco/aiohttp-fast-url-dispatcher/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
</a>
<a href="https://aiohttp-fast-url-dispatcher.readthedocs.io">
<img src="https://img.shields.io/readthedocs/aiohttp-fast-url-dispatcher.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
</a>
<a href="https://codecov.io/gh/bdraco/aiohttp-fast-url-dispatcher">
<img src="https://img.shields.io/codecov/c/github/bdraco/aiohttp-fast-url-dispatcher.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
</a>
</p>
<p align="center">
<a href="https://python-poetry.org/">
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
</a>
<a href="https://github.com/ambv/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/aiohttp-fast-url-dispatcher/">
<img src="https://img.shields.io/pypi/v/aiohttp-fast-url-dispatcher.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
</a>
<img src="https://img.shields.io/pypi/pyversions/aiohttp-fast-url-dispatcher.svg?style=flat-square&logo=python&logoColor=fff" alt="Supported Python versions">
<img src="https://img.shields.io/pypi/l/aiohttp-fast-url-dispatcher.svg?style=flat-square" alt="License">
</p>
---
**Documentation**: <a href="https://aiohttp-fast-url-dispatcher.readthedocs.io" target="_blank">https://aiohttp-fast-url-dispatcher.readthedocs.io </a>
**Source Code**: <a href="https://github.com/bdraco/aiohttp-fast-url-dispatcher" target="_blank">https://github.com/bdraco/aiohttp-fast-url-dispatcher </a>
---
A faster URL dispatcher for aiohttp
The default `UrlDispatcher` implementation does a linear search every which can have a significant [TimeComplexity](https://wiki.python.org/moin/TimeComplexity) when dispatching urls when there are a lot of routes. `FastUrlDispatcher` keeps an index of the urls which allows for fast dispatch.
This library will become obsolete with aiohttp 3.10 as the changes
are expected to merge upstream via https://github.com/aio-libs/aiohttp/pull/7829
## Installation
Install this via pip (or your favourite package manager):
`pip install aiohttp-fast-url-dispatcher`
## Usage
Attach to a `web.Application` before any resources are registered.
```python
dispatcher = FastUrlDispatcher()
app = web.Application()
attach_fast_url_dispatcher(app, dispatcher)
```
Create with a new `web.Application`
```python
dispatcher = FastUrlDispatcher()
app = web.Application(router=dispatcher)
```
### Caveats
If you have multiple handlers that resolve to the same URL, this module will always prefer the static name over a dynamic name. For example:
```python
app.router.add_get(r"/second/{user}/info", handler)
app.router.add_get("/second/bob/info", handler)
```
`"/second/bob/info"` will always be matched before `r"/second/{user}/info"`
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- markdownlint-disable -->
<!-- markdownlint-enable -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-end -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Credits
This package was created with
[Copier](https://copier.readthedocs.io/) and the
[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
project template.
Raw data
{
"_id": null,
"home_page": "https://github.com/bdraco/aiohttp-fast-url-dispatcher",
"name": "aiohttp-fast-url-dispatcher",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "J. Nick Koston",
"author_email": "nick@koston.org",
"download_url": "https://files.pythonhosted.org/packages/0f/4a/9be8071f66a46f28d599915832ed9a19b0004f2967d3a5398f0a4f29ec82/aiohttp_fast_url_dispatcher-0.3.1.tar.gz",
"platform": null,
"description": "# aiohttp-fast-url-dispatcher\n\n<p align=\"center\">\n <a href=\"https://github.com/bdraco/aiohttp-fast-url-dispatcher/actions/workflows/ci.yml?query=branch%3Amain\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/bdraco/aiohttp-fast-url-dispatcher/ci.yml?branch=main&label=CI&logo=github&style=flat-square\" alt=\"CI Status\" >\n </a>\n <a href=\"https://aiohttp-fast-url-dispatcher.readthedocs.io\">\n <img src=\"https://img.shields.io/readthedocs/aiohttp-fast-url-dispatcher.svg?logo=read-the-docs&logoColor=fff&style=flat-square\" alt=\"Documentation Status\">\n </a>\n <a href=\"https://codecov.io/gh/bdraco/aiohttp-fast-url-dispatcher\">\n <img src=\"https://img.shields.io/codecov/c/github/bdraco/aiohttp-fast-url-dispatcher.svg?logo=codecov&logoColor=fff&style=flat-square\" alt=\"Test coverage percentage\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://python-poetry.org/\">\n <img src=\"https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=\" alt=\"Poetry\">\n </a>\n <a href=\"https://github.com/ambv/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square\" alt=\"black\">\n </a>\n <a href=\"https://github.com/pre-commit/pre-commit\">\n <img src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square\" alt=\"pre-commit\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/aiohttp-fast-url-dispatcher/\">\n <img src=\"https://img.shields.io/pypi/v/aiohttp-fast-url-dispatcher.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPI Version\">\n </a>\n <img src=\"https://img.shields.io/pypi/pyversions/aiohttp-fast-url-dispatcher.svg?style=flat-square&logo=python&logoColor=fff\" alt=\"Supported Python versions\">\n <img src=\"https://img.shields.io/pypi/l/aiohttp-fast-url-dispatcher.svg?style=flat-square\" alt=\"License\">\n</p>\n\n---\n\n**Documentation**: <a href=\"https://aiohttp-fast-url-dispatcher.readthedocs.io\" target=\"_blank\">https://aiohttp-fast-url-dispatcher.readthedocs.io </a>\n\n**Source Code**: <a href=\"https://github.com/bdraco/aiohttp-fast-url-dispatcher\" target=\"_blank\">https://github.com/bdraco/aiohttp-fast-url-dispatcher </a>\n\n---\n\nA faster URL dispatcher for aiohttp\n\nThe default `UrlDispatcher` implementation does a linear search every which can have a significant [TimeComplexity](https://wiki.python.org/moin/TimeComplexity) when dispatching urls when there are a lot of routes. `FastUrlDispatcher` keeps an index of the urls which allows for fast dispatch.\n\nThis library will become obsolete with aiohttp 3.10 as the changes\nare expected to merge upstream via https://github.com/aio-libs/aiohttp/pull/7829\n\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n`pip install aiohttp-fast-url-dispatcher`\n\n## Usage\n\nAttach to a `web.Application` before any resources are registered.\n\n```python\ndispatcher = FastUrlDispatcher()\napp = web.Application()\nattach_fast_url_dispatcher(app, dispatcher)\n```\n\nCreate with a new `web.Application`\n\n```python\ndispatcher = FastUrlDispatcher()\napp = web.Application(router=dispatcher)\n```\n\n### Caveats\n\nIf you have multiple handlers that resolve to the same URL, this module will always prefer the static name over a dynamic name. For example:\n\n```python\napp.router.add_get(r\"/second/{user}/info\", handler)\napp.router.add_get(\"/second/bob/info\", handler)\n```\n\n`\"/second/bob/info\"` will always be matched before `r\"/second/{user}/info\"`\n\n## Contributors \u2728\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- prettier-ignore-start -->\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- markdownlint-disable -->\n<!-- markdownlint-enable -->\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-end -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## Credits\n\nThis package was created with\n[Copier](https://copier.readthedocs.io/) and the\n[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)\nproject template.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A faster URL dispatcher for aiohttp",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/bdraco/aiohttp-fast-url-dispatcher/issues",
"Changelog": "https://github.com/bdraco/aiohttp-fast-url-dispatcher/blob/main/CHANGELOG.md",
"Documentation": "https://aiohttp-fast-url-dispatcher.readthedocs.io",
"Homepage": "https://github.com/bdraco/aiohttp-fast-url-dispatcher",
"Repository": "https://github.com/bdraco/aiohttp-fast-url-dispatcher"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92ad2763e6c3334e2e53bd210acec81f41499942327d6de17f1faeb221fbcee9",
"md5": "ac6e380a31e4eb844ce32e587ff80196",
"sha256": "1f7c0040f466e599e34e5b996ae897d13463ddf34b82d15c9048e8d6c6e00412"
},
"downloads": -1,
"filename": "aiohttp_fast_url_dispatcher-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac6e380a31e4eb844ce32e587ff80196",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 8893,
"upload_time": "2024-07-05T20:44:43",
"upload_time_iso_8601": "2024-07-05T20:44:43.595378Z",
"url": "https://files.pythonhosted.org/packages/92/ad/2763e6c3334e2e53bd210acec81f41499942327d6de17f1faeb221fbcee9/aiohttp_fast_url_dispatcher-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f4a9be8071f66a46f28d599915832ed9a19b0004f2967d3a5398f0a4f29ec82",
"md5": "b5827ee2719639f9c93b047d368a30e9",
"sha256": "5a730a3872503ee5c94c65c6dee2a17b4773e022630f2557cae84f2e74ea26ed"
},
"downloads": -1,
"filename": "aiohttp_fast_url_dispatcher-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "b5827ee2719639f9c93b047d368a30e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 9115,
"upload_time": "2024-07-05T20:44:45",
"upload_time_iso_8601": "2024-07-05T20:44:45.017228Z",
"url": "https://files.pythonhosted.org/packages/0f/4a/9be8071f66a46f28d599915832ed9a19b0004f2967d3a5398f0a4f29ec82/aiohttp_fast_url_dispatcher-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-05 20:44:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bdraco",
"github_project": "aiohttp-fast-url-dispatcher",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiohttp-fast-url-dispatcher"
}
JSON
