flask-parameters


Nameflask-parameters JSON
Version 0.0.2 PyPI version JSON
download
home_page
Summary
upload_time2023-04-05 05:47:25
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords flask
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Flask Parameters

This library defines some decorators to be used with [Flask](https://flask.palletsprojects.com/) to inject URL query parameters as arguments into route functions. You can optionally perform type checking of the parameters based on the signature of the route function.

[Documentation](http://flask-params-docs.s3-website-ap-southeast-2.amazonaws.com/)

## Example Usage

```python
import flask

from flask_parameters import inject_query_params
from flask_parameters import inject_and_validate_query_params
from flask_parameters import register_error_handlers

app = flask.Flask(__name__)
register_error_handlers(app)


@app.route("/foo")
@inject_query_params()
def foo(arg, kwarg = 123) -> dict:
    return {"arg": arg, "kwarg": kwarg}


@app.route("/strict_foo")
@inject_and_validate_query_params()
def strict_foo(arg: str, kwarg: int = 123) -> dict:
    return {"arg": arg, "kwarg": kwarg}
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "flask-parameters",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "flask",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/68/b9/e2e292290f39a038075a4b07257d627ce9fbf6fa52ef0ba0af1f9d97a74a/flask-parameters-0.0.2.tar.gz",
    "platform": null,
    "description": "# Flask Parameters\n\nThis library defines some decorators to be used with [Flask](https://flask.palletsprojects.com/) to inject URL query parameters as arguments into route functions. You can optionally perform type checking of the parameters based on the signature of the route function.\n\n[Documentation](http://flask-params-docs.s3-website-ap-southeast-2.amazonaws.com/)\n\n## Example Usage\n\n```python\nimport flask\n\nfrom flask_parameters import inject_query_params\nfrom flask_parameters import inject_and_validate_query_params\nfrom flask_parameters import register_error_handlers\n\napp = flask.Flask(__name__)\nregister_error_handlers(app)\n\n\n@app.route(\"/foo\")\n@inject_query_params()\ndef foo(arg, kwarg = 123) -> dict:\n    return {\"arg\": arg, \"kwarg\": kwarg}\n\n\n@app.route(\"/strict_foo\")\n@inject_and_validate_query_params()\ndef strict_foo(arg: str, kwarg: int = 123) -> dict:\n    return {\"arg\": arg, \"kwarg\": kwarg}\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.0.2",
    "split_keywords": [
        "flask"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "57cc5a0795bf33952b25c4cc727191efd1a69f4bb028c1be6b7130419505fa9e",
                "md5": "9abc364dcedbbf628ff60ceec3141345",
                "sha256": "233197d79a2c6229cb71ff4de8b248a8646e95b2808c7081025fabcd0e2ba31a"
            },
            "downloads": -1,
            "filename": "flask_parameters-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9abc364dcedbbf628ff60ceec3141345",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5771,
            "upload_time": "2023-04-05T05:47:23",
            "upload_time_iso_8601": "2023-04-05T05:47:23.189701Z",
            "url": "https://files.pythonhosted.org/packages/57/cc/5a0795bf33952b25c4cc727191efd1a69f4bb028c1be6b7130419505fa9e/flask_parameters-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68b9e2e292290f39a038075a4b07257d627ce9fbf6fa52ef0ba0af1f9d97a74a",
                "md5": "9d2d53109ded23689f0339ffdfb56fc0",
                "sha256": "91dda43991812cd22862b684a469672f96d8c692c1686539cfaba0681c9a2c7d"
            },
            "downloads": -1,
            "filename": "flask-parameters-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9d2d53109ded23689f0339ffdfb56fc0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4558,
            "upload_time": "2023-04-05T05:47:25",
            "upload_time_iso_8601": "2023-04-05T05:47:25.059903Z",
            "url": "https://files.pythonhosted.org/packages/68/b9/e2e292290f39a038075a4b07257d627ce9fbf6fa52ef0ba0af1f9d97a74a/flask-parameters-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-05 05:47:25",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "flask-parameters"
}
        
Elapsed time: 0.05534s