/item\")\ndef get_item_in_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return {\"items\": store[\"items\"]}\n return {\"message\": \"Store not found\"}, 404\n"
},
{
"path": "docs/docs/04_docker_intro/05_run_commands_in_docker_containers/README.md",
"content": "# How to run commands inside a Docker container\n\nIf you run your API using Docker Compose, with the `docker compose up` command, you may also want to be able to execute arbitrary shell commands in the container.\n\nFor example, later on in the course we will look at database migrations.\n\nTo execute a database migration, we need to run a specific command, `flask db mgirate`.\n\nIf we use Docker Compose, we'll need to run the command inside the running container, and not in a local terminal.\n\nYou can run any arbitrary command in a running container like so:\n\n```bash\ndocker compose exec web flask db migrate\n```\n\nThis command is split into 4 parts:\n\n- `docker compose`: uses the Docker Compose part of the Docker executable\n- `exec`: used to run a command in a specific Docker Compose service\n- `web`: which Docker Compose service to run the command in\n- `flask db migrate`: the command you want to run\n\nThat's all! Just remember while following the course, that if I run any commands in my local terminal and you are using Docker Compose, you should precede the commands with `docker compose exec web`.\n"
},
{
"path": "docs/docs/04_docker_intro/README.md",
"content": "# An Introduction to Docker\n\n:::caution Not a Docker course\nAn important foreword: this is not a Docker course, and I'm not a Docker expert!\n\nIn this section, and in later sections of this course, I'll teach you what Docker is and how to use it to run and deploy your Flask apps. However, I won't teach you everything there is to know about Docker!\n:::\n\nDocker is a software framework for building, running, and managing **images** and **containers**.\n\nIn order to understand Docker, you need to clarify two questions:\n\n- What are Docker containers, and how are they different to Virtual Machines?\n- What are Docker images?\n\nAfter this, you'll be ready to create your own Docker images and use those images to create and run containers.\n\nLet's take a look at Docker containers in the next lecture!"
},
{
"path": "docs/docs/04_docker_intro/_category_.json",
"content": "{\n \"label\": \"Introduction to Docker\",\n \"position\": 4\n}\n"
},
{
"path": "docs/docs/05_flask_smorest/01_why_flask_smorest/README.md",
"content": "---\nctslug: why-use-flask-smorest\n---\n\n# Why use Flask-Smorest\n\nThere are many different REST API libraries for Flask. In a previous version of this course, we used Flask-RESTful. Now, I recommend using [Flask-Smorest](https://github.com/marshmallow-code/flask-smorest).\n\nOver the last few months, I've been trialing the major REST libraries for Flask. I've built REST APIs using Flask-RESTful, Flask-RESTX, and Flask-Smorest.\n\nI was looking to compare the three libraries in a few key areas:\n\n- **Ease of use and getting started**. Many REST APIs are essentially microservices, so being able to whip one up quickly and without having to go through a steep learning curve is definitely interesting.\n- **Maintainability and expandability**. Although many start as microservices, sometimes we have to maintain projects for a long time. And sometimes, they grow past what we originally envisioned.\n- **Activity in the library itself**. Even if a library is suitable now, if it is not actively maintained and improved, it may not be suitable in the future. We'd like to teach something that you will use for years to come.\n- **Documentation and usage of best practice**. The library should help you write better code by having strong documentation and guiding you into following best practice. If possible, it should use existing, actively maintained libraries as dependencies instead of implementing their own versions of them.\n- **Developer experience in production projects**. The main point here was: how easy is it to produce API documentation with the library of choice. Hundreds of students have asked me how to integrate Swagger in their APIs, so it would be great if the library we teach gave it to you out of the box.\n\n## Flask-Smorest is the most well-rounded\n\nIt ticks all the boxes above:\n\n- If you want, it can be super similar to Flask-RESTful (which is a compliment, really easy to get started!).\n- It uses [marshmallow](https://marshmallow.readthedocs.io/en/stable/) for serialization and deserialization, which is a huge plus. Marshmallow is a very actively-maintained library which is very intuitive and unlocks very easy argument validation. Unfortunately Flask-RESTX [doesn't use marshmallow](https://flask-restx.readthedocs.io/en/latest/marshalling.html), though there are [plans to do so](https://github.com/python-restx/flask-restx/issues/59).\n- It provides Swagger (with Swagger UI) and other documentations out of the box. It uses the same marshmallow schemas you use for API validation and some simple decorators in your code to generate the documentation.\n- The documentation is the weakest point (compared to Flask-RESTX), but with this course we can help you navigate it. The documentation of marshmallow is superb, so that will also help.\n\n## If you took an old version of this course...\n\nLet me tell you about some of the key differences between a project that uses Flask-RESTful and one that uses Flask-Smorest. After reading through these differences, it should be fairly straightforward for you to look at two projects, each using one library, and compare them.\n\n1. Flask-Smorest uses `flask.views.MethodView` classes registered under a `flask_smorest.Blueprint` instead of `flask_restful.Resource` classes.\n2. Flask-Smorest uses `flask_smorest.abort` to return error responses instead of manually returning the error JSON and error code.\n3. Flask-Smorest projects define marshmallow schemas that represent incoming data (for deserialization and validation) and outgoing data (for serialization). It uses these schemas to automatically validate the data and turn Python objects into JSON.\n\nThroughout this section I'll show you how to implement these 3 points in practice, so if you've already got a REST API that uses Flask-RESTful, you'll find it really easy to migrate.\n\nOf course, you can keep using Flask-RESTful for your existing projects, and only use Flask-Smorest for new projects. That's also an option! Flask-RESTful isn't abandoned or deprecated, so it's still a totally viable option."
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/README.md",
"content": "---\ntitle: \"Data model improvements\"\ndescription: \"Use dictionaries instead of lists for data storage, and store stores and items separately.\"\nctslug: data-model-improvements\n---\n\n# Data model improvements\n\n## Starting code from section 4\n\nThis is the \"First REST API\" project from Section 4:\n\nimport Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n\n\n\n\n\n```py title=\"app.py\"\nfrom flask import Flask, request\n\napp = Flask(__name__)\n\nstores = [\n {\n \"name\": \"My Store\",\n \"items\": [\n {\n \"name\": \"Chair\",\n \"price\": 15.99\n }\n ]\n }\n]\n\n@app.get(\"/store\") # http://127.0.0.1:5000/store\ndef get_stores():\n return {\"stores\": stores}\n\n\n@app.post(\"/store\")\ndef create_store():\n request_data = request.get_json()\n new_store = {\"name\": request_data[\"name\"], \"items\": []}\n stores.append(new_store)\n return new_store, 201\n\n\n@app.post(\"/store//item\")\ndef create_item(name):\n request_data = request.get_json()\n for store in stores:\n if store[\"name\"] == name:\n new_item = {\"name\": request_data[\"name\"], \"price\": request_data[\"price\"]}\n store[\"items\"].append(new_item)\n return new_item, 201\n return {\"message\": \"Store not found\"}, 404\n\n\n@app.get(\"/store/\")\ndef get_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return store\n return {\"message\": \"Store not found\"}, 404\n\n\n@app.get(\"/store//item\")\ndef get_item_in_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return {\"items\": store[\"items\"]}\n return {\"message\": \"Store not found\"}, 404\n```\n\n\n\n\n```docker\nFROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]\n```\n\n\n\n
\n\n## New files\n\n:::tip Insomnia files\nRemember to get the Insomnia files for this section or for all sections [here](/insomnia-files/)!\n\nThere are two Insomnia files for this section: one for lectures 1-5 (before adding Docker), and one for the other lectures (after adding Docker).\n:::\n\nLet's start off by creating a `requirements.txt` file with all our dependencies:\n\n```txt title=\"requirements.txt\"\nflask\nflask-smorest\npython-dotenv\n```\n\nWe're adding `flask-smorest` to help us write REST APIs more easily, and generate documentation for us.\n\nWe're adding `python-dotenv` so it's easier for us to load environment variables and use the `.flaskenv` file.\n\nNext, let's create the `.flaskenv` file:\n\n```txt title=\".flaskenv\"\nFLASK_APP=app\nFLASK_DEBUG=True\n```\n\nIf we have the `python-dotenv` library installed, when we run the `flask run` command, Flask will read the variables inside `.flaskenv` and use them to configure the Flask app.\n\nThe configuration that we'll do is to define the Flask app file (here, `app.py`). Then we'll also set the `FLASK_DEBUG` flag to `True`, which does a couple things:\n\n- Makes the app give us better error messages and return a traceback when we make requests if there's an error.\n- Sets the app reloading to true, so the app restarts when we make code changes\n\nWe don't want debug mode to be enabled in production (when we deploy our app), but while we're doing development it's definitely a time-saving tool!\n\n## Code improvements\n\n### Creating a database file\n\nFirst of all, let's move our \"database\" to another file.\n\nCreate a `db.py` file with the following content:\n\n```py title=\"db.py\"\nstores = {}\nitems = {}\n```\n\nIn the existing code we only have a `stores` list, so delete that from `app.py`. From now on we will be storing information about items and stores separately.\n\n:::tip What is in each dictionary?\nEach dictionary will closely mimic how a database works: a mapping of ID to data. So each dictionary will be something like this:\n\n```py\n{\n 1: {\n \"name\": \"Chair\",\n \"price\": 17.99\n },\n 2: {\n \"name\": \"Table\",\n \"price\": 180.50\n }\n}\n```\n\nThis will make it much easier to retrieve a specific store or item, just by knowing its ID.\n:::\n\nThen, import the `stores` and `items` variables from `db.py` in `app.py`:\n\n```py title=\"app.py\"\nfrom db import stores, items\n```\n\n## Using stores and items in our API\n\nNow let's make use of stores and items separately in our API.\n\n### `get_store`\n\nHere are the changes we'll need to make:\n\n\n\n\n\n```py title=\"app.py\"\n@app.get(\"/store/\")\ndef get_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return store\n return {\"message\": \"Store not found\"}, 404\n```\n\n\n\n\n```py title=\"app.py\"\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n return {\"message\": \"Store not found\"}, 404\n```\n\nImportant to note that in this version, we won't return the items in the store. That's a limitation of our dictionaries-for-database setup that we will solve when we introduce databases!\n\n\n\n
\n\n### `get_stores`\n\n\n\n\n\n```py title=\"app.py\"\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": stores}\n```\n\n\n\n\n```py title=\"app.py\"\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n```\n\n\n\n
\n\n### `create_store`\n\n\n\n\n\n```py title=\"app.py\"\n@app.post(\"/store\")\ndef create_store():\n request_data = request.get_json()\n new_store = {\"name\": request_data[\"name\"], \"items\": []}\n stores.append(new_store)\n return new_store, 201\n```\n\n\n\n\n```py title=\"app.py\"\nimport uuid\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n```\n\nHere we add a new import, [the `uuid` module](https://docs.python.org/3/library/uuid.html). We will be using it to create unique IDs for our stores and items instead of relying on the uniqueness of their names.\n\n\n\n
\n\n### `create_item`\n\n\n\n\n\n```py title=\"app.py\"\n@app.post(\"/store//item\")\ndef create_item(name):\n request_data = request.get_json()\n for store in stores:\n if store[\"name\"] == name:\n new_item = {\"name\": request_data[\"name\"], \"price\": request_data[\"price\"]}\n store[\"items\"].append(new_item)\n return new_item, 201\n return {\"message\": \"Store not found\"}, 404\n```\n\n\n\n\n```py title=\"app.py\"\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n if item_data[\"store_id\"] not in stores:\n return {\"message\": \"Store not found\"}, 404\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n```\n\nNow we are POSTing to `/item` instead of `/store//item`. The endpoint will expect to receive JSON with `price`, `name`, and `store_id`.\n\n\n\n
\n\n\n### `get_items` (new)\n\nThis is not an endpoint we could easily make when we were working with a single `stores` list!\n\n```py\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n```\n\n### `get_item_in_store`\n\n\n\n\n\n```py title=\"app.py\"\n@app.get(\"/store//item\")\ndef get_item_in_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return {\"items\": store[\"items\"]}\n return {\"message\": \"Store not found\"}, 404\n```\n\n\n\n\n```py title=\"app.py\"\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n return {\"message\": \"Item not found\"}, 404\n```\n\nNow we are GETting from `/item` instead of `/store//item`. This is because while items are related to stores, they aren't inside a store anymore!\n\n\n\n
\n"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/end/Dockerfile",
"content": "# In the course we run the app outside Docker\n# until lecture 5.\nFROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/end/app.py",
"content": "import uuid\nfrom flask import Flask, request\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n return {\"message\": \"Item not found\"}, 404\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n if item_data[\"store_id\"] not in stores:\n return {\"message\": \"Store not found\"}, 404\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n return {\"message\": \"Store not found\"}, 404\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/02_data_model_improvements/start/app.py",
"content": "from flask import Flask, request\n\napp = Flask(__name__)\n\nstores = [{\"name\": \"My Store\", \"items\": [{\"name\": \"Chair\", \"price\": 15.99}]}]\n\n\n@app.get(\"/store\") # http://127.0.0.1:5000/store\ndef get_stores():\n return {\"stores\": stores}\n\n\n@app.post(\"/store\")\ndef create_store():\n request_data = request.get_json()\n new_store = {\"name\": request_data[\"name\"], \"items\": []}\n stores.append(new_store)\n return new_store, 201\n\n\n@app.post(\"/store//item\")\ndef create_item(name):\n request_data = request.get_json()\n for store in stores:\n if store[\"name\"] == name:\n new_item = {\"name\": request_data[\"name\"], \"price\": request_data[\"price\"]}\n store[\"items\"].append(new_item)\n return new_item, 201\n return {\"message\": \"Store not found\"}, 404\n\n\n@app.get(\"/store/\")\ndef get_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return store\n return {\"message\": \"Store not found\"}, 404\n\n\n@app.get(\"/store//item\")\ndef get_item_in_store(name):\n for store in stores:\n if store[\"name\"] == name:\n return {\"items\": store[\"items\"]}\n return {\"message\": \"Store not found\"}, 404\n"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/README.md",
"content": "---\ntitle: \"Improvements to our first REST API\"\ndescription: \"Add new error handling and code improvements to the REST API before adding any new endpoints.\"\nctslug: improvements-to-our-first-rest-api\n---\n\n# Improvements to our first REST API\n\n## Using `flask_smorest.abort` instead of returning errors manually\n\nAt the moment in our API we're doing things like these in case of an error:\n\n```py title=\"app.py\"\n@app.get(\"/store/\")\ndef get_store(name):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n return {\"message\": \"Store not found\"}, 404\n```\n\nA small improvement we can do on this is use the `abort` function from Flask-Smorest, which helps us write these messages and include a bit of extra information too.\n\nAdd this import at the top of `app.py`:\n\n```py title=\"app.py\"\nfrom flask_smorest import abort\n```\n\nAnd then let's change our error returns to use `abort`.\n\n```py title=\"app.py\"\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n # highlight-start\n abort(404, message=\"Store not found.\")\n # highlight-end\n```\n\nAnd here:\n\n```py title=\"app.py\"\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n # highlight-start\n abort(404, message=\"Item not found.\")\n # highlight-end\n```\n\n## Adding error handling on creating items and stores\n\nAt the moment when we create items and stores, we _expect_ there to be certain items in the JSON body of the request.\n\nIf those items are missing, the app will return an error 500, which means \"Internal Server Error\".\n\nInstead of that, it's good practice to return an error 400 and a message telling the client what went wrong.\n\nTo do so, let's inspect the body of the request and see if it contains the data we need.\n\nLet's change our `create_item()` function to this:\n\n```py title=\"app.py\"\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n```\n\nAnd our `create_store()` function to this:\n\n```py title=\"app.py\"\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n```"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/end/app.py",
"content": "import uuid\nfrom flask import Flask, request\nfrom flask_smorest import abort\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/start/app.py",
"content": "import uuid\nfrom flask import Flask, request\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n return {\"message\": \"Item not found\"}, 404\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n if item_data[\"store_id\"] not in stores:\n return {\"message\": \"Store not found\"}, 404\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n return {\"message\": \"Store not found\"}, 404\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/03_improvements_on_first_rest_api/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/README.md",
"content": "---\ntitle: \"New endpoints for our REST API\"\ndescription: \"Let's add a few routes to our first REST API, so it better matches what a production REST API would look like.\"\nctslug: new-endpoints-for-our-rest-api\n---\n\n# New endpoints for our REST API\n\n## New endpoints\n\nWe want to add some endpoints for added functionality:\n\n- `DELETE /item/` so we can delete items from the database.\n- `PUT /item/` so we can update items.\n- `DELETE /store/` so we can delete stores.\n\n### Deleting items\n\nThis is almost identical to getting items, but we use the `del` keyword to remove the entry from the dictionary.\n\n```py title=\"app.py\"\n@app.delete(\"/item/\")\ndef delete_item(item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\n### Updating items\n\nThis is almost identical to creating items, but in this API we've decided to not let item updates change the `store_id` of the item. So clients can change item name and price, but not the store that the item belongs to.\n\nThis is an API design decision, and you could very well allow clients to update the `store_id` if you want!\n\n```py title=\"app.py\"\n@app.put(\"/item/\")\ndef update_item(item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # You should also prevent keys that aren't 'price' or 'name' to be passed\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\n:::tip Dictionary update operators\nThe `|=` syntax is a new dictionary operator. You can read more about it [here](https://blog.teclado.com/python-dictionary-merge-update-operators/).\n:::\n\n### Deleting stores\n\nThis is very similar to deleting items!\n\n```py title=\"app.py\"\n@app.delete(\"/store/\")\ndef delete_store(store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n```\n"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/end/app.py",
"content": "import uuid\nfrom flask import Flask, request\nfrom flask_smorest import abort\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.delete(\"/item/\")\ndef delete_item(item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.put(\"/item/\")\ndef update_item(item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.delete(\"/store/\")\ndef delete_store(store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/start/app.py",
"content": "import uuid\nfrom flask import Flask, request\nfrom flask_smorest import abort\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/04_new_endpoints_for_api/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/README.md",
"content": "---\ntitle: \"Reloading API code in Docker container\"\ndescription: \"Learn how to get your code instantly synced up to the Docker container, so that every time you make a code change it restarts the app in the container and uses the latest code.\"\nctslug: reloading-api-code-in-docker-container\n---\n\n# Reloading API code in Docker container\n\n## Updating Dockerfile to use `requirements.txt`\n\nThis is the Dockerfile as we've got it:\n\n```dockerfile\nFROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]\n```\n\nBut there is a problem! It doesn't use the `requirements.txt`, so it only installs Flask as a dependency.\n\nWe want to add `requirements.txt` and install the dependencies from it. You might be tempted to move the `COPY` line above the `RUN` line, and then install it with `pip install -r requirements.txt`.\n\nBut there's a better way!\n\n```dockerfile\nFROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]\n```\n\nHere we:\n\n- Add a new `COPY` line that copies the `requirements.txt` file into the image. This creates a new cached layer, so that if the `requirements.txt` file doesn't change, this line and the following `RUN` line don't run again.\n- Change the `pip install` code to use `--no-cache-dir --upgrade`. This makes sure that we don't use any pre-existing pip caches when installing, and also upgrades libraries to the latest version if necessary.\n\n## Running the container with volumes for hot reloading\n\nUp to now, we've been re-building the Docker image and re-running the container each time we make a code change.\n\nThis is a bit of a time sink, and a bit annoying to do! Let's do it so that the Docker container runs the code that we're editing. That way, when we make a change to the code, the Flask app should restart and use the new code.\n\nAll we have to do is:\n\n1. Build the Docker image\n2. Run the image, but replace the contents of the image's `/app` directory (where the code is) by the contents of our source code folder in the host machine.\n\nSo, first build the Docker image:\n\n```\ndocker build -t flask-smorest-api .\n```\n\nOnce that's done, the image has an `/app` directory which contains the source code as it was copied from the host machine during the build stage.\n\nSo at this point, we _can_ run a container from this image, and it will run the app _as it was when it was built_:\n\n```\ndocker run -dp 5000:5000 flask-smorest-api\n```\n\nThis should just work, and you can try it out in the Insomnia REST Client to make sure the endpoints all work.\n\nBut like we said earlier, when we make changes to the code we'll have to rebuild and rerun.\n\nSo instead, what we can do is run the image, but replace the image's `/app` directory with the host's source code folder.\n\nThat will cause the source code to change in the Docker container while it's running. And, since we've ran Flask with debug mode on, the Flask app will automatically restart when the code changes.\n\nTo do so, stop the running container (if you have one running), and use this command instead:\n\n```\ndocker run -dp 5000:5000 -w /app -v \"$(pwd):/app\" flask-smorest-api\n```\n\n:::info Windows command\nThe command on Windows varies depending on what terminal application you use. Here are some of the most popular ones!\n\n**PowerShell**\n\n```\ndocker run -dp 5000:5000 -w //app -v \"$(Get-Location)://app\" flask-smorest-api\n```\n\n**Git Bash**\n\n```\ndocker run -dp 5000:5000 -w //app -v \"//$(pwd)://app\" flask-smorest-api\n```\n\n**Command Prompt (CMD)**\n\n```\ndocker run -dp 5000:5000 -w //app -v \"%cd%://app\" flask-smorest-api\n```\n:::\n\n- `-dp 5000:5000` - same as before. Run in detached (background) mode and create a port mapping.\n- `-w /app` - sets the container's present working directory where the command will run from.\n- `-v \"$(pwd):/app\"` - bind mount (link) the host's present directory to the container's `/app` directory. Note: Docker requires absolute paths for binding mounts, so in this example we use `pwd` for printing the absolute path of the working directory instead of typing it manually.\n- `flask-smorest-api` - the image to use.\n\nAnd with this, your Docker container now is running the code as shown in your IDE. Plus, since Flask is running with debug mode on, the Flask app will restart when you make code changes!\n\n:::info\nUsing this kind of volume mapping only makes sense _during development_. When you share your Docker image or deploy it, you won't be sharing anything from the host to the container. That's why it's still important to include the original source code in the image when you build it.\n:::\n\nJust to recap, here are the two ways we've seen to run your Docker container:\n\n"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/end/app.py",
"content": "import uuid\nfrom flask import Flask, request\nfrom flask_smorest import abort\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.delete(\"/item/\")\ndef delete_item(item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.put(\"/item/\")\ndef update_item(item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.delete(\"/store/\")\ndef delete_store(store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nRUN pip install flask\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/start/app.py",
"content": "import uuid\nfrom flask import Flask, request\nfrom flask_smorest import abort\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.delete(\"/item/\")\ndef delete_item(item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.put(\"/item/\")\ndef update_item(item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # Here you might also want to add the items in this store\n # We'll do that later on in the course\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n\n\n@app.delete(\"/store/\")\ndef delete_store(store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/05_reload_api_docker_container/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/README.md",
"content": "---\ntitle: How to use Blueprints and MethodViews\ndescription: Flask-Smorest MethodViews allow us to simplify API Resources by defining all methods that interact with the resource in one Python class.\nctslug: how-to-use-flask-smorest-methodviews-blueprints\n---\n\n# How to use Flask-Smorest MethodViews and Blueprints\n\nLet's improve the structure of our code by splitting items and stores endpoints into their own files.\n\nLet's create a `resources` folder, and inside it create `item.py` and `store.py`.\n\n## Creating a blueprint for each related group of resources\n\n### `resources/store.py`\n\nLet's start in `store.py`, and create a `Blueprint`:\n\n```py title=\"resources/store.py\"\nimport uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\n\n\nblp = Blueprint(\"stores\", __name__, description=\"Operations on stores\")\n```\n\nThe `Blueprint` arguments are the same as the Flask `Blueprint`[^1], with an added optional `description` keyword argument:\n\n1. `\"stores\"` is the name of the blueprint. This will be shown in the documentation and is prepended to the endpoint names when you use `url_for` (we won't use it).\n2. `__name__` is the \"import name\".\n3. The `description` will be shown in the documentation UI.\n\n\nNow that we've got this, let's add our `MethodView`s. These are classes where each method maps to one endpoint. The interesting thing is that method names are important:\n\n```py title=\"resources/store.py\"\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(self, store_id):\n pass\n\n def delete(self, store_id):\n pass\n```\n\nTwo things are going on here:\n\n1. The endpoint is associated to the `MethodView` class. Here, the class is called `Store` and the endpoint is `/store/`.\n2. There are two methods inside the `Store` class: `get` and `delete`. These are going to map directly to `GET /store/` and `DELETE /store/`.\n\nNow we can copy the code from earlier into each of the methods:\n\n```py title=\"resources/store.py\"\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(self, store_id):\n try:\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(self, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n```\n\nNow, still inside the same file, we can add another `MethodView` with a different endpoint, for the `/store` route:\n\n```py title=\"resources/store.py\"\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(self):\n return {\"stores\": list(stores.values())}\n\n def post(self):\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n```\n\n### `resources/item.py`\n\nLet's do the same thing with the `resources/item.py` file:\n\n```py title=\"resources/item.py\"\nimport uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def put(self, item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n def post(self):\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n```\n\n## Import blueprints and Flask-Smorest configuration\n\nFinally, we have to import the `Blueprints` inside `app.py`, and register them with Flask-Smorest:\n\n```py title=\"app.py\"\nfrom flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n```\n\nI've also added a few config variables to the `app.config`. The `PROPAGATE_EXCEPTIONS` value is used so that when an exception is raised in an extension, it is bubbled up to the main Flask app so you'd see it more easily.\n\nThe other config values are there for the documentation of our API, and they define things such as the API name and version, as well as information for the Swagger UI.\n\nNow you should be able to go to `http://127.0.0.1:5000/swagger-ui` and see your Swagger documentation rendered out!\n\n[^1]: [Flask Blueprint (Flask Official Documentation)](https://flask.palletsprojects.com/en/2.1.x/api/#flask.Blueprint)"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/resources/item.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def put(self, item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n def post(self):\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/end/resources/store.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(self, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(self, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(self):\n return {\"stores\": list(stores.values())}\n\n def post(self):\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/start/app.py",
"content": "import uuid\nfrom flask import Flask, request\nfrom flask_smorest import abort\n\nfrom db import stores, items\n\n\napp = Flask(__name__)\n\n\n@app.get(\"/item/\")\ndef get_item(item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.delete(\"/item/\")\ndef delete_item(item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.put(\"/item/\")\ndef update_item(item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@app.get(\"/item\")\ndef get_all_items():\n return {\"items\": list(items.values())}\n\n\n@app.post(\"/item\")\ndef create_item():\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n\n\n@app.get(\"/store/\")\ndef get_store(store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.delete(\"/store/\")\ndef delete_store(store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@app.get(\"/store\")\ndef get_stores():\n return {\"stores\": list(stores.values())}\n\n\n@app.post(\"/store\")\ndef create_store():\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/06_api_with_method_views/start/requirements.txt",
"content": "flask\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/README.md",
"content": "---\ntitle: Adding marshmallow schemas\ndescription: A marshmallow schema is useful for validation and serialization. Learn how to write them in this lecture.\nctslug: adding-marshmallow-schemas\n---\n\n# Adding marshmallow schemas\n\nSomething that we're lacking in our API at the moment is validation. We've done a _tiny_ bit of it with this kind of code:\n\n```py\nif (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n```\n\nBut there's so much more we can do. For starters, some data points may be optional in some endpoints. We also want to check the data type is correct (i.e. `price` shouldn't be a string, for example).\n\nTo do this kind of checking we can construct a massive `if` statement, or we can use a library that is made specifically for it.\n\nThe `marshmallow`[^1] library is used to define _what_ data fields we want, and then we can pass incoming data through the validator. We can also go the other way round, and give it a Python object which `marshmallow` then turns into a dictionary.\n\n## Writing the `ItemSchema`\n\nHere's the definition of an `Item` using `marshmallow` (this is called a **schema**):\n\n```py title=\"schemas.py\"\nfrom marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n```\n\nA couple of weird things maybe!\n\nThe `id` field is a string, but it has the `dump_only=True` argument. This means that when we use marshmallow to _validate incoming data_, the `id` field won't be used or expected. However, when we use marshmallow to _serialize_ data to be returned to a client, the `id` field will be included in the output.\n\nThe other fields will be used for both validation and serialization, and since they have the `required=True` argument, that means that when we do validation if the fields are not present, an error will be raised.\n\n`marshmallow` will also check the data type with `fields.Float` and `fields.Int`.\n\n## Writing the `ItemUpdateSchema`\n\nSomething that even to do this day sits a bit weird with me is having multiple different schemas for different applications.\n\nWhen we want to update an Item, we have different requirements than when we want to create an item.\n\nThe main difference is that the incoming data to our API when we update an item is different than when we create one. Fields are optional, such that not all item fields should be required. Also, you may not want to allow certain fields _at all_.\n\nThis is the `ItemUpdateSchema`:\n\n```py title=\"schemas.py\"\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n```\n\nAs you can see, these are not `required=True`. I've also taken off the `id` and `store_id` fields, because:\n\n- This schema will only be used for incoming data, and we will never receive an `id`.\n- We don't want clients to be able to change the `store_id` of an item. If you wanted to allow this, you can add the `store_id` field here as well.\n\n## Writing the `StoreSchema`\n\n```py title=\"schemas.py\"\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n```\n\nThere's not much to explain here! Similar to the `ItemSchema`, we have `id` and `name` since those are the only fields we need for a store."
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/resources/item.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def put(self, item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n def post(self):\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/resources/store.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(cls, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(cls):\n return {\"stores\": list(stores.values())}\n\n def post(cls):\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/resources/item.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def put(self, item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n def post(self):\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/07_marshmallow_schemas/start/resources/store.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(cls, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(cls):\n return {\"stores\": list(stores.values())}\n\n def post(cls):\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/README.md",
"content": "---\ntitle: Validation with marshmallow\ndescription: We can use the marshmallow library to validate request data from our API clients.\nctslug: validation-with-marshmallow\n---\n\n# Validation with marshmallow\n\nNow that we've got our schemas written, let's use them to validate incoming data to our API.\n\nWith Flask-Smorest, this couldn't be easier!\n\nLet's start with `resources/item.py`\n\n## Validation in `resources/item.py`\n\nAt the top of the file, import the schemas:\n\n```py\nfrom schemas import ItemSchema, ItemUpdateSchema\n```\n\nWe have two sets of data that may be incoming (in the JSON body of a request): new items and updating items.\n\nSo let's go to the `ItemList#post` method and make a couple changes!\n\nFirst, let's get rid of the existing data validation. Delete the highlighted lines below:\n\n```py\ndef post(self):\n # highlight-start\n item_data = request.get_json()\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n # highlight-end\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n```\n\nNow, I know what you're thinking! What about `item_data`? Do we not need to keep that?\n\nWhen we use `marshmallow` for validation with Flask-Smorest, it will inject the validated data into our method for us.\n\nLook at these two highlighted lines:\n\n```py\n# highlight-start\n@blp.arguments(ItemSchema)\ndef post(self, item_data):\n # highlight-end\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n```\n\nNice!\n\nPlus, doing this also adds to your Swagger UI documentation.\n\nLet's do the same when updating items:\n\n```py\n# highlight-start\n@blp.arguments(ItemUpdateSchema)\ndef put(self, item_data, item_id):\n # highlight-end\n try:\n item = items[item_id]\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\n:::caution Order of parameters\nBe careful here since we've now got `item_data` and `item_id`. The URL arguments come in at the end. The injected arguments are passed first, so `item_data` goes before `item_id` in our function signature.\n:::\n\n## Validation in `resources/store.py`\n\nNow let's do the same in `store.py`!\n\nAt the top of the file, import the schema:\n\n```py\nfrom schemas import StoreSchema\n```\n\nWhen creating a store, we'll have this:\n\n```py\n@blp.arguments(StoreSchema)\ndef post(cls, store_data):\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n```"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/resources/item.py",
"content": "import uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom schemas import ItemSchema, ItemUpdateSchema\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n @blp.arguments(ItemUpdateSchema)\n def put(self, item_data, item_id):\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n @blp.arguments(ItemSchema)\n def post(self, item_data):\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/resources/store.py",
"content": "import uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(cls, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(cls):\n return {\"stores\": list(stores.values())}\n\n @blp.arguments(StoreSchema)\n def post(cls, store_data):\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/resources/item.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def put(self, item_id):\n item_data = request.get_json()\n # There's more validation to do here!\n # Like making sure price is a number, and also both items are optional\n # Difficult to do with an if statement...\n if \"price\" not in item_data or \"name\" not in item_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'price', and 'name' are included in the JSON payload.\",\n )\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n def post(self):\n item_data = request.get_json()\n # Here not only we need to validate data exists,\n # But also what type of data. Price should be a float,\n # for example.\n if (\n \"price\" not in item_data\n or \"store_id\" not in item_data\n or \"name\" not in item_data\n ):\n abort(\n 400,\n message=\"Bad request. Ensure 'price', 'store_id', and 'name' are included in the JSON payload.\",\n )\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/resources/store.py",
"content": "import uuid\nfrom flask import request\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(cls, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(cls):\n return {\"stores\": list(stores.values())}\n\n def post(cls):\n store_data = request.get_json()\n if \"name\" not in store_data:\n abort(\n 400,\n message=\"Bad request. Ensure 'name' is included in the JSON payload.\",\n )\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/08_validation_with_marshmallow/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/README.md",
"content": "---\ntitle: Decorating responses with Flask-Smorest\ndescription: Add response serialization and status code to API endpoints, and add to your documentation in the process.\nctslug: decorating-responses-with-flask-smorest\n---\n\n# Decorating responses with Flask-Smorest\n\nWe can use marshmallow schemas for serialization when we respond to a client. To do so, we need to tell Flask-Smorest what Schema to use when responding.\n\nThis will do a few things:\n\n1. Update your documentation to show what data and status code will be returned by the endpoint.\n2. Pass any data your endpoint returns through the marshmallow schema, casting data types and removing data that isn't in the schema.\n\n## Decorating responses in `resources/item.py`\n\nLet's start with retrieving a specific item.\n\nUp until now, we've been doing this:\n\n```py\ndef get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\nBut now we can run the `items[item_id]` dictionary through the marshmallow schema and tell Flask-Smorest about it so the documentation will be updated:\n\n```py\n@blp.response(200, ItemSchema)\ndef get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\n:::info\nThe number, `200`, is the status code. It means \"OK\" (all good).\n:::\n\nOur endpoint for updating items looks like this:\n\n```py\n@blp.arguments(ItemUpdateSchema)\ndef put(self, item_data, item_id):\n try:\n item = items[item_id]\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\nLet's pass this through the schema as well:\n\n```py\n@blp.arguments(ItemUpdateSchema)\n# highlight-start\n@blp.response(200, ItemSchema)\n# highlight-end\ndef put(self, item_data, item_id):\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n```\n\n:::caution\nCareful with the order of decorators in these functions!\n:::\n\nWhen we get to returning a list of items, it looks like this:\n\n```py\n# highlight-start\n@blp.response(200, ItemSchema(many=True))\n# highlight-end\ndef get(self):\n return items.values()\n```\n\nAnd finally, don't forget to decorate the new item endpoint too:\n\n```py\n@blp.arguments(ItemSchema)\n# highlight-start\n@blp.response(201, ItemSchema)\n# highlight-end\ndef post(self, item_data):\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n```\n\n## Decorating responses in `resources/store.py`\n\nGoing a bit more quickly here since you already know what's going on with this decorator. The highlighted lines are new:\n\n```py title=\"resources/store.py\"\nimport uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n # highlight-start\n @blp.response(200, StoreSchema)\n # highlight-end\n def get(cls, store_id):\n try:\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n # highlight-start\n @blp.response(200, StoreSchema(many=True))\n # highlight-end\n def get(cls):\n return stores.values()\n\n @blp.arguments(StoreSchema)\n # highlight-start\n @blp.response(201, StoreSchema)\n # highlight-end\n def post(cls, store_data):\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n```"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/resources/item.py",
"content": "import uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom schemas import ItemSchema, ItemUpdateSchema\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return items.values()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/resources/store.py",
"content": "import uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(cls, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(cls):\n return stores.values()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(cls, store_data):\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/db.py",
"content": "\"\"\"\ndb.py\n---\n\nLater on, this file will be replaced by SQLAlchemy. For now, it mimics a database.\nOur data storage is:\n - stores have a unique ID and a name\n - items have a unique ID, a name, a price, and a store ID.\n\"\"\"\n\nstores = {}\nitems = {}\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/resources/__init__.py",
"content": "\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/resources/item.py",
"content": "import uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n\nfrom schemas import ItemSchema, ItemUpdateSchema\nfrom db import items\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n def get(self, item_id):\n try:\n return items[item_id]\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n def delete(self, item_id):\n try:\n del items[item_id]\n return {\"message\": \"Item deleted.\"}\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n @blp.arguments(ItemUpdateSchema)\n def put(self, item_data, item_id):\n try:\n item = items[item_id]\n\n # https://blog.teclado.com/python-dictionary-merge-update-operators/\n item |= item_data\n\n return item\n except KeyError:\n abort(404, message=\"Item not found.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n def get(self):\n return {\"items\": list(items.values())}\n\n @blp.arguments(ItemSchema)\n def post(self, item_data):\n for item in items.values():\n if (\n item_data[\"name\"] == item[\"name\"]\n and item_data[\"store_id\"] == item[\"store_id\"]\n ):\n abort(400, message=f\"Item already exists.\")\n\n item_id = uuid.uuid4().hex\n item = {**item_data, \"id\": item_id}\n items[item_id] = item\n\n return item\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/resources/store.py",
"content": "import uuid\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom db import stores\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n def get(cls, store_id):\n try:\n # You presumably would want to include the store's items here too\n # More on that when we look at databases\n return stores[store_id]\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n def delete(cls, store_id):\n try:\n del stores[store_id]\n return {\"message\": \"Store deleted.\"}\n except KeyError:\n abort(404, message=\"Store not found.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n def get(cls):\n return {\"stores\": list(stores.values())}\n\n @blp.arguments(StoreSchema)\n def post(cls, store_data):\n for store in stores.values():\n if store_data[\"name\"] == store[\"name\"]:\n abort(400, message=f\"Store already exists.\")\n\n store_id = uuid.uuid4().hex\n store = {**store_data, \"id\": store_id}\n stores[store_id] = store\n\n return store\n"
},
{
"path": "docs/docs/05_flask_smorest/09_decorating_responses/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/05_flask_smorest/Insomnia_section5_Docker.json",
"content": "{\"_type\":\"export\",\"__export_format\":4,\"__export_date\":\"2022-11-09T15:36:20.139Z\",\"__export_source\":\"insomnia.desktop.app:v2022.6.0\",\"resources\":[{\"_id\":\"req_08302ba35f784bdc9fa2edc0cb080287\",\"parentId\":\"fld_0bc4d91251f54e1d8e00966a259b35bc\",\"modified\":1666985452213,\"created\":1666905719010,\"url\":\"{{url}}/store\",\"name\":\"/store Get all store data\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423181,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_0bc4d91251f54e1d8e00966a259b35bc\",\"parentId\":\"wrk_e6c8aab80c134d35810fd37d43cce51e\",\"modified\":1666905719008,\"created\":1666905719008,\"name\":\"Stores\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528974,\"_type\":\"request_group\"},{\"_id\":\"wrk_e6c8aab80c134d35810fd37d43cce51e\",\"parentId\":null,\"modified\":1666991880304,\"created\":1666905718998,\"name\":\"Section 5 - Docker\",\"description\":\"\",\"scope\":\"collection\",\"_type\":\"workspace\"},{\"_id\":\"req_6fdedbe47a9941af9b8459816f179274\",\"parentId\":\"fld_0bc4d91251f54e1d8e00966a259b35bc\",\"modified\":1666985886605,\"created\":1666905719013,\"url\":\"{{url}}/store/STORE_ID\",\"name\":\"/store/\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423156,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_0c240b23280746a6a1a56d7644fb89ce\",\"parentId\":\"fld_0bc4d91251f54e1d8e00966a259b35bc\",\"modified\":1666987464108,\"created\":1666905719011,\"url\":\"{{url}}/store\",\"name\":\"/store Create new store\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"My store2\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666124423143.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_fc255f6789fe45ed80b2ef83e6bb6645\",\"parentId\":\"fld_0bc4d91251f54e1d8e00966a259b35bc\",\"modified\":1666985462540,\"created\":1666905719014,\"url\":\"{{url}}/store/STORE_ID\",\"name\":\"/store/ Delete store\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423131,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_b42e3c4d855a433394ac1a8a60c2b91b\",\"parentId\":\"fld_80dee5df10c347198d8f12d85703d582\",\"modified\":1666985467338,\"created\":1666905719020,\"url\":\"{{url}}/item\",\"name\":\"/item Get all items\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104308,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_80dee5df10c347198d8f12d85703d582\",\"parentId\":\"wrk_e6c8aab80c134d35810fd37d43cce51e\",\"modified\":1666905719016,\"created\":1666905719016,\"name\":\"Items\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528924,\"_type\":\"request_group\"},{\"_id\":\"req_9a89b2ecfc61457d8cac15985597c0a0\",\"parentId\":\"fld_80dee5df10c347198d8f12d85703d582\",\"modified\":1666986841489,\"created\":1666905719023,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Get item\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104258,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_3d189bf5d88349e3bce363a420407f65\",\"parentId\":\"fld_80dee5df10c347198d8f12d85703d582\",\"modified\":1666987468265,\"created\":1666905719018,\"url\":\"{{url}}/item\",\"name\":\"/item Create item\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Chair\\\",\\n\\t\\\"price\\\": 17.99,\\n\\t\\\"store_id\\\": \\\"8efca659f8674c56b5cd035ecc0d42ec\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104220.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_35d865c76bce4e1b9c378d82ece413f7\",\"parentId\":\"fld_80dee5df10c347198d8f12d85703d582\",\"modified\":1666985474126,\"created\":1666905719019,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Delete item\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104214.25,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_c2bf495d5cbb49d8b933b832a717662a\",\"parentId\":\"fld_80dee5df10c347198d8f12d85703d582\",\"modified\":1666987071504,\"created\":1666905719022,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Update item\",\"description\":\"\",\"method\":\"PUT\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Another Chair\\\",\\n\\t\\\"price\\\": 20.00\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104208,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"env_adf22718b4e044e5b54b37c869463582\",\"parentId\":\"wrk_e6c8aab80c134d35810fd37d43cce51e\",\"modified\":1666985430514,\"created\":1666905719000,\"name\":\"Base Environment\",\"data\":{\"url\":\"http://127.0.0.1:5005\"},\"dataPropertyOrder\":{\"&\":[\"url\"]},\"color\":null,\"isPrivate\":false,\"metaSortKey\":1666122928025,\"_type\":\"environment\"},{\"_id\":\"jar_210b7ba8709f44f29c305ed544da17c3\",\"parentId\":\"wrk_e6c8aab80c134d35810fd37d43cce51e\",\"modified\":1666905719004,\"created\":1666905719004,\"name\":\"Default Jar\",\"cookies\":[],\"_type\":\"cookie_jar\"},{\"_id\":\"spc_7a427f233a494727845a45ba1325ea85\",\"parentId\":\"wrk_e6c8aab80c134d35810fd37d43cce51e\",\"modified\":1666905719034,\"created\":1666905719007,\"fileName\":\"Flask-Smorest-Docker\",\"contents\":\"\",\"contentType\":\"yaml\",\"_type\":\"api_spec\"}]}"
},
{
"path": "docs/docs/05_flask_smorest/Insomnia_section5_before_Docker.json",
"content": "{\"_type\":\"export\",\"__export_format\":4,\"__export_date\":\"2022-11-09T15:35:47.649Z\",\"__export_source\":\"insomnia.desktop.app:v2022.6.0\",\"resources\":[{\"_id\":\"req_3d2b5cd58a4b4a6983c133118c5f8027\",\"parentId\":\"fld_afac4dd2683746c586c6ff61228611de\",\"modified\":1666125193227,\"created\":1666124761134,\"url\":\"http://127.0.0.1:5000/store\",\"name\":\"/store Get all store data\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423181,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_afac4dd2683746c586c6ff61228611de\",\"parentId\":\"wrk_acbd4ac11e8a40e5be2e6dad8ec6174a\",\"modified\":1666125229064,\"created\":1666124761133,\"name\":\"Stores\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528974,\"_type\":\"request_group\"},{\"_id\":\"wrk_acbd4ac11e8a40e5be2e6dad8ec6174a\",\"parentId\":null,\"modified\":1666991873213,\"created\":1666124761123,\"name\":\"Section 5 before Docker\",\"description\":\"\",\"scope\":\"collection\",\"_type\":\"workspace\"},{\"_id\":\"req_bd3ecff11e5b49baa489812528235afb\",\"parentId\":\"fld_afac4dd2683746c586c6ff61228611de\",\"modified\":1666902781180,\"created\":1666124761139,\"url\":\"http://127.0.0.1:5000/store/STORE_ID\",\"name\":\"/store/\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423156,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_b9dafd45675e4c478fa4dd125f4827b3\",\"parentId\":\"fld_afac4dd2683746c586c6ff61228611de\",\"modified\":1666902941803,\"created\":1666124761136,\"url\":\"http://127.0.0.1:5000/store\",\"name\":\"/store Create new store\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"My store2\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666124423143.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_34cbd59313d44bbfa4fd70166e341b05\",\"parentId\":\"fld_afac4dd2683746c586c6ff61228611de\",\"modified\":1666902749338,\"created\":1666124977832,\"url\":\"http://127.0.0.1:5000/store/STORE_ID\",\"name\":\"/store/ Delete store\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423131,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_637d0fb6ba9d4c25b6ad9f5bdda73036\",\"parentId\":\"fld_91ec9103821245f69f82aa78362f81e1\",\"modified\":1666902961406,\"created\":1666125038450,\"url\":\"http://127.0.0.1:5000/item\",\"name\":\"/item Get all items\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104308,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_91ec9103821245f69f82aa78362f81e1\",\"parentId\":\"wrk_acbd4ac11e8a40e5be2e6dad8ec6174a\",\"modified\":1666125224286,\"created\":1666124761144,\"name\":\"Items\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528924,\"_type\":\"request_group\"},{\"_id\":\"req_e581f2420345418c84d71dbed226b6da\",\"parentId\":\"fld_91ec9103821245f69f82aa78362f81e1\",\"modified\":1666125710431,\"created\":1666125184534,\"url\":\"http://127.0.0.1:5000/item/ITEM_ID\",\"name\":\"/item/ Get item\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104258,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_d48cf679c2664c9bb566b600634b966f\",\"parentId\":\"fld_91ec9103821245f69f82aa78362f81e1\",\"modified\":1666902939274,\"created\":1666124761145,\"url\":\"http://127.0.0.1:5000/item\",\"name\":\"/item Create item\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Chair\\\",\\n\\t\\\"price\\\": 17.99,\\n\\t\\\"store_id\\\": \\\"f48f94a4760e40d39debf155396a9dec\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104220.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_8982d9bcce734f60a9f27a8eb1fc748c\",\"parentId\":\"fld_91ec9103821245f69f82aa78362f81e1\",\"modified\":1666125332019,\"created\":1666124928966,\"url\":\"http://127.0.0.1:5000/item/ITEM_ID\",\"name\":\"/item/ Delete item\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104214.25,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_99fbb0c34cd049f1bb8ac4e944f0ae6d\",\"parentId\":\"fld_91ec9103821245f69f82aa78362f81e1\",\"modified\":1666902838552,\"created\":1666125104208,\"url\":\"http://127.0.0.1:5000/item/ITEM_ID\",\"name\":\"/item/ Update item\",\"description\":\"\",\"method\":\"PUT\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Another Chair\\\",\\n\\t\\\"price\\\": 20.00\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104208,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"env_6b3e8bb38d0c4154826d63642b863687\",\"parentId\":\"wrk_acbd4ac11e8a40e5be2e6dad8ec6174a\",\"modified\":1666124761125,\"created\":1666124761125,\"name\":\"Base Environment\",\"data\":{},\"dataPropertyOrder\":null,\"color\":null,\"isPrivate\":false,\"metaSortKey\":1666122928025,\"_type\":\"environment\"},{\"_id\":\"jar_9b95c15dadb44c03bf60cc7386095847\",\"parentId\":\"wrk_acbd4ac11e8a40e5be2e6dad8ec6174a\",\"modified\":1666124761128,\"created\":1666124761128,\"name\":\"Default Jar\",\"cookies\":[],\"_type\":\"cookie_jar\"},{\"_id\":\"spc_cfb94f75feff4930966c80f350b1e115\",\"parentId\":\"wrk_acbd4ac11e8a40e5be2e6dad8ec6174a\",\"modified\":1666124761155,\"created\":1666124761131,\"fileName\":\"Flask-Smorest\",\"contents\":\"\",\"contentType\":\"yaml\",\"_type\":\"api_spec\"}]}"
},
{
"path": "docs/docs/05_flask_smorest/_category_.json",
"content": "{\n \"label\": \"Flask-Smorest for More Efficient Development\",\n \"position\": 5\n}\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/01_project_overview_sqlalchemy/README.md",
"content": "---\ntitle: Project Overview, and why use SQLAlchemy\ndescription: Let's look at what we'll do in this section. There are no changes to the client-facing API at all, just changes internally to how we store data.\nctslug: project-overview-why-use-sqlalchemy\n---\n\n# Project Overview (and why use SQLAlchemy)\n\n:::tip Insomnia files\nRemember to get the Insomnia files for this section or for all sections [here](/insomnia-files/)!\n:::\n\nIn this section we'll make absolutely no changes to the API! However, we will completely change the way we store data.\n\nUp until now, we've been storing data in an \"in-memory database\": a couple of Python dictionaries. When we stop the app, the data is destroyed. This is obviously not great, so we want to move to a proper store that can keep data around between app restarts!\n\nWe'll be using a relational database for data storage, and there are many different options: SQLite, MySQL, PostgreSQL, and others.\n\nAt this point we have two options regarding how to interact with the database:\n\n1. We can write SQL code and execute it ourselves. For example, when we want to add an item to the database we'd write something like `INSERT INTO items (name, price, store_id) VALUES (\"Chair\", 17.99, 1)`.\n2. We can use an ORM, which can take Python objects and turn them into database rows.\n\nFor this project, we are going to use an ORM because it makes the code much cleaner and simpler. Also, the ORM library (SQLAlchemy) helps us with many potential issues with using SQL, such as:\n\n- Multi-threading support\n- Handling creating the tables and defining the rows\n- Database migrations (with help of another library, Alembic)\n- Like mentioned, it makes the code cleaner, simpler, and shorter\n\nTo get started, add the following to the `requirements.txt` file:\n\n```text title=\"requirements.txt\"\nsqlalchemy\nflask-sqlalchemy\n```\n\n\n What is Flask-SQLAlchemy?
\n \n
SQLAlchemy is the ORM library, that helps map Python classes to database tables and columns, and turns Python objects of those classes into specific rows.
\n
Flask-SQLAlchemy is a Flask extension which helps connect SQLAlchemy to Flask apps.
\n
\n\nWith this, install your requirements (remember to activate your virtual environment first!).\n\n```\npip install -r requirements.txt\n```\n\nLet's begin creating our SQLAlchemy models in the next lecture."
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/README.md",
"content": "---\ntitle: Create a simple SQLAlchemy Model\ndescription: Lecture description goes here.\nctslug: create-a-simple-sqlalchemy-model\n---\n\n# Create a simple SQLAlchemy Model\n\n## Initialize the SQLAlchemy instance\n\n```python title=\"db.py\"\nfrom flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n```\n\n## Create models without relationships\n\nEvery model inherits from `db.Model`. That way when we tell SQLAlchemy about them (in [Configure Flask-SQLAlchemy](../configure_flask_sqlalchemy))), it will know to look at them to create tables.\n\nEvery model also has a few properties that let us interact with the database through the model, such as `query` (more on this in [Insert models in the database with SQLAlchemy](../insert_models_sqlalchemy)).\n\n```python title=\"models/item.py\"\nfrom db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n store_id = db.Column(db.Integer, unique=False, nullable=False)\n```\n\n```python title=\"models/store.py\"\nfrom db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n```"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n store_id = db.Column(db.Integer, unique=False, nullable=False)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Int(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/requirements.txt",
"content": "flask\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/02_create_simple_sqlalchemy_model/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass ItemSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n store_id = fields.Str(required=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(Schema):\n id = fields.Str(dump_only=True)\n name = fields.Str(required=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/README.md",
"content": "---\ntitle: One-to-many relationships with SQLAlchemy\ndescription: Model relationships let us easily retrieve information about a related model, without having to do SQL JOINs manually.\nctslug: one-to-many-relationships-with-sqlalchemy\n---\n\n# One-to-many relationships with SQLAlchemy\n\n```python title=\"models/item.py\"\nfrom db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n # highlight-start\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n # highlight-end\n```\n\n```python title=\"models/store.py\"\nfrom db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n # highlight-start\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n # highlight-end\n```\n\nTo make it easier to import and use the models, I'll also create a `models/__init__.py` file that imports the models from their files:\n\n```python title=\"models/__init__.py\"\nfrom models.store import StoreModel\nfrom models.item import ItemModel\n```\n\n## What is `lazy=\"dynamic\"`?\n\nWithout `lazy=\"dynamic\"`, the `items` attribute of the `StoreModel` resolves to a list of `ItemModel` objects.\n\nWith `lazy=\"dynamic\"`, the `items` attribute resolves to a SQLAlchemy **query**, which has some benefits and drawbacks:\n\n- A key benefit is load speed. Because SQLAlchemy doesn't have to go to the `items` table and load items, stores will load faster.\n- A key drawback is accessing the `items` of a store isn't as easy.\n - However this has another hidden benefit, which is that when you _do_ load items, you can do things like filtering before loading.\n\nHere's how you could get all the items, giving you a list of `ItemModel` objects. Assume `store` is a `StoreModel` instance:\n\n```python\nstore.items.all()\n```\n\nAnd here's how you would do some filtering:\n\n```python\nstore.items.filter_by(name==\"Chair\").first()\n```\n\n## Updating our marshmallow schemas\n\nNow that the models have these relationships, we can modify our marshmallow schemas so they will return some or all of the information about the related models.\n\nWe do this with the `Nested` marshmallow field.\n\n:::caution\nSomething to be careful about is having schema A which has a nested schema B, which has a nested schema A.\n\nThis will lead to an infinite nesting, which is obviously never what you want!\n:::\n\nTo avoid infinite nesting, we are renaming our schemas which _don't_ use nested fields to `Plain`, such as `PlainItemSchema` and `PlainStoreSchema`.\n\nThen the schemas that _do_ use nesting can be called `ItemSchema` and `StoreSchema`, and they inherit from the plain schemas. This reduces duplication and prevents infinite nesting.\n\n```python title=\"schemas.py\"\nfrom marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n```"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n store_id = db.Column(db.Integer, unique=False, nullable=False)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/03_one_to_many_relationships_sqlalchemy/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/README.md",
"content": "---\ntitle: Configure Flask-SQLAlchemy\ndescription: Link Flask-SQLAlchemy with our Flask app and create the initial tables.\nctslug: configure-flask-sqlalchemy\n---\n\n# Configure Flask-SQLAlchemy\n\nWe want to add two imports to `app.py`:\n\n```python title=\"app.py\"\nfrom db import db\n\nimport models\n```\n\n## The Flask app factory pattern\n\nUp until now, we've been creating the `app` variable (which is the Flask app) directly in `app.py`.\n\nWith the app factory pattern, we write a function that _returns_ `app`. That way we can _pass configuration values_ to the function, so that we configure the app before getting it back.\n\nThis is especially useful for testing, but also if you want to do things like have staging and production apps.\n\nTo do the app factory, all we do is place all the app-creation code inside a function which **must be called `create_app()`**.\n\n```python title=\"app.py\"\nfrom flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n# highlight-start\ndef create_app():\n app = Flask(__name__)\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n api = Api(app)\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n# highlight-end\n```\n\n## Add Flask-SQLAlchemy code to the app factory\n\n```python title=\"app.py\"\nimport os\n\nfrom flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n# highlight-start\ndef create_app(db_url=None):\n # highlight-end\n app = Flask(__name__)\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n # highlight-start\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or os.getenv(\"DATABASE_URL\", \"sqlite:///data.db\")\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n db.init_app(app)\n # highlight-end\n api = Api(app)\n\n # highlight-start\n with app.app_context():\n db.create_all()\n # highlight-end\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n```\n\nWe've done three things:\n\n1. Added the `db_url` parameter. This lets us create an app with a certain database URL, or alternatively try to fetch the database URL from the environment variables. The default value will be a local SQLite file, if we don't pass a value ourselves and it isn't in the environment.\n2. Added two SQLAlchemy values to `app.config`. One is the database URL (or URI), the other is a [configuration option](https://flask-sqlalchemy.palletsprojects.com/en/2.x/config/) which improves performance.\n3. When the app is created, tell SQLAlchemy to create all the database tables we need.\n\n:::tip How does SQLAlchemy know what tables to create?\nThe line `import models` lets SQLAlchemy know what models exist in our application. Because they are `db.Model` instances, SQLAlchemy will look at their `__tablename__` and defined `db.Column` attributes to create the tables.\n:::\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\napp = Flask(__name__)\n\napp.config[\"PROPAGATE_EXCEPTIONS\"] = True\napp.config[\"API_TITLE\"] = \"Stores REST API\"\napp.config[\"API_VERSION\"] = \"v1\"\napp.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\napp.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\napp.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\napp.config[\"OPENAPI_SWAGGER_UI_URL\"] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n\napi = Api(app)\n\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/04_configure_flask_sqlalchemy/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/README.md",
"content": "---\ntitle: Insert models in the database with SQLAlchemy\ndescription: Learn how to use SQLAlchemy to add new rows to our SQL database.\nctslug: insert-models-in-database-with-sqlalchemy\n---\n\n# Insert models in the database with SQLAlchemy\n\nInserting models with SQLAlchemy couldn't be easier! We'll use the `db.session`[^1] variable to `.add()` a model. Let's begin working on our `Item` resource:\n\n```python title=\"resources/item.py\"\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\n\n...\n\n@blp.arguments(ItemSchema)\n@blp.response(201, ItemSchema)\ndef post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n```\n\nSimilarly in our `Store` resource:\n\n```python title=\"resources/store.py\"\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\n\n...\n\n@blp.arguments(StoreSchema)\n@blp.response(201, StoreSchema)\ndef post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n```\n\nNote here we're catching two different errors, `IntegrityError` for when a client attempts to create a store with a name that already exists, and `SQLAlchemyError` for anything else.\n\nSince the `StoreModel`'s `name` column is marked as `unique=True`, then an `IntegrityError` is raised when we try to insert another row with the same name.\n\n[^1]: [Session Basics (SQLAlchemy Documentation)](https://docs.sqlalchemy.org/en/14/orm/session_basics.html)"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n raise NotImplementedError(\"Creating an item is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n raise NotImplementedError(\"Creating a store is not implemented.\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/05_insert_models_sqlalchemy/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/README.md",
"content": "---\ntitle: Get models by ID from the database using SQLAlchemy\ndescription: Learn how to fetch a specific model using its primary key column, and how to return a 404 page if it isn't found.\nctslug: get-models-by-id-from-the-database\n---\n\n# Get models by ID from the database using SQLAlchemy\n\nUsing the model class's `query` attribute, we have access to two very handy methods:\n\n- `ItemModel.query.get(item_id)` gives us an `ItemModel` object from the database where the `item_id` matches the primary key.\n- `ItemModel.query.get_or_404(item_id)` does the same, but makes Flask immediately return a \"Not Found\" message, together with a 404 error code, if no model can be found with that ID in the database.\n\n:::tip\nWhen we use `.get_or_404()` and nothing is found, this is the response from the API:\n\n```json\n{\"code\": 404, \"status\": \"Not Found\"}\n```\n\nThe status code of this response is also 404.\n:::\n\nWe're going to use `.get_or_404()` repeatedly in our resources!\n\nFor now, and since we'll need an `ItemModel` instance in all our `Item` resource methods, let's add that:\n\n```python title=\"resources/item.py\"\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n # highlight-start\n item = ItemModel.query.get_or_404(item_id)\n return item\n # highlight-end\n\n def delete(self, item_id):\n # highlight-start\n item = ItemModel.query.get_or_404(item_id)\n # highlight-end\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n # highlight-start\n item = ItemModel.query.get_or_404(item_id)\n # highlight-end\n raise NotImplementedError(\"Updating an item is not implemented.\")\n```\n\nSimilarly in our `Store` resource:\n\n```python title=\"resources/store.py\"\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n # highlight-start\n store = StoreModel.query.get_or_404(store_id)\n return store\n # highlight-end\n\n def delete(self, store_id):\n # highlight-start\n store = StoreModel.query.get_or_404(store_id)\n # highlight-end\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n```\n\nWith this, we're ready to continue!"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n raise NotImplementedError(\"Getting an item is not implemented.\")\n\n def delete(self, item_id):\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n raise NotImplementedError(\"Getting a store is not implemented.\")\n\n def delete(self, store_id):\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/06_get_models_or_404/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/README.md",
"content": "---\ntitle: Updating models with SQLAlchemy\ndescription: How to make changes to an existing model, or insert one if it doesn't already exist.\nctslug: updating-models-with-sqlalchemy\n---\n\n# Updating models with SQLAlchemy\n\nA frequent operation in REST APIs is the \"upsert\", or \"update or insert\".\n\nThis is an idempotent operation where we send the data we want the API to store. If the data identifier already exists, an update is done. If it doesn't, it is created.\n\nThis idempotency is frequently seen with `PUT` requests. You can see it in action here:\n\n```python title=\"resources/item.py\"\n@blp.arguments(ItemUpdateSchema)\n@blp.response(200, ItemSchema)\ndef put(self, item_data, item_id):\n # highlight-start\n item = ItemModel.query.get(item_id)\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n # highlight-end\n```\n\nOur `ItemUpdateSchema` at the moment looks like this:\n\n```python title=\"schemas.py\"\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n```\n\nBut since now our update endpoint may create items, we need to change the schema to optionally accept a `store_id`.\n\nWhen updating an item, `name` or `price` (or both) may be passed, but when creating an item, `name`, `price`, and `store_id` must be passed.\n\nUpdate the `ItemUpdateSchema` to this:\n\n```python title=\"schemas.py\"\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n store_id = fields.Int()\n```\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n raise NotImplementedError(\"Updating an item is not implemented.\")\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/07_updating_models_sqlalchemy/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/README.md",
"content": "---\ntitle: Retrieve a list of all models\ndescription: Get more than one model and return it as a list from the API.\nctslug: retrieve-a-list-of-all-models\n---\n\n# Retrieve a list of all models\n\nUsing the `query` attribute of our model class, we can retrieve all the results of the query:\n\n```python title=\"resources/item.py\"\n@blp.response(200, ItemSchema(many=True))\ndef get(self):\n # highlight-start\n return ItemModel.query.all()\n # highlight-end\n```\n\n```python title=\"resources/store.py\"\n@blp.response(200, StoreSchema(many=True))\ndef get(self):\n # highlight-start\n return StoreModel.query.all()\n # highlight-end\n```"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing items is not implemented.\")\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema, ItemSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n raise NotImplementedError(\"Listing stores is not implemented.\")\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/08_retrieve_list_all_models/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/README.md",
"content": "---\ntitle: Delete models with SQLAlchemy\ndescription: Use SQLAlchemy to handle removal of a specific model.\nctslug: delete-models-with-sqlalchemy\n---\n\n# Delete models with SQLAlchemy\n\nJust as with adding, deleting models is a matter of using `db.session`, and then committing when the deletion is complete:\n\n```python title=\"resources/item.py\"\ndef delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n # highlight-start\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n # highlight-end\n```\n\n```python title=\"resources/store.py\"\ndef delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n # highlight-start\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n # highlight-end\n```"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n raise NotImplementedError(\"Deleting an item is not implemented.\")\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n raise NotImplementedError(\"Deleting a store is not implemented.\")\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/09_delete_models_sqlalchemy/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/README.md",
"content": "---\ntitle: Delete models with relationships using cascades\ndescription: Tell SQLAlchemy what to do with related models when you delete the parent.\nctslug: delete-models-with-relationships-using-cascades\n---\n\n# Delete models with relationships using cascades\n\nWhen you delete a model that has a relationship to other models that still exist, the default behavior in SQLAlchemy with PostgreSQL is to raise an error. This is because SQLAlchemy does not want to allow you to accidentally delete data that is still being used by other models.\n\nLet's say you have a `Store 1` that has two items, `Item 1` and `Item 2`. If you try to delete Store 1 without first deleting Item 1 and Item 2, SQLAlchemy will raise an error because the items are still related to the store.\n\nThis means the items have a **Foreign Key** that references the store you're trying to delete. If the store actually was deleted, the items have a store ID that references something that doesn't exist.\n\nTo fix this, you can use a feature called \"cascading deletes\". Cascading deletes allow you to specify that when a model is deleted, any related models should also be deleted automatically.\n\nSQLAlchemy makes it easy to add cascades to our models, here's how you might do that!\n\n```python title=\"models/store.py\"\nfrom db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n # highlight-start\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\", cascade=\"all, delete\")\n # highlight-end\n```\n\nRemember that `StoreModel` and `ItemModel` have a one-to-many relationship, where each store can have multiple items, and each item belongs to a single store.\n\nThe `cascade=\"all,delete\"` argument in the `relationship()` call for the `StoreModel.items` attribute specifies that when a store is deleted, all of its related items should also be deleted.\n\nIf you add a `cascade` on the relationship in the `ItemModel`, then when an item is deleted, its related store should also be deleted. This is not what we want, so we won't add a cascade to `ItemModel`.\n\nWith this code in place, if you try to delete a store that still has items, the items will be deleted automatically along with the store. This will allow you to delete the store without having to delete the items individually.\n\nFor more information, I strongly recommend reading [the official documentation](https://docs.sqlalchemy.org/en/20/orm/cascades.html#delete)! There are also other cascade options you can pass in depending on what you want to happen to related models when the parent changes or is deleted."
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\n \"ItemModel\", back_populates=\"store\", lazy=\"dynamic\", cascade=\"all, delete\"\n )\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nimport models\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.store import StoreModel\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/requirements.txt",
"content": "flask\nflask-sqlalchemy\nflask-smorest\npython-dotenv\nmarshmallow"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/10_delete_related_models_sqlalchemy/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/11_conclusion/README.md",
"content": "---\ntitle: Conclusion of this section\ndescription: Review everything we've changed this section to add SQL storage with SQLAlchemy to our API.\nctslug: conclusion-of-this-section\n---\n\n# Conclusion of this section\n\nAdding SQL storage to our app has required quite a few changes! Let's do a quick review.\n\n## Installed SQLAlchemy and Flask-SQLAlchemy\n\n```\npip install sqlalchemy flask-sqlalchemy\n```\n\nAnd\n\n```text title=\"requirements.txt\"\nsqlalchemy\nflask-sqlalchemy\n```\n\n## Created models\n\n```python title=\"models/item.py\"\nfrom db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n```\n\nAnd\n\n```python title=\"models/store.py\"\nfrom db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n```\n\n## Updated resources to use SQLAlchemy\n\nPreviously we were using Python dictionaries as a database. Now we've swapped them out for using SQLAlchemy models by:\n\n- Importing the models in our resource files\n- Retrieving models from the database with `ModelClass.query.get_or_404(model_id)`.\n- Updating models by changing attributes, or creating new model class instances, and then saving and committing with `db.session.add(model_instance)` and `db.session.commit()`.\n- Deleting models with `db.session.delete(model_instance)` followed by `db.session.commit()`.\n\n## Updated marshmallow schemas\n\nSince now our models have relationships, that means that the schemas can have `Nested` fields.\n\nThe schemas that don't have `Nested` fields we've called \"Plain\" schemas, and those that do are named after the model they represent.\n\n```python title=\"schemas.py\"\nfrom marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n store_id = fields.Int()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n```\n\nAnd that's it! Quite a few changes, but hopefully you're still with me.\n\nIn the following sections we'll be adding more functionality to our API, so stay tuned!"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/Insomnia_section6.json",
"content": "{\"_type\":\"export\",\"__export_format\":4,\"__export_date\":\"2022-11-09T15:30:25.805Z\",\"__export_source\":\"insomnia.desktop.app:v2022.6.0\",\"resources\":[{\"_id\":\"req_8612530e54144a039af84006ee8c882d\",\"parentId\":\"fld_7ed8d16fd87545519f2f64b2613ea84a\",\"modified\":1666987689179,\"created\":1666987689179,\"url\":\"{{url}}/store\",\"name\":\"/store Get all store data\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423181,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_7ed8d16fd87545519f2f64b2613ea84a\",\"parentId\":\"wrk_a6cd641e98494bca9a11fe77b66c7e37\",\"modified\":1666987689178,\"created\":1666987689178,\"name\":\"Stores\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528974,\"_type\":\"request_group\"},{\"_id\":\"wrk_a6cd641e98494bca9a11fe77b66c7e37\",\"parentId\":null,\"modified\":1666987689171,\"created\":1666987689171,\"name\":\"Section 6\",\"description\":\"\",\"scope\":\"collection\",\"_type\":\"workspace\"},{\"_id\":\"req_335002433e9745068d074f1f942ddde2\",\"parentId\":\"fld_7ed8d16fd87545519f2f64b2613ea84a\",\"modified\":1666987689183,\"created\":1666987689183,\"url\":\"{{url}}/store/STORE_ID\",\"name\":\"/store/\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423156,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_4f7b9d616b0e44ca94ca51cc71660da0\",\"parentId\":\"fld_7ed8d16fd87545519f2f64b2613ea84a\",\"modified\":1666990320166,\"created\":1666987689181,\"url\":\"{{url}}/store\",\"name\":\"/store Create new store\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"My store2\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666124423143.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_9228903cf7a54601a51a59f6a6692363\",\"parentId\":\"fld_7ed8d16fd87545519f2f64b2613ea84a\",\"modified\":1666987689184,\"created\":1666987689184,\"url\":\"{{url}}/store/STORE_ID\",\"name\":\"/store/ Delete store\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423131,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_d1d499ead63e469ca04571899cc4759f\",\"parentId\":\"fld_8761c7b0aa5142cba8985868cbda3de2\",\"modified\":1666987689190,\"created\":1666987689190,\"url\":\"{{url}}/item\",\"name\":\"/item Get all items\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104308,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_8761c7b0aa5142cba8985868cbda3de2\",\"parentId\":\"wrk_a6cd641e98494bca9a11fe77b66c7e37\",\"modified\":1666987689186,\"created\":1666987689186,\"name\":\"Items\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528924,\"_type\":\"request_group\"},{\"_id\":\"req_94738c7e8c774bd597ffe97bf7b921b6\",\"parentId\":\"fld_8761c7b0aa5142cba8985868cbda3de2\",\"modified\":1666987689194,\"created\":1666987689194,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Get item\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104258,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_0624b67ef6b841f482b7e7522fb6f405\",\"parentId\":\"fld_8761c7b0aa5142cba8985868cbda3de2\",\"modified\":1666990328367,\"created\":1666987689187,\"url\":\"{{url}}/item\",\"name\":\"/item Create item\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Chair\\\",\\n\\t\\\"price\\\": 17.99,\\n\\t\\\"store_id\\\": 1\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104220.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_b2651043ea5e4b33b073f260712fb114\",\"parentId\":\"fld_8761c7b0aa5142cba8985868cbda3de2\",\"modified\":1666987689189,\"created\":1666987689189,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Delete item\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104214.25,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_640f313dbd5a4bfcbf98081e2fab6d4a\",\"parentId\":\"fld_8761c7b0aa5142cba8985868cbda3de2\",\"modified\":1666987689192,\"created\":1666987689192,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Update item\",\"description\":\"\",\"method\":\"PUT\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Another Chair\\\",\\n\\t\\\"price\\\": 20.00\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104208,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"env_892efa21f8454221972d0c77a336872c\",\"parentId\":\"wrk_a6cd641e98494bca9a11fe77b66c7e37\",\"modified\":1666987689172,\"created\":1666987689172,\"name\":\"Base Environment\",\"data\":{\"url\":\"http://127.0.0.1:5005\"},\"dataPropertyOrder\":{\"&\":[\"url\"]},\"color\":null,\"isPrivate\":false,\"metaSortKey\":1666122928025,\"_type\":\"environment\"},{\"_id\":\"jar_aff586a35c4c49aa91c5defb067355bf\",\"parentId\":\"wrk_a6cd641e98494bca9a11fe77b66c7e37\",\"modified\":1666987689174,\"created\":1666987689174,\"name\":\"Default Jar\",\"cookies\":[],\"_type\":\"cookie_jar\"},{\"_id\":\"spc_4e7424f78749436bacdb44d3a1eba77a\",\"parentId\":\"wrk_a6cd641e98494bca9a11fe77b66c7e37\",\"modified\":1666987689205,\"created\":1666987689176,\"fileName\":\"Section 6\",\"contents\":\"\",\"contentType\":\"yaml\",\"_type\":\"api_spec\"}]}"
},
{
"path": "docs/docs/06_sql_storage_sqlalchemy/_category_.json",
"content": "{\n \"label\": \"SQL Storage with Flask-SQLAlchemy\",\n \"position\": 6\n}\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/01_section_changes/README.md",
"content": "---\ntitle: Changes in this section\ndescription: In this section we add Tags to our Stores, and link these to Items using a many-to-many relationship.\nctslug: changes-in-many-to-many-section\n---\n\n# Changes in this section\n\n:::tip Insomnia files\nRemember to get the Insomnia files for this section or for all sections [here](/insomnia-files/)!\n:::\n\nIt's common for online stores to use \"tags\" to group items and to be able to search for them a bit more easily.\n\nFor example, an item \"Chair\" could be tagged with \"Furniture\" and \"Office\".\n\nAnother item, \"Laptop\", could be tagged with \"Tech\" and \"Office\".\n\nSo one item can be associated with many tags, and one tag can be associated with many items.\n\nThis is a many-to-many relationship, which is bit trickier to implement than the one-to-many we've already implemented between Items and Stores.\n\n## When you have many stores\n\nWe want to add one more constraint to tags, however. That is that if we have many stores, it's possible each store wants to use different tags. So the tags we create will be unique to each store.\n\nThis means that tags will have:\n\n- A many-to-one relationship with stores\n- A many-to-many relationship with items\n\nHere's a diagram to illustrate what this looks like:\n\n\n\n## New API endpoints to be added\n\nIn this section we will add all the Tag endpoints:\n\n\n| Method | Endpoint | Description |\n| -------- | --------------------- | ------------------------------------------------------- |\n| `GET` | `/store/{id}/tag` | Get a list of tags in a store. |\n| `POST` | `/store/{id}/tag` | Create a new tag. |\n| `POST` | `/item/{id}/tag/{id}` | Link an item in a store with a tag from the same store. |\n| `DELETE` | `/item/{id}/tag/{id}` | Unlink a tag from an item. |\n| `GET` | `/tag/{id}` | Get information about a tag given its unique id. |\n| `DELETE` | `/tag/{id}` | Delete a tag, which must have no associated items. |"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/README.md",
"content": "---\ntitle: One-to-many relationships review\ndescription: A super-quick look at creating the Tag model and setting up the one-to-many relationship with Stores.\nctslug: one-to-many-relationship-between-tag-store\n---\n\n# One-to-many relationship between Tag and Store\n\nSince we've already learned how to set up one-to-many relationships with SQLAlchemy when we looked at Items and Stores, let's go quickly in this section.\n\n## The SQLAlchemy models\n\nimport Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n\n\n\n\n\n```python title=\"models/tag.py\"\nfrom db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n```\n\n\n\n\n```python title=\"models/store.py\"\nfrom db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n # highlight-start\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n # highlight-end\n```\n\n\n\n
\n\nRemember to import the `TagModel` in `models/__init__.py` so that it is then imported by `app.py`. Otherwise SQLAlchemy won't know about it, and it won't be able to create the tables.\n\n## The marshmallow schemas\n\nThese are the new schemas we'll add. Note that none of the tag schemas have any notion of \"items\". We'll add those to the schemas when we construct the many-to-many relationship.\n\nIn the `StoreSchema` we add a new list field for the nested `PlainTagSchema`, just as it has with `PlainItemSchema`.\n\n```python title=\"schemas.py\"\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n # highlight-start\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n # highlight-end\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n```\n\n## The API endpoints\n\nLet's add the Tag endpoints that aren't related to Items:\n\n| Method | Endpoint | Description |\n| ---------- | --------------------- | ------------------------------------------------------- |\n| ✅ `GET` | `/store/{id}/tag` | Get a list of tags in a store. |\n| ✅ `POST` | `/store/{id}/tag` | Create a new tag. |\n| ❌ `POST` | `/item/{id}/tag/{id}` | Link an item in a store with a tag from the same store. |\n| ❌ `DELETE` | `/item/{id}/tag/{id}` | Unlink a tag from an item. |\n| ✅ `GET` | `/tag/{id}` | Get information about a tag given its unique id. |\n| ❌ `DELETE` | `/tag/{id}` | Delete a tag, which must have no associated items. |\n\nHere's the code we need to write to add these endpoints:\n\n```python title=\"resources/tag.py\"\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel\nfrom schemas import TagSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all()\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n```\n\n## Register the Tag blueprint in `app.py`\n\nFinally, we need to remember to import the blueprint and register it!\n\n```python title=\"app.py\"\nfrom flask import Flask\nfrom flask_smorest import Api\n\nimport models\n\nfrom db import db\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n# highlight-start\nfrom resources.tag import blp as TagBlueprint\n# highlight-end\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n # highlight-start\n api.register_blueprint(TagBlueprint)\n # highlight-end\n\n return app\n```\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nimport models\n\nfrom db import db\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel\nfrom schemas import TagSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nimport models\n\nfrom db import db\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/02_one_to_many_review/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/README.md",
"content": "---\ntitle: Many-to-many relationships\ndescription: Learn to set up a many-to-many relationship between two models using SQLAlchemy.\nctslug: many-to-many-relationships\n---\n\n# Many-to-many relationships\n\n## The SQLAlchemy models\n\nIn one-to-many relationships, one of the models has a foreign key that links it to another model. \n\nHowever, for a many-to-many relationship, one model can't have a single value as a foreign key (otherwise it would be a one-to-many!). Instead, what we do is construct a **secondary table** that has, in each row, a tag ID and and item ID.\n\n| id | tag_id | item_id |\n| --- | ------ | ------- |\n| 1 | 2 | 5 |\n| 2 | 1 | 4 |\n| 3 | 4 | 5 |\n| 4 | 1 | 3 |\n\n\n Explanation of the table above
\n \n
The table above has 4 rows, which tell us the following:
\n
\n - Tag with ID
1 is linked to Items with IDs 3 and 4. \n - Tag with ID
2 is linked to Item with ID 5. \n - Tag with ID
4 is linked to Item with ID 5. \n
\n
And therefore:
\n
\n - Item with ID
3 is linked to Tag with ID 1. \n - Item with ID
4 is linked to Tag with ID 1. \n - Item with ID
5 is linked to Tags with IDs 2 and 4. \n
\n
This is how many-to-many relationships work, and through this secondary table, the Tag.items and Item.tags attributes will be populated by SQLAlchemy.
\n
\n\nThe rows in this table then signify a link between a specific tag and a specific item, but without the need for those values to be stored in the tag or item models themselves.\n\n### Writing the secondary table for many-to-many relationships\n\nAs we've just seen, many-to-many relationships use a secondary table which stores which models of one side are related to which models of the other side.\n\nJust as we did with `Item`, `Store`, and `Tag`, we'll create a model for this secondary table:\n\n```python title=\"models/item_tags.py\"\nfrom db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n```\n\nLet's also add this to our `models/__init__.py` file:\n\n```python title=\"models/__init__.py\"\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n```\n\n### Using the secondary table in the main models\n\n\nimport Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';\n\n\n\n\n\n```python title=\"models/tag.py\"\nfrom db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n # highlight-start\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n # highlight-end\n```\n\n\n\n\n```python title=\"models/item.py\"\nfrom db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n # highlight-start\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n # highlight-end\n```\n\n\n\n
\n\n## The marshmallow schemas\n\nNext up, let's add the nested fields to the marshmallow schemas.\n\nThe `TagAndItemSchema` will be used to return information about both the Item and Tag that have been modified in an endpoint, together with an informative message.\n\n```python title=\"schemas.py\"\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n # highlight-start\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n # highlight-end\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n # highlight-start\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n # highlight-end\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n# highlight-start\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n# highlight-end\n```\n\n## The API endpoints\n\nNow let's add the rest of our API endpoints (grayed out are the ones we implemented in [one-to-many relationships review](../one_to_many_review/))!\n\n| Method | Endpoint | Description |\n| ---------------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| ✅ `GET` | `/store/{id}/tag` | Get a list of tags in a store. |\n| ✅ `POST` | `/store/{id}/tag` | Create a new tag. |\n| ✅ `POST` | `/item/{id}/tag/{id}` | Link an item in a store with a tag from the same store. |\n| ✅ `DELETE` | `/item/{id}/tag/{id}` | Unlink a tag from an item. |\n| ✅ `GET` | `/tag/{id}` | Get information about a tag given its unique id. |\n| ✅ `DELETE` | `/tag/{id}` | Delete a tag, which must have no associated items. |\n\nHere's the code (new lines highlighted):\n\n```python title=\"resources/tag.py\"\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\n# highlight-start\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n# highlight-end\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n# highlight-start\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n# highlight-end\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n # highlight-start\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\",\n )\n # highlight-end\n```\n\nAnd with that, we're done!\n\n## Making sure Store ID matches when linking tags\n\nIf you wanted to, you can make sure that you can only link a tag that belongs to a certain store, with an item of that same store.\n\nSomething like this would work:\n\n```py\nif item.store.id != tag.store.id:\n abort(400, message=\"Make sure item and tag belong to the same store before linking.\")\n```\n\nNow we're ready to look at securing API endpoints with user authentication."
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nimport models\n\nfrom db import db\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nimport models\n\nfrom db import db\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel\nfrom schemas import TagSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/03_many_to_many_relationships/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/Insomnia_section7.json",
"content": "{\"_type\":\"export\",\"__export_format\":4,\"__export_date\":\"2022-11-09T15:30:50.558Z\",\"__export_source\":\"insomnia.desktop.app:v2022.6.0\",\"resources\":[{\"_id\":\"req_379d0e42420f466bbad1b7481e5e7816\",\"parentId\":\"fld_86b5e8072a894c409febe46716e99809\",\"modified\":1666991794866,\"created\":1666990973919,\"url\":\"{{url}}/store/STORE_ID/tag\",\"name\":\"/stores//tags Get tags in store\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666990973919,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_86b5e8072a894c409febe46716e99809\",\"parentId\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"modified\":1666990939045,\"created\":1666990939045,\"name\":\"Tags\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666990939045,\"_type\":\"request_group\"},{\"_id\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"parentId\":null,\"modified\":1666990745588,\"created\":1666990745588,\"name\":\"Section 7\",\"description\":\"\",\"scope\":\"collection\",\"_type\":\"workspace\"},{\"_id\":\"req_85adfd198935497bb7aedb266beb5bf3\",\"parentId\":\"fld_86b5e8072a894c409febe46716e99809\",\"modified\":1666991788350,\"created\":1666990945502,\"url\":\"{{url}}/tag/TAG_ID\",\"name\":\"/tags/ Get tag\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666990945502,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_4765f7ca8e1e46308cdde255d09a2ffc\",\"parentId\":\"fld_86b5e8072a894c409febe46716e99809\",\"modified\":1666991810641,\"created\":1666991378432,\"url\":\"{{url}}/item/ITEM_ID/tag/TAG_ID\",\"name\":\"/item//tag/ Link an item in a store with a tag from the same store\",\"description\":\"\",\"method\":\"POST\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666990945477,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_f07aab6ead044ca7bba0de3437ab08c4\",\"parentId\":\"fld_86b5e8072a894c409febe46716e99809\",\"modified\":1666991779049,\"created\":1666991031108,\"url\":\"{{url}}/store/STORE_ID/tag\",\"name\":\"/stores//tags Create tag in store\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Tag name\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666990945452,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_77d1a5f225c54acbb27bac15010722ad\",\"parentId\":\"fld_86b5e8072a894c409febe46716e99809\",\"modified\":1666991824192,\"created\":1666991489163,\"url\":\"{{url}}/item/ITEM_ID/tag/TAG_ID\",\"name\":\"/item//tag/ Unlink a tag from an item\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666990945427,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_d60510ab22b2499abb20a63629e30fcd\",\"parentId\":\"fld_86b5e8072a894c409febe46716e99809\",\"modified\":1666991828682,\"created\":1666991524256,\"url\":\"{{url}}/tag/TAG_ID\",\"name\":\"/tag/ Delete a tag, which must have no associated items.\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666990945402,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_ab3c728a796e4b4ca51803248e1b0650\",\"parentId\":\"fld_597937a09435404ebe2200cbaeed101d\",\"modified\":1666990745596,\"created\":1666990745596,\"url\":\"{{url}}/store\",\"name\":\"/store Get all store data\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423181,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_597937a09435404ebe2200cbaeed101d\",\"parentId\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"modified\":1666990745596,\"created\":1666990745596,\"name\":\"Stores\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528974,\"_type\":\"request_group\"},{\"_id\":\"req_a9d43bb23e1246da94aec50b9b9ca652\",\"parentId\":\"fld_597937a09435404ebe2200cbaeed101d\",\"modified\":1666990745601,\"created\":1666990745601,\"url\":\"{{url}}/store/STORE_ID\",\"name\":\"/store/\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423156,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_8a36225a08bb4dfbbf98fd983b0d4a5f\",\"parentId\":\"fld_597937a09435404ebe2200cbaeed101d\",\"modified\":1666991654175,\"created\":1666990745599,\"url\":\"{{url}}/store\",\"name\":\"/store Create new store\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"My store2\\\"\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666124423143.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_303507538c0f408eb6d91784b7ed8d36\",\"parentId\":\"fld_597937a09435404ebe2200cbaeed101d\",\"modified\":1666990745602,\"created\":1666990745602,\"url\":\"{{url}}/store/STORE_ID\",\"name\":\"/store/ Delete store\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666124423131,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_f4776751aecc4c6eafb264dc2d2c24cb\",\"parentId\":\"fld_baa111a1ff5849b4838637f09844bfde\",\"modified\":1666990745609,\"created\":1666990745609,\"url\":\"{{url}}/item\",\"name\":\"/item Get all items\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104308,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"fld_baa111a1ff5849b4838637f09844bfde\",\"parentId\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"modified\":1666990745604,\"created\":1666990745604,\"name\":\"Items\",\"description\":\"\",\"environment\":{},\"environmentPropertyOrder\":null,\"metaSortKey\":-1666124528924,\"_type\":\"request_group\"},{\"_id\":\"req_e6bc2422c8cf4f119c7dc10251a9af65\",\"parentId\":\"fld_baa111a1ff5849b4838637f09844bfde\",\"modified\":1666990745611,\"created\":1666990745611,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Get item\",\"description\":\"\",\"method\":\"GET\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104258,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_6c72c92f81924ce7bc26ceb488fd64ff\",\"parentId\":\"fld_baa111a1ff5849b4838637f09844bfde\",\"modified\":1666991658886,\"created\":1666990745605,\"url\":\"{{url}}/item\",\"name\":\"/item Create item\",\"description\":\"\",\"method\":\"POST\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Chair\\\",\\n\\t\\\"price\\\": 17.99,\\n\\t\\\"store_id\\\": 1\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104220.5,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_e86e0877045640d690454a99b176f3a2\",\"parentId\":\"fld_baa111a1ff5849b4838637f09844bfde\",\"modified\":1666990745607,\"created\":1666990745607,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Delete item\",\"description\":\"\",\"method\":\"DELETE\",\"body\":{},\"parameters\":[],\"headers\":[],\"authentication\":{},\"metaSortKey\":-1666125104214.25,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"req_f0c4a3d747a543249131e19ceea79e56\",\"parentId\":\"fld_baa111a1ff5849b4838637f09844bfde\",\"modified\":1666990745610,\"created\":1666990745610,\"url\":\"{{url}}/item/ITEM_ID\",\"name\":\"/item/ Update item\",\"description\":\"\",\"method\":\"PUT\",\"body\":{\"mimeType\":\"application/json\",\"text\":\"{\\n\\t\\\"name\\\": \\\"Another Chair\\\",\\n\\t\\\"price\\\": 20.00\\n}\"},\"parameters\":[],\"headers\":[{\"name\":\"Content-Type\",\"value\":\"application/json\"}],\"authentication\":{},\"metaSortKey\":-1666125104208,\"isPrivate\":false,\"settingStoreCookies\":true,\"settingSendCookies\":true,\"settingDisableRenderRequestBody\":false,\"settingEncodeUrl\":true,\"settingRebuildPath\":true,\"settingFollowRedirects\":\"global\",\"_type\":\"request\"},{\"_id\":\"env_7609e8f1315a4d77af52a6ba50f48205\",\"parentId\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"modified\":1666990745590,\"created\":1666990745590,\"name\":\"Base Environment\",\"data\":{\"url\":\"http://127.0.0.1:5005\"},\"dataPropertyOrder\":{\"&\":[\"url\"]},\"color\":null,\"isPrivate\":false,\"metaSortKey\":1666122928025,\"_type\":\"environment\"},{\"_id\":\"jar_ce9759718e054191a685cec521ed7afc\",\"parentId\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"modified\":1666990745592,\"created\":1666990745592,\"name\":\"Default Jar\",\"cookies\":[],\"_type\":\"cookie_jar\"},{\"_id\":\"spc_0f62897a05a449f9845b4c71eeb892b3\",\"parentId\":\"wrk_6efa5c8b8fa142a28f436b209fba66fa\",\"modified\":1666990745620,\"created\":1666990745594,\"fileName\":\"Section 7\",\"contents\":\"\",\"contentType\":\"yaml\",\"_type\":\"api_spec\"}]}"
},
{
"path": "docs/docs/07_sqlalchemy_many_to_many/_category_.json",
"content": "{\n \"label\": \"Many-to-many relationships with SQLAlchemy\",\n \"position\": 7\n}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/01_section_changes/README.md",
"content": "---\ntitle: Changes in this section\ndescription: Overview of the API endpoints we'll use for user registration and authentication.\nctslug: changes-in-jwt-extended-section\n---\n\n# Changes in this section\n\n:::tip Insomnia files\nRemember to get the Insomnia files for this section or for all sections [here](/insomnia-files/)!\n:::\n\nIn this section we will add the following endpoints:\n\n| Method | Endpoint | Description |\n| -------------- | ----------------- | ----------------------------------------------------- |\n| `POST` | `/register` | Create user accounts given an `email` and `password`. |\n| `POST` | `/login` | Get a JWT given an `email` and `password`. |\n| 🔒
`POST` | `/logout` | Revoke a JWT. |\n| 🔒
`POST` | `/refresh` | Get a fresh JWT given a refresh JWT. |\n| `GET` | `/user/{user_id}` | (dev-only) Get info about a user given their ID. |\n| `DELETE` | `/user/{user_id}` | (dev-only) Delete a user given their ID. |\n\nWe will also protect some existing endpoints by requiring a JWT from clients. You can see which endpoints will be protected in [The API we'll build in this course](/docs/course_intro/what_is_rest_api/#the-api-well-build-in-this-course)"
},
{
"path": "docs/docs/08_flask_jwt_extended/02_what_is_a_jwt/README.md",
"content": "---\ntitle: What is a JWT?\ndescription: Understand what a JWT is, what data it contains, and how it may be used.\nctslug: what-is-a-jwt\n---\n\n# What is a JWT?\n\nA JWT is a signed JSON object with a specific structure. Our Flask app will sign the JWTs with the secret key, proving that _it generated them_.\n\nThe Flask app generates a JWT when a user logs in (with their username and password). In the JWT, we'll store the user ID. The client then stores the JWT and sends it to us on every request.\n\nBecause we can prove our app generated the JWT (through its signature), and we will receive the JWT with the user ID in every request, we can _treat requests that include a JWT as \"logged in\"_.\n\nFor example, if we want certain endpoints to only be accessible to logged-in users, all we do is require a JWT in them. Since the client can only get a JWT after logging in, we know that including a JWT is proof that the client logged in successfully at some point in the past.\n\nAnd since the JWT includes the user ID inside it, when we receive a JWT we know _who logged in_ to get the JWT.\n\nThere's a lot more information about JWTs here: [https://jwt.io/introduction](https://jwt.io/introduction). This includes information such as:\n\n- What is stored inside a JWT?\n- Are JWTs secure?\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/03_how_is_jwt_used/README.md",
"content": "---\ntitle: How are JWTs used?\ndescription: Learn who uses JWTs and how they are used by clients and servers to perform authentication.\nctslug: how-are-jwts-used\n---\n\n# How are JWTs used?\n\n:::info JWT vs. Access token?\nAn \"access token\" is any piece of information that a client can use to authenticate. In this API, we use JWTs. Therefore you can say that the JWT and the access token are one and the same!\n:::\n\nWe've learned that a JWT is generated by the API and sent to the client. When the client wants to login they will send the API information that allows them to do so: usually, the user's username and password. The API then validates that this login information is correct, and generates the access token.\n\nInside the access token, the API stores identifying information for the user. Then the access token is sent to the client who stores it in whichever way they see fit. In every subsequent request to the API, the client should include the access token. That way, just with that information, the API can tell _who_ made the request. The API can decode the access token and see inside it the identifying information for the user for whom the access token was generated.\n\nHere is a diagram of the interaction between client and API to generate an access token:\n\n\n\n\n\n
\n\n## An example of using access tokens\n\nFor example, let's say you want to make an API that has an endpoint `/my-info`. This endpoint should send the client information about the currently logged-in user.\n\nLet's imagine that **the client** is a website. In the website, there is a button, \"See my info\", which when clicked sends a request to the API's `/my-info` endpoint to get the logged-in user's information.\n\n### Clicking the button without logging in\n\nIf the user navigates to the website and clicks the \"See my info\" button, the website will send a request to the API. Because the user hasn't logged in yet, the website doesn't have an access token generated for this user.\n\nTherefore, the API responds with an \"authentication error\".\n\nThe website receives the authentication error and that tells it that the user hasn't logged in. So the website can show the user a log-in form, for the user to enter their username and password.\n\nWhen the user enters their username and password, the website will send a request to the API's `/login` endpoint. The API then responds with the access token. The website stores the access token for use later.\n\nIf the user clicks the \"See my info\" button again, now the website will include the access token in the request.\n\nThe server will then:\n\n1. See the access token.\n2. Decode it.\n3. Look at what user the access token was generated for.\n4. Load _that_ user's information from the database.\n5. Respond with that user's information.\n\nThe website receives the user's information, and can display it.\n\nThis is why the user sees their own information, and not someone else's. The access token was generated after they logged in with their details, and the access token stores their user ID. The server will use that to retrieve the correct data.\n\nHere is a rather long diagram depicting what happens:\n\n\n\n\n\n
\n\n:::warning This course deals only with the API\nRemember that in this course, we're making the API. We are not concerned with the client! We don't care how the client stores the access token or even whether the client is a website, mobile app, Postman or Insomnia, or anything else!\n:::\n\n## When do users provide their username and password?\n\nAccess tokens don't last forever: they normally have expiry times within 30 days of being generated. The shorter the expiry time of an access token, the more often that the user has to re-authenticate by providing their username and password, but the more secure the token is.\n\nTokens are more secure if they expire sooner because if the user forgets to log out of a shared device, and someone else tries to use their account, the token will expire and they will be unable to use the account.\n\nObviously, it's not a great experience for users if they have to keep re-entering their username and password constantly. Towards the end of this section we will learn about [token refreshing](../12_token_refreshing_flask_jwt_extended/README.md), which is a way to reduce the amount of times users have to re-authenticate, without affecting security too much.\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/README.md",
"content": "---\ntitle: Flask-JWT-Extended setup\ndescription: Install and set up the Flask-JWT-Extended extension with our REST API.\nctslug: flask-jwt-extended-setup\n---\n\n# Flask-JWT-Extended setup\n\nFirst, let's update our requirements:\n\n```diff title=\"requirements.txt\"\n+ flask-jwt-extended\n```\n\nThen we must do two things:\n\n- Add the extension to our `app.py`.\n- Set a secret key that the extension will use to _sign_ the JWTs.\n\n```python title=\"app.py\"\nfrom flask import Flask\nfrom flask_smorest import Api\n# highlight-start\nfrom flask_jwt_extended import JWTManager\n# highlight-end\n\nfrom db import db\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n # highlight-start\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n # highlight-end\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n```\n\n:::caution\nThe secret key set here, `\"jose\"`, is **not very safe**.\n\nInstead you should generate a long and random secret key using something like `str(secrets.SystemRandom().getrandbits(128))`.\n:::\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\n \"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\n\nfrom db import db\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\n \"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/04_flask_jwt_extended_setup/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/README.md",
"content": "---\ntitle: The User model and schema\ndescription: Create the SQLAlchemy User model and marshmallow schema.\nctslug: the-user-model-and-schema\n---\n\n# The User model and schema\n\nJust as we did with items, stores, and tags, let's create two classes for our users:\n\n- The SQLAlchemy model, to interact with the database.\n- The marshmallow schema, to deserialize data from clients and serialize it back to return data.\n\n## The User SQLAlchemy model\n\n```python title=\"models/user.py\"\nfrom db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n```\n\nLet's also add this class to `models/__init__.py` so it can then be imported by `app.py`:\n\n```python title=\"models/__init__.py\"\nfrom models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n```\n\n## The User marshmallow schema\n\n```python title=\"schemas.py\"\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n```"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\n \"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/models/__init__.py",
"content": "from models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/05_user_model_and_schema/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/README.md",
"content": "---\ntitle: How to add a register endpoint to the REST API\ndescription: Learn how to add a registration endpoint to a REST API using Flask-Smorest and Flask-JWT-Extended.\nctslug: how-to-add-a-register-endpoint-to-the-rest-api\n---\n\n# How to add a register endpoint to the REST API\n\nRegistering users sounds like a conceptually very difficult thing, but let's break it down into steps:\n\n- Receive username and password from the client (as JSON).\n- Check if a user with that username already exists.\n- If it doesn't...\n - Encrypt the password.\n - Add a new `UserModel` to the database.\n - Return a success message.\n\n## Boilerplate set-up for a blueprint with Flask-Smorest\n\nFirst, we need our imports and blueprint set-up. This is the same for pretty much every Flask-Smorest blueprint, so you already know how to do it!\n\n```python title=\"resources/user.py\"\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n```\n\n## Creating the `UserRegister` resource\n\nNow let's create the `MethodView` class, and register a route to it using the blueprint:\n\n```python title=\"resources/user.py\"\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n# highlight-start\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n# highlight-end\n```\n\n## Creating a testing-only `User` resource\n\nLet's also create a `User` resource that we will only use during testing. It allows us to retrieve information about a single user, or delete a user. This will be handy so that using Insomnia or Postman we can clear the registered users and we don't have to change our request arguments each time!\n\n```python title=\"resources/user.py\"\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n```\n\n## Register the user blueprint in `app.py`\n\nFinally, let's go to `app.py` and register the blueprint!\n\n```diff title=\"app.py\"\n+from resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n...\n\n+api.register_blueprint(UserBlueprint)\napi.register_blueprint(ItemBlueprint)\napi.register_blueprint(StoreBlueprint)\napi.register_blueprint(TagBlueprint)\n```"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/resources/user.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n\n\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/06_registering_users_rest_api/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/README.md",
"content": "---\ntitle: How to add a login endpoint to the REST API\ndescription: Learn how to add a login endpoint that returns a JWT to a REST API using Flask-Smorest and Flask-JWT-Extended.\nctslug: how-to-add-a-login-endpoint\n---\n\n# How to add a login endpoint to the REST API\n\nNow that we've done registration, we can do log in! It's very similar.\n\nLet's import `flask_jwt_extended.create_access_token` so that when we receive a valid username and password from the client, we can create a JWT and send it back:\n\n```diff title=\"resources/user.py\"\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n+from flask_jwt_extended import create_access_token\nfrom passlib.hash import pbkdf2_sha256\n```\n\nThen let's create our `UserLogin` resource.\n\n```python title=\"resources/user.py\"\n@blp.route(\"/login\")\nclass UserLogin(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n user = UserModel.query.filter(\n UserModel.username == user_data[\"username\"]\n ).first()\n\n if user and pbkdf2_sha256.verify(user_data[\"password\"], user.password):\n access_token = create_access_token(identity=str(user.id))\n return {\"access_token\": access_token}, 200\n\n abort(401, message=\"Invalid credentials.\")\n```\n\nHere you can see the when we call `create_access_token(identity=str(user.id))` we pass in the user's `id`. This is what gets stored (among other things) inside the JWT, so when the client sends the JWT back on every request, we can tell who the JWT belongs to.\n\n**Update Nov 2024**: Before now, we used `identity=user.id`, but now we have to convert it to a string first.\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\n@pytest.fixture()\ndef created_user_jwt(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n return response.json[\"access_token\"]\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_login_user(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n assert response.status_code == 200\n assert response.json[\"access_token\"]\n\n\ndef test_login_user_bad_password(client, created_user_details):\n username, _ = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": \"bad_password\"},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_login_user_bad_username(client, created_user_details):\n _, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": \"bad_username\", \"password\": password},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/resources/user.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import create_access_token\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n\n\n@blp.route(\"/login\")\nclass UserLogin(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n user = UserModel.query.filter(\n UserModel.username == user_data[\"username\"]\n ).first()\n\n if user and pbkdf2_sha256.verify(user_data[\"password\"], user.password):\n access_token = create_access_token(identity=str(user.id))\n return {\"access_token\": access_token}, 200\n\n abort(401, message=\"Invalid credentials.\")\n\n\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/resources/user.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n\n\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/07_login_users_rest_api/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/README.md",
"content": "---\ntitle: Protect endpoints by requiring a JWT\ndescription: Use jwt_required from Flask-JWT-Extended to prevent unauthorised users from making requests to certain endpoints in a REST API.\nctslug: protect-endpoints-by-requiring-a-jwt\n---\n\n# Protect endpoints by requiring a JWT\n\nNow that our users can sign up and log in, that means we can start _requiring login_ for certain endpoints.\n\nAll this means in practice is that the client making the request must send a valid JWT.\n\nRemember, we can tell if a JWT is valid because it is _signed by our app_. If the user changes the JWT at all, the signature will be invalid, and we'll know it has been tampered with. Flask-JWT-Extended takes care of all that for us.\n\n## Protecting routes in the `Item` resource\n\n```python title=\"resources/item.py\"\nfrom flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\n# highlight-start\nfrom flask_jwt_extended import jwt_required\n# highlight-end\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n # highlight-start\n @jwt_required()\n # highlight-end\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n # highlight-start\n @jwt_required()\n # highlight-end\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get_or_404(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(**item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n # highlight-start\n @jwt_required()\n # highlight-end\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n # highlight-start\n @jwt_required()\n # highlight-end\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n```\n\n## Error handling with Flask-JWT-Extended\n\nThere are many things that could go wrong with JWTs:\n\n- The JWT may be expired (they don't last forever!)\n- The JWT may be invalid, such as if the client makes changes to it\n- A JWT may be required, but none was provided\n- There's more (we'll look at them in coming lectures!)\n\nLet's go to `app.py` and add some configuration to tell Flask-JWT-Extended what to do in each of these cases.\n\nAt the top, let's import `jsonify`:\n\n```python title=\"app.py\"\nfrom flask import Flask, jsonify\n```\n\nThen, after we define the `jwt = JWTManager(app)` variable, we can write some functions, each of which can run in different problem scenarios.\n\n```python title=\"app.py\"\n...\n\napp.config[\"JWT_SECRET_KEY\"] = \"jose\"\njwt = JWTManager(app)\n\n@jwt.expired_token_loader\ndef expired_token_callback(jwt_header, jwt_payload):\n return (\n jsonify({\"message\": \"The token has expired.\", \"error\": \"token_expired\"}),\n 401,\n )\n\n@jwt.invalid_token_loader\ndef invalid_token_callback(error):\n return (\n jsonify(\n {\"message\": \"Signature verification failed.\", \"error\": \"invalid_token\"}\n ),\n 401,\n )\n\n@jwt.unauthorized_loader\ndef missing_token_callback(error):\n return (\n jsonify(\n {\n \"description\": \"Request does not contain an access token.\",\n \"error\": \"authorization_required\",\n }\n ),\n 401,\n )\n\n...\n```\n\n:::tip\nNote that some Flask-JWT-Extended error functions take two arguments: `jwt_header` and `jwt_payload`. Others take a single argument, `error`.\n\nThe ones that don't take JWT information are those that would be called when a JWT is not present (above, when the JWT is invalid or required but not received).\n:::"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/app.py",
"content": "from flask import Flask, jsonify\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n @jwt.expired_token_loader\n def expired_token_callback(jwt_header, jwt_payload):\n return (\n jsonify({\"message\": \"The token has expired.\", \"error\": \"token_expired\"}),\n 401,\n )\n\n @jwt.invalid_token_loader\n def invalid_token_callback(error):\n return (\n jsonify(\n {\"message\": \"Signature verification failed.\", \"error\": \"invalid_token\"}\n ),\n 401,\n )\n\n @jwt.unauthorized_loader\n def missing_token_callback(error):\n return (\n jsonify(\n {\n \"description\": \"Request does not contain an access token.\",\n \"error\": \"authorization_required\",\n }\n ),\n 401,\n )\n\n @jwt.revoked_token_loader\n def revoked_token_callback(jwt_header, jwt_payload):\n return (\n jsonify(\n {\"description\": \"The token has been revoked.\", \"error\": \"token_revoked\"}\n ),\n 401,\n )\n\n # JWT configuration ends\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/conftest.py",
"content": "import pytest\nfrom flask_jwt_extended import create_access_token\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n\n\n@pytest.fixture()\ndef jwt(app):\n with app.app_context():\n access_token = create_access_token(identity=1)\n return access_token\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, jwt, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, jwt, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client, jwt):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client, jwt):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, jwt, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, jwt, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client, jwt):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n \"/item\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client, jwt):\n response = client.get(\n \"/item\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, jwt, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, jwt, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client, jwt):\n response = client.get(\n \"/item/1\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, jwt, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id, jwt):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client, jwt):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\n@pytest.fixture()\ndef created_user_jwt(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n return response.json[\"access_token\"]\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_login_user(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n assert response.status_code == 200\n assert response.json[\"access_token\"]\n\n\ndef test_login_user_bad_password(client, created_user_details):\n username, _ = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": \"bad_password\"},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_login_user_bad_username(client, created_user_details):\n _, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": \"bad_username\", \"password\": password},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import jwt_required\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @jwt_required()\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n @jwt_required()\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @jwt_required()\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @jwt_required()\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/resources/user.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import create_access_token\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n\n\n@blp.route(\"/login\")\nclass UserLogin(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n user = UserModel.query.filter(\n UserModel.username == user_data[\"username\"]\n ).first()\n\n if user and pbkdf2_sha256.verify(user_data[\"password\"], user.password):\n access_token = create_access_token(identity=str(user.id))\n return {\"access_token\": access_token}, 200\n\n abort(401, message=\"Invalid credentials.\")\n\n\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/app.py",
"content": "from flask import Flask\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/conftest.py",
"content": "import pytest\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\n \"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client):\n response = client.get(\n \"/item\",\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client):\n response = client.get(\n \"/item/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\n@pytest.fixture()\ndef created_user_jwt(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n return response.json[\"access_token\"]\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_login_user(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n assert response.status_code == 200\n assert response.json[\"access_token\"]\n\n\ndef test_login_user_bad_password(client, created_user_details):\n username, _ = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": \"bad_password\"},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_login_user_bad_username(client, created_user_details):\n _, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": \"bad_username\", \"password\": password},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/resources/user.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import create_access_token\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n\n\n@blp.route(\"/login\")\nclass UserLogin(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n user = UserModel.query.filter(\n UserModel.username == user_data[\"username\"]\n ).first()\n\n if user and pbkdf2_sha256.verify(user_data[\"password\"], user.password):\n access_token = create_access_token(identity=str(user.id))\n return {\"access_token\": access_token}, 200\n\n abort(401, message=\"Invalid credentials.\")\n\n\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/08_protect_resources_with_jwt_required/start/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/README.md",
"content": "---\ntitle: JWT claims and authorization\ndescription: Learn how to add claims (extra info) to a JWT and use it for authorization in endpoints of a REST API.\nctslug: jwt-claims-and-authorization\n---\n\n# JWT Claims and Authorization\n\nJWT claims are extra data we can add to the JWT. For example, we could store in the JWT whether the user whose ID is stored in the JWT is an \"administrator\" or not.\n\nBy doing this, we only have to check the user's permissions once, when we create the JWT, and not every time the user makes a request.\n\nTo add a custom claim to a JWT we define a function similar to the error handling functions we wrote in the last lecture:\n\n```python title=\"app.py\"\napp.config[\"JWT_SECRET_KEY\"] = \"jose\"\njwt = JWTManager(app)\n\n# highlight-start\n@jwt.additional_claims_loader\ndef add_claims_to_jwt(identity):\n if identity == 1:\n return {\"is_admin\": True}\n return {\"is_admin\": False}\n# highlight-end\n\n@jwt.expired_token_loader\ndef expired_token_callback(jwt_header, jwt_payload):\n return (\n jsonify({\"message\": \"The token has expired.\", \"error\": \"token_expired\"}),\n 401,\n )\n```\n\n:::caution Read from a database or config file\nHere we're assuming that the user with and ID of `1` will be the administrator. Normally you'd read this from either a config file or the database.\n:::\n\n## How to use JWT claims in an endpoint\n\nLet's make a small change to the `Item` resource so that only admins can delete items.\n\nTo do so, we'll need to add an import for `get_jwt`:\n\n```python title=\"resources/item.py\"\nfrom flask_jwt_extended import jwt_required, get_jwt\n```\n\nThen in the `delete` endpoint, we can use `get_jwt()` to check the data in the JWT (which behaves like a dictionary):\n\n```python title=\"resources/item.py\"\n@jwt_required()\ndef delete(self, item_id):\n # highlight-start\n jwt = get_jwt()\n if not jwt.get(\"is_admin\"):\n abort(401, message=\"Admin privilege required.\")\n # highlight-end\n\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n```"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/app.py",
"content": "from flask import Flask, jsonify\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n # @jwt.additional_claims_loader\n # def add_claims_to_jwt(identity):\n # # TODO: Read from a config file instead of hard-coding\n # if identity == 1:\n # return {\"is_admin\": True}\n # return {\"is_admin\": False}\n\n @jwt.expired_token_loader\n def expired_token_callback(jwt_header, jwt_payload):\n return (\n jsonify({\"message\": \"The token has expired.\", \"error\": \"token_expired\"}),\n 401,\n )\n\n @jwt.invalid_token_loader\n def invalid_token_callback(error):\n return (\n jsonify(\n {\"message\": \"Signature verification failed.\", \"error\": \"invalid_token\"}\n ),\n 401,\n )\n\n @jwt.unauthorized_loader\n def missing_token_callback(error):\n return (\n jsonify(\n {\n \"description\": \"Request does not contain an access token.\",\n \"error\": \"authorization_required\",\n }\n ),\n 401,\n )\n\n @jwt.revoked_token_loader\n def revoked_token_callback(jwt_header, jwt_payload):\n return (\n jsonify(\n {\"description\": \"The token has been revoked.\", \"error\": \"token_revoked\"}\n ),\n 401,\n )\n\n # JWT configuration ends\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/conftest.py",
"content": "import pytest\nfrom flask_jwt_extended import create_access_token\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n\n\n@pytest.fixture()\ndef jwt(app):\n with app.app_context():\n access_token = create_access_token(identity=1)\n return access_token\n\n\n@pytest.fixture()\ndef admin_jwt(app):\n with app.app_context():\n access_token = create_access_token(\n identity=1, additional_claims={\"is_admin\": True}\n )\n return access_token\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, jwt, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, jwt, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client, jwt):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client, jwt):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, admin_jwt, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {admin_jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_delete_item_without_admin(client, jwt, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Admin privilege required.\"\n\n\ndef test_update_item(client, jwt, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client, jwt):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n \"/item\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client, jwt):\n response = client.get(\n \"/item\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, jwt, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, jwt, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client, jwt):\n response = client.get(\n \"/item/1\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, jwt, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id, jwt):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client, jwt):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\n@pytest.fixture()\ndef created_user_jwt(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n return response.json[\"access_token\"]\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_login_user(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n assert response.status_code == 200\n assert response.json[\"access_token\"]\n\n\ndef test_login_user_bad_password(client, created_user_details):\n username, _ = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": \"bad_password\"},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_login_user_bad_username(client, created_user_details):\n _, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": \"bad_username\", \"password\": password},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import jwt_required, get_jwt\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @jwt_required()\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n @jwt_required()\n def delete(self, item_id):\n jwt = get_jwt()\n if not jwt.get(\"is_admin\"):\n abort(401, message=\"Admin privilege required.\")\n\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @jwt_required()\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @jwt_required()\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/\")\nclass LinkTagsToItem(MethodView):\n @blp.response(201, TagSchema)\n def post(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.append(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return tag\n\n @blp.response(200, TagAndItemSchema)\n def delete(self, item_id, tag_id):\n item = ItemModel.query.get_or_404(item_id)\n tag = TagModel.query.get_or_404(tag_id)\n\n item.tags.remove(tag)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the tag.\")\n\n return {\"message\": \"Item removed from tag\", \"item\": item, \"tag\": tag}\n\n\n@blp.route(\"/tag/\")\nclass Tag(MethodView):\n @blp.response(200, TagSchema)\n def get(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n return tag\n\n @blp.response(\n 202,\n description=\"Deletes a tag if no item is tagged with it.\",\n example={\"message\": \"Tag deleted.\"},\n )\n @blp.alt_response(404, description=\"Tag not found.\")\n @blp.alt_response(\n 400,\n description=\"Returned if the tag is assigned to one or more items. In this case, the tag is not deleted.\",\n )\n def delete(self, tag_id):\n tag = TagModel.query.get_or_404(tag_id)\n\n if not tag.items:\n db.session.delete(tag)\n db.session.commit()\n return {\"message\": \"Tag deleted.\"}\n abort(\n 400,\n message=\"Could not delete tag. Make sure tag is not associated with any items, then try again.\", # noqa: E501\n )\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/resources/user.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import create_access_token\nfrom passlib.hash import pbkdf2_sha256\n\nfrom db import db\nfrom models import UserModel\nfrom schemas import UserSchema\n\n\nblp = Blueprint(\"Users\", \"users\", description=\"Operations on users\")\n\n\n@blp.route(\"/register\")\nclass UserRegister(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n if UserModel.query.filter(UserModel.username == user_data[\"username\"]).first():\n abort(409, message=\"A user with that username already exists.\")\n\n user = UserModel(\n username=user_data[\"username\"],\n password=pbkdf2_sha256.hash(user_data[\"password\"]),\n )\n db.session.add(user)\n db.session.commit()\n\n return {\"message\": \"User created successfully.\"}, 201\n\n\n@blp.route(\"/login\")\nclass UserLogin(MethodView):\n @blp.arguments(UserSchema)\n def post(self, user_data):\n user = UserModel.query.filter(\n UserModel.username == user_data[\"username\"]\n ).first()\n\n if user and pbkdf2_sha256.verify(user_data[\"password\"], user.password):\n access_token = create_access_token(identity=str(user.id))\n return {\"access_token\": access_token}, 200\n\n abort(401, message=\"Invalid credentials.\")\n\n\n@blp.route(\"/user/\")\nclass User(MethodView):\n \"\"\"\n This resource can be useful when testing our Flask app.\n We may not want to expose it to public users, but for the\n sake of demonstration in this course, it can be useful\n when we are manipulating data regarding the users.\n \"\"\"\n\n @blp.response(200, UserSchema)\n def get(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n return user\n\n def delete(self, user_id):\n user = UserModel.query.get_or_404(user_id)\n db.session.delete(user)\n db.session.commit()\n return {\"message\": \"User deleted.\"}, 200\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/end/schemas.py",
"content": "from marshmallow import Schema, fields\n\n\nclass PlainItemSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str(required=True)\n price = fields.Float(required=True)\n\n\nclass PlainStoreSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass PlainTagSchema(Schema):\n id = fields.Int(dump_only=True)\n name = fields.Str()\n\n\nclass ItemSchema(PlainItemSchema):\n store_id = fields.Int(required=True, load_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass ItemUpdateSchema(Schema):\n name = fields.Str()\n price = fields.Float()\n\n\nclass StoreSchema(PlainStoreSchema):\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n tags = fields.List(fields.Nested(PlainTagSchema()), dump_only=True)\n\n\nclass TagSchema(PlainTagSchema):\n store_id = fields.Int(load_only=True)\n items = fields.List(fields.Nested(PlainItemSchema()), dump_only=True)\n store = fields.Nested(PlainStoreSchema(), dump_only=True)\n\n\nclass TagAndItemSchema(Schema):\n message = fields.Str()\n item = fields.Nested(ItemSchema)\n tag = fields.Nested(TagSchema)\n\n\nclass UserSchema(Schema):\n id = fields.Int(dump_only=True)\n username = fields.Str(required=True)\n password = fields.Str(required=True, load_only=True)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/.dockerignore",
"content": ".venv\n*.pyc\n__pycache__\ndata.db"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/.flake8",
"content": "[flake8]\nper-file-ignores = __init__.py:F401"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/.flaskenv",
"content": "FLASK_APP=app\nFLASK_DEBUG=True"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/Dockerfile",
"content": "FROM python:3.10\nEXPOSE 5000\nWORKDIR /app\nCOPY ./requirements.txt requirements.txt\nRUN pip install --no-cache-dir --upgrade -r requirements.txt\nCOPY . .\nCMD [\"flask\", \"run\", \"--host\", \"0.0.0.0\"]"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/app.py",
"content": "from flask import Flask, jsonify\nfrom flask_smorest import Api\nfrom flask_jwt_extended import JWTManager\n\nfrom db import db\n\nfrom resources.user import blp as UserBlueprint\nfrom resources.item import blp as ItemBlueprint\nfrom resources.store import blp as StoreBlueprint\nfrom resources.tag import blp as TagBlueprint\n\n\ndef create_app(db_url=None):\n app = Flask(__name__)\n app.config[\"API_TITLE\"] = \"Stores REST API\"\n app.config[\"API_VERSION\"] = \"v1\"\n app.config[\"OPENAPI_VERSION\"] = \"3.0.3\"\n app.config[\"OPENAPI_URL_PREFIX\"] = \"/\"\n app.config[\"OPENAPI_SWAGGER_UI_PATH\"] = \"/swagger-ui\"\n app.config[\n \"OPENAPI_SWAGGER_UI_URL\"\n ] = \"https://cdn.jsdelivr.net/npm/swagger-ui-dist/\"\n app.config[\"SQLALCHEMY_DATABASE_URI\"] = db_url or \"sqlite:///data.db\"\n app.config[\"SQLALCHEMY_TRACK_MODIFICATIONS\"] = False\n app.config[\"PROPAGATE_EXCEPTIONS\"] = True\n db.init_app(app)\n api = Api(app)\n\n app.config[\"JWT_SECRET_KEY\"] = \"jose\"\n jwt = JWTManager(app)\n\n @jwt.expired_token_loader\n def expired_token_callback(jwt_header, jwt_payload):\n return (\n jsonify({\"message\": \"The token has expired.\", \"error\": \"token_expired\"}),\n 401,\n )\n\n @jwt.invalid_token_loader\n def invalid_token_callback(error):\n return (\n jsonify(\n {\"message\": \"Signature verification failed.\", \"error\": \"invalid_token\"}\n ),\n 401,\n )\n\n @jwt.unauthorized_loader\n def missing_token_callback(error):\n return (\n jsonify(\n {\n \"description\": \"Request does not contain an access token.\",\n \"error\": \"authorization_required\",\n }\n ),\n 401,\n )\n\n @jwt.revoked_token_loader\n def revoked_token_callback(jwt_header, jwt_payload):\n return (\n jsonify(\n {\"description\": \"The token has been revoked.\", \"error\": \"token_revoked\"}\n ),\n 401,\n )\n\n # JWT configuration ends\n\n with app.app_context():\n import models # noqa: F401\n\n db.create_all()\n\n api.register_blueprint(UserBlueprint)\n api.register_blueprint(ItemBlueprint)\n api.register_blueprint(StoreBlueprint)\n api.register_blueprint(TagBlueprint)\n\n return app\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/conftest.py",
"content": "import pytest\nfrom flask_jwt_extended import create_access_token\nfrom app import create_app\n\n\n@pytest.fixture()\ndef app():\n app = create_app(\"sqlite://\")\n app.config.update(\n {\n \"TESTING\": True,\n }\n )\n\n yield app\n\n\n@pytest.fixture()\ndef client(app):\n return app.test_client()\n\n\n@pytest.fixture()\ndef jwt(app):\n with app.app_context():\n access_token = create_access_token(identity=1)\n return access_token\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/db.py",
"content": "from flask_sqlalchemy import SQLAlchemy\n\ndb = SQLAlchemy()\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/models/__init__.py",
"content": "from models.user import UserModel\nfrom models.item import ItemModel\nfrom models.tag import TagModel\nfrom models.store import StoreModel\nfrom models.item_tags import ItemsTags\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/models/item.py",
"content": "from db import db\n\n\nclass ItemModel(db.Model):\n __tablename__ = \"items\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n price = db.Column(db.Float(precision=2), unique=False, nullable=False)\n\n store_id = db.Column(\n db.Integer, db.ForeignKey(\"stores.id\"), unique=False, nullable=False\n )\n store = db.relationship(\"StoreModel\", back_populates=\"items\")\n\n tags = db.relationship(\"TagModel\", back_populates=\"items\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/models/item_tags.py",
"content": "from db import db\n\n\nclass ItemsTags(db.Model):\n __tablename__ = \"items_tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n item_id = db.Column(db.Integer, db.ForeignKey(\"items.id\"))\n tag_id = db.Column(db.Integer, db.ForeignKey(\"tags.id\"))\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/models/store.py",
"content": "from db import db\n\n\nclass StoreModel(db.Model):\n __tablename__ = \"stores\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=True, nullable=False)\n\n tags = db.relationship(\"TagModel\", back_populates=\"store\", lazy=\"dynamic\")\n items = db.relationship(\"ItemModel\", back_populates=\"store\", lazy=\"dynamic\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/models/tag.py",
"content": "from db import db\n\n\nclass TagModel(db.Model):\n __tablename__ = \"tags\"\n\n id = db.Column(db.Integer, primary_key=True)\n name = db.Column(db.String(80), unique=False, nullable=False)\n store_id = db.Column(db.Integer, db.ForeignKey(\"stores.id\"), nullable=False)\n\n store = db.relationship(\"StoreModel\", back_populates=\"tags\")\n items = db.relationship(\"ItemModel\", back_populates=\"tags\", secondary=\"items_tags\")\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/models/user.py",
"content": "from db import db\n\n\nclass UserModel(db.Model):\n __tablename__ = \"users\"\n\n id = db.Column(db.Integer, primary_key=True)\n username = db.Column(db.String(80), unique=True, nullable=False)\n password = db.Column(db.String(80), nullable=False)\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/requirements-dev.txt",
"content": "pytest\nblack\nflake8"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/requirements.txt",
"content": "Flask-JWT-Extended\nFlask-Smorest\nFlask-SQLAlchemy\npasslib\nmarshmallow\npython-dotenv\ngunicorn"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/__init__.py",
"content": ""
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/__tests__/conftest.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_store_id(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_item_id(client, jwt, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n return response.json[\"id\"]\n\n\n@pytest.fixture()\ndef created_tag_id(client, created_store_id):\n response = client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n return response.json[\"id\"]\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/__tests__/test_item.py",
"content": "def test_create_item_in_store(client, jwt, created_store_id):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_create_item_with_store_id_not_found(client, jwt):\n # Note that this will fail if foreign key constraints are enabled.\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] is None\n\n\ndef test_create_item_with_unknown_data(client, jwt):\n response = client.post(\n \"/item\",\n json={\n \"name\": \"Test Item\",\n \"price\": 10.5,\n \"store_id\": 1,\n \"unknown_field\": \"unknown\",\n },\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 422\n assert response.json[\"errors\"][\"json\"][\"unknown_field\"] == [\"Unknown field.\"]\n\n\ndef test_delete_item(client, jwt, created_item_id):\n response = client.delete(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"message\"] == \"Item deleted.\"\n\n\ndef test_update_item(client, jwt, created_item_id):\n response = client.put(\n f\"/item/{created_item_id}\",\n json={\"name\": \"Test Item (updated)\", \"price\": 12.5},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item (updated)\"\n assert response.json[\"price\"] == 12.5\n\n\ndef test_get_all_items(client, jwt):\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n response = client.post(\n \"/item\",\n json={\"name\": \"Test Item 2\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n \"/item\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert len(response.json) == 2\n assert response.json[0][\"name\"] == \"Test Item\"\n assert response.json[0][\"price\"] == 10.5\n assert response.json[1][\"name\"] == \"Test Item 2\"\n\n\ndef test_get_all_items_empty(client, jwt):\n response = client.get(\n \"/item\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert len(response.json) == 0\n\n\ndef test_get_item_details(client, jwt, created_item_id, created_store_id):\n response = client.get(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"store\"] == {\"id\": created_store_id, \"name\": \"Test Store\"}\n\n\ndef test_get_item_details_with_tag(client, jwt, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n response = client.get(\n f\"/item/{created_item_id}\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 200\n assert response.json[\"name\"] == \"Test Item\"\n assert response.json[\"price\"] == 10.5\n assert response.json[\"tags\"] == [{\"id\": created_tag_id, \"name\": \"Test Tag\"}]\n\n\ndef test_get_item_detail_not_found(client, jwt):\n response = client.get(\n \"/item/1\",\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/__tests__/test_store.py",
"content": "def test_get_store(client, created_store_id):\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [],\n }\n\n\ndef test_get_store_not_found(client):\n response = client.get(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_with_item(client, jwt, created_store_id):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": created_store_id},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_get_store_with_tag(client, created_store_id):\n client.post(\n f\"/store/{created_store_id}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"tags\"] == [{\"id\": 1, \"name\": \"Test Tag\"}]\n\n\ndef test_create_store(client):\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n assert response.status_code == 201\n assert response.json[\"name\"] == \"Test Store\"\n\n\ndef test_create_store_with_items(client, created_store_id, jwt):\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n # Get the store with id 1 and check the items contains the newly created item\n response = client.get(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_delete_store(client, created_store_id):\n response = client.delete(\n f\"/store/{created_store_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\"message\": \"Store deleted\"}\n\n\ndef test_delete_store_doesnt_exist(client):\n response = client.delete(\n \"/store/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_store_list_empty(client):\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == []\n\n\ndef test_get_store_list_single(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [{\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []}]\n\n\ndef test_get_store_list_multiple(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/store\",\n json={\"name\": \"Test Store 2\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\"id\": 1, \"name\": \"Test Store\", \"items\": [], \"tags\": []},\n {\"id\": 2, \"name\": \"Test Store 2\", \"items\": [], \"tags\": []},\n ]\n\n\ndef test_get_store_list_with_items(client, jwt):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n \"/item\",\n json={\"name\": \"Test Item\", \"price\": 10.5, \"store_id\": 1},\n headers={\"Authorization\": f\"Bearer {jwt}\"},\n )\n\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ],\n \"tags\": [],\n }\n ]\n\n\ndef test_get_store_list_with_tags(client):\n resp = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n client.post(\n f\"/store/{resp.json['id']}/tag\",\n json={\"name\": \"Test Tag\"},\n )\n response = client.get(\n \"/store\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": 1,\n \"name\": \"Test Store\",\n \"items\": [],\n \"tags\": [{\"id\": 1, \"name\": \"Test Tag\"}],\n }\n ]\n\n\ndef test_create_store_duplicate_name(client):\n client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n\n response = client.post(\n \"/store\",\n json={\"name\": \"Test Store\"},\n )\n assert response.status_code == 400\n assert response.json[\"message\"] == \"A store with that name already exists.\"\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/__tests__/test_tag.py",
"content": "import pytest\nimport logging\n\nLOGGER = logging.getLogger(__name__)\n\n\n@pytest.fixture()\ndef created_tag_with_item_id(client, created_item_id, created_tag_id):\n client.post(f\"/item/{created_item_id}/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n return response.json[\"id\"]\n\n\ndef test_get_tag(client, created_tag_id):\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n\n\ndef test_get_tag_not_found(client):\n response = client.get(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_items_linked_with_tag(client, created_tag_with_item_id):\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == [\n {\n \"id\": 1,\n \"name\": \"Test Item\",\n \"price\": 10.5,\n }\n ]\n\n\ndef test_unlink_tag_from_item(client, created_item_id, created_tag_with_item_id):\n client.delete(f\"/item/{created_item_id}/tag/{created_tag_with_item_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_with_item_id}\",\n )\n\n assert response.status_code == 200\n assert response.json[\"items\"] == []\n\n\ndef test_delete_tag_without_items(client, created_tag_id):\n delete_response = client.delete(f\"/tag/{created_tag_id}\")\n\n response = client.get(\n f\"/tag/{created_tag_id}\",\n )\n\n assert delete_response.status_code == 202\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_delete_tag_still_has_items(client, created_tag_with_item_id):\n response = client.delete(f\"/tag/{created_tag_with_item_id}\")\n\n assert response.status_code == 400\n assert (\n response.json[\"message\"]\n == \"Could not delete tag. Make sure tag is not associated with any items, then try again.\"\n )\n\n\ndef test_delete_tag_not_found(client):\n response = client.delete(\n \"/tag/1\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n\n\ndef test_get_all_tags_in_store(client, created_store_id, created_tag_id):\n response = client.get(\n f\"/store/{created_store_id}/tag\",\n )\n\n assert response.status_code == 200\n assert response.json == [\n {\n \"id\": created_tag_id,\n \"name\": \"Test Tag\",\n \"items\": [],\n \"store\": {\"id\": 1, \"name\": \"Test Store\"},\n }\n ]\n\n\ndef test_get_all_tags_in_store_not_found(client):\n response = client.get(\n \"/store/1/tag\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/__tests__/test_user.py",
"content": "import pytest\n\n\n@pytest.fixture()\ndef created_user_details(client):\n username = \"test_user\"\n password = \"test_password\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": password},\n )\n\n return username, password\n\n\n@pytest.fixture()\ndef created_user_jwt(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n return response.json[\"access_token\"]\n\n\ndef test_register_user(client):\n username = \"test_user\"\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 201\n assert response.json == {\"message\": \"User created successfully.\"}\n\n\ndef test_register_user_already_exists(client):\n username = \"test_user\"\n client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n response = client.post(\n \"/register\",\n json={\"username\": username, \"password\": \"Test Password\"},\n )\n\n assert response.status_code == 409\n assert response.json[\"message\"] == \"A user with that username already exists.\"\n\n\ndef test_register_user_missing_data(client):\n response = client.post(\n \"/register\",\n json={},\n )\n\n assert response.status_code == 422\n assert \"password\" in response.json[\"errors\"][\"json\"]\n assert \"username\" in response.json[\"errors\"][\"json\"]\n\n\ndef test_login_user(client, created_user_details):\n username, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": password},\n )\n\n assert response.status_code == 200\n assert response.json[\"access_token\"]\n\n\ndef test_login_user_bad_password(client, created_user_details):\n username, _ = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": username, \"password\": \"bad_password\"},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_login_user_bad_username(client, created_user_details):\n _, password = created_user_details\n response = client.post(\n \"/login\",\n json={\"username\": \"bad_username\", \"password\": password},\n )\n\n assert response.status_code == 401\n assert response.json[\"message\"] == \"Invalid credentials.\"\n\n\ndef test_get_user_details(client, created_user_details):\n response = client.get(\n \"/user/1\", # assume user id is 1\n )\n\n assert response.status_code == 200\n assert response.json == {\n \"id\": 1,\n \"username\": created_user_details[0],\n }\n\n\ndef test_get_user_details_missing(client):\n response = client.get(\n \"/user/23\",\n )\n\n assert response.status_code == 404\n assert response.json == {\"code\": 404, \"status\": \"Not Found\"}\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/item.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom flask_jwt_extended import jwt_required\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import ItemModel\nfrom schemas import ItemSchema, ItemUpdateSchema\n\nblp = Blueprint(\"Items\", __name__, description=\"Operations on items\")\n\n\n@blp.route(\"/item/\")\nclass Item(MethodView):\n @jwt_required()\n @blp.response(200, ItemSchema)\n def get(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n return item\n\n @jwt_required()\n def delete(self, item_id):\n item = ItemModel.query.get_or_404(item_id)\n db.session.delete(item)\n db.session.commit()\n return {\"message\": \"Item deleted.\"}\n\n @blp.arguments(ItemUpdateSchema)\n @blp.response(200, ItemSchema)\n def put(self, item_data, item_id):\n item = ItemModel.query.get(item_id)\n\n if item:\n item.price = item_data[\"price\"]\n item.name = item_data[\"name\"]\n else:\n item = ItemModel(id=item_id, **item_data)\n\n db.session.add(item)\n db.session.commit()\n\n return item\n\n\n@blp.route(\"/item\")\nclass ItemList(MethodView):\n @jwt_required()\n @blp.response(200, ItemSchema(many=True))\n def get(self):\n return ItemModel.query.all()\n\n @jwt_required()\n @blp.arguments(ItemSchema)\n @blp.response(201, ItemSchema)\n def post(self, item_data):\n item = ItemModel(**item_data)\n\n try:\n db.session.add(item)\n db.session.commit()\n except SQLAlchemyError:\n abort(500, message=\"An error occurred while inserting the item.\")\n\n return item\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/store.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError, IntegrityError\n\nfrom db import db\nfrom models import StoreModel\nfrom schemas import StoreSchema\n\n\nblp = Blueprint(\"Stores\", __name__, description=\"Operations on stores\")\n\n\n@blp.route(\"/store/\")\nclass Store(MethodView):\n @blp.response(200, StoreSchema)\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n return store\n\n def delete(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n db.session.delete(store)\n db.session.commit()\n return {\"message\": \"Store deleted\"}, 200\n\n\n@blp.route(\"/store\")\nclass StoreList(MethodView):\n @blp.response(200, StoreSchema(many=True))\n def get(self):\n return StoreModel.query.all()\n\n @blp.arguments(StoreSchema)\n @blp.response(201, StoreSchema)\n def post(self, store_data):\n store = StoreModel(**store_data)\n try:\n db.session.add(store)\n db.session.commit()\n except IntegrityError:\n abort(\n 400,\n message=\"A store with that name already exists.\",\n )\n except SQLAlchemyError:\n abort(500, message=\"An error occurred creating the store.\")\n\n return store\n"
},
{
"path": "docs/docs/08_flask_jwt_extended/09_jwt_claims_and_authorization/start/resources/tag.py",
"content": "from flask.views import MethodView\nfrom flask_smorest import Blueprint, abort\nfrom sqlalchemy.exc import SQLAlchemyError\n\nfrom db import db\nfrom models import TagModel, StoreModel, ItemModel\nfrom schemas import TagSchema, TagAndItemSchema\n\nblp = Blueprint(\"Tags\", \"tags\", description=\"Operations on tags\")\n\n\n@blp.route(\"/store//tag\")\nclass TagsInStore(MethodView):\n @blp.response(200, TagSchema(many=True))\n def get(self, store_id):\n store = StoreModel.query.get_or_404(store_id)\n\n return store.tags.all() # lazy=\"dynamic\" means 'tags' is a query\n\n @blp.arguments(TagSchema)\n @blp.response(201, TagSchema)\n def post(self, tag_data, store_id):\n if TagModel.query.filter(TagModel.store_id == store_id, TagModel.name == tag_data[\"name\"]).first():\n abort(400, message=\"A tag with that name already exists in that store.\")\n\n tag = TagModel(**tag_data, store_id=store_id)\n\n try:\n db.session.add(tag)\n db.session.commit()\n except SQLAlchemyError as e:\n abort(\n 500,\n message=str(e),\n )\n\n return tag\n\n\n@blp.route(\"/item//tag/![\"REST](\"assets/course-image.png\")
\n