<ul><li>Built-in fast webserver</li><li>Production-ready</li><li>Highly scalable</li><li>ASGI compliant</li><li>Simple and intuitive API design</li><li>By the community, for the community</li></ul>

Features

Goal : To provide a simple way to get up and running a high-performance HTTP server that is easy to build, expand, and ultimately to scale.

<ul><li>What if we want to get data if the database is empty?</li><li>what if we want to update a student that is not in the database?</li><li>What if we want to delete a student that is not in the database?</li><li>What if we want to get data by id, not whole data?</li></ul>

Questions to solve

<figure><img alt="" src="https://miro.medium.com/max/500/0*OEY3CK0-l8A9riW" width="680" height="340"></figure><h1 data-selectable-paragraph="">1. What is Sanic?</h1><a href="https://sanicframework.org/en/" rel="noopener ugc nofollow" dir="ltr">Sanic</a> is a Python 3.7+ web server and web framework that’s written to go fast. It allows the usage of the async/await syntax added in Python 3.5, which makes your code non-blocking and speedy.Goal: To provide a simple way to get up and running a high-performance HTTP server that is easy to build, expand, and ultimately to scale.<h2 data-selectable-paragraph="">Features</h2><UL><LI>Built-in fast webserver</LI><LI>Production-ready</LI><LI>Highly scalable</LI><LI>ASGI compliant</LI><LI>Simple and intuitive API design</LI><LI>By the community, for the community</LI></UL><h1 data-selectable-paragraph="">2. How to Sanic</h1>In this tutorial, we will create Restful API using Sanic. Data formats of the REST API include application/JSON.<h1 data-selectable-paragraph="">3. Project Setup</h1>Before getting our hands dirty, we need to configure our project.The following steps are followed for project configuration.<h2 data-selectable-paragraph="">Create new project</h2>Create a project directory named learnsanic and enter the folder.<figure><img alt="" src="https://miro.medium.com/max/500/1*lO1QLugxw1aqLPqrGZfvyw.png" width="680" height="396"></figure><h2 data-selectable-paragraph="">Configure Virtual environment</h2>To isolate each development environment we will be using a virtual environment.Before creating the virtual environment we need to ensure we have virtualenv installed. For that execute the following:<PRE>virtualenv --version</PRE>If we get an error, execute the following:<PRE>pip install virtualenv</PRE>Now again execute:<PRE>virtualenv --version</PRE>And you can see the version of your virtual environment.Now, create a virtual environment named <code dir="ltr">venv</code> by executing the following command:<PRE>virtualenv venv</PRE>After creating a virtual environment, the new directory can be visualized by executing the following command in the terminal:<PRE>ls</PRE>After creating a virtual environment, activate the virtual environment by running the following command:<PRE>source venv/bin/activate</PRE>Now you can see that in the terminal your virtual environment is activated:<figure><img alt="" src="https://miro.medium.com/max/500/1*1nSIr2xo1SQ42W18KJfMtQ.png" width="680" height="282"></figure><h2 data-selectable-paragraph="">Install Required Packages</h2>After activating our virtual environment, install packages that are required for the project.To install the sanic package in our virtual environment using the pip package manager, execute the following command:<PRE>pip install sanic</PRE><figure><img alt="" src="https://miro.medium.com/max/500/1*tV_67K27BLfDzNwCFLrrlw.png" width="680" height="247"></figure><h2 data-selectable-paragraph="">Create app.py file</h2>Execute the following:<PRE>touch app.py </PRE>And open the file in your preferred editor. If you are using VSCode executing the below command will do the work:<PRE>code app.py </PRE><figure><img alt="" src="https://miro.medium.com/max/500/1*7gLthBuKqu0-zKXGriJKLw.png" width="680" height="271"></figure><h2 data-selectable-paragraph="">Configure Environment</h2>First, create an instance of our Sanic application.For that import Sanic and create an instance as follows:<figure><img alt="" src="https://miro.medium.com/max/500/1*dUwOqBGXAxUlJ_23cAfzng.png" width="680" height="474"></figure><h1 data-selectable-paragraph="">4. Develop RESTful API</h1>Before developing API let us know what we are building.Our School is planning to make a RESTful API using Sanic so that they can add, get, update the details of their students. Initially, we will be focusing on an in-memory database i.e considering a variable as a database and later we will move to an actual SQL database.Our School wants to have details of students and the fields contain a name, grade, roll, email, phone, subjects, friends initially.Let’s create our in-memory DB and provide the data in dictionary format and save it in <code dir="ltr">in_memory_student_db</code> variable like in the figure.<figure><img alt="" src="https://miro.medium.com/max/500/1*oYZMTlXOlgLxns-DYoDwPw.png" width="680" height="631"></figure>To get the data that is just created i.e <code dir="ltr">in_memory_student_db</code>.Create a get method.<PRE>@app.get("/") async def get_student(request): return in_memory_student_db</PRE>If you are wondering what is <code dir="ltr">@app.get(“/”)</code>, then they are called <a href="https://www.programiz.com/python-programming/decorator" rel="noopener ugc nofollow" dir="ltr">decorators</a>.For getting the response we will just create a get_student function like above and run the sanic app:<PRE>sanic app.app</PRE><figure><img alt="" src="https://miro.medium.com/max/500/1*ggoIykWScJmz6L2h5qeNJQ.png" width="680" height="205"></figure>This will run your server and when you hit the route in insomnia you will get the error as mentioned below:<code>Sanic.exceptions.ServerError: Invalid response type (need HTTPResponse)</code><figure><img alt="" src="https://miro.medium.com/max/500/1*fbPdUft9vZqCsR7z1j4B8Q.png" width="680" height="248"></figure>This mentions that we cannot return our list of dictionaries the return type must be HTTPResponse. For that we will import a response from sanic:<PRE>from sanic import response --- --- async def get_student(request): return response.json(in_memory_student_db) --- ---</PRE><figure><img alt="" src="https://miro.medium.com/max/500/1*7OGat__hp5mmM5_UJA74cA.png" width="680" height="716"></figure><figure><img alt="" src="https://miro.medium.com/max/500/1*gvM7Ag3KroI0X04C8m0ImQ.png" width="680" height="332"></figure><PRE>@app.post("/") async def post_student(request): student = request.json in_memory_student_db.append(student) return response.json(student)</PRE><figure><img alt="" src="https://miro.medium.com/max/500/1*Rx1xDCGjuzPPJIvU3aZJIg.png" width="680" height="309"></figure>Similarly, we write a program for update and delete:<PRE>@app.put("/&lt;id_:int&gt;") async def update_student(request,id_): student = request.json in_memory_student_db[id_] = student return response.json(student) @app.delete("/&lt;id_:int&gt;") async def delete_student(request,id_): del in_memory_student_db[id_] return response.json({"message":"Deleted student successfully"})</PRE><figure><img alt="" src="https://miro.medium.com/max/500/1*SZQKJVkG-w2pVUMCNtQ1sA.png" width="680" height="1003"></figure><figure><img alt="" src="https://miro.medium.com/max/500/1*hUsNgkm00uo6mBexMkrOhw.png" width="680" height="296"></figure><figure><img alt="" src="https://miro.medium.com/max/500/1*yOkjG-H510zJV4iN6c1Drg.png" width="680" height="252"></figure>This completes the simplest version of our CRUD operation in Sanic. But is it enough?<UL><LI>What if we want to get data if the database is empty?</LI><LI>what if we want to update a student that is not in the database?</LI><LI>What if we want to delete a student that is not in the database?</LI><LI>What if we want to get data by id, not whole data?</LI></UL>Now, remodeling the functions as follows:To get data by id or whole data, Change get function as follows:<PRE>@app.get("/") async def get_student(request): id_ = request.args.get("id") if id_: if int(id_) in range(len(in_memory_student_db)): return response.json(in_memory_student_db[int(id_)]) else: return response.json( { "status": "error", "message": f"data with id {id_} not found. Try with different id!!!" } ) return response.json(in_memory_student_db)</PRE>To update student that is not in the database, provide a message that there is no data with given id or specification. Change update function as follows:<PRE>@app.put("/&lt;id_:int&gt;") async def update_student(request,id_): student = request.json if id_ in range(len(in_memory_student_db)): in_memory_student_db[id_] = student else: return response.json({"error":"No Student with given id"}) return response.json(student)</PRE>To delete a student that is not in the database, provide the message that there is no data with the given id or specification. Change delete function as follows:<PRE>@app.delete("/&lt;id_:int&gt;") async def delete_student(request,id_): if id_ in range(len(in_memory_student_db)): del in_memory_student_db[id_] else: return response.json({"error": "No Student with given id"}) return response.json({"message": "Deleted student successfully"})</PRE>This completes CRUD operations.Next Part:

Goal: To provide a simple way to get up and running a high-performance HTTP server that is easy to build, expand, and ultimately to scale.

Sanic is a Python 3.7+ web server and web framework that’s written to go fast. It allows the usage of the async/await syntax added in Python 3.5, which makes your code non-blocking and speedy. Goal…

technologyandthefuture

Technology & The Future

computerscience

Computer Science

softwareengineering

Software Engineering

<a href="https://sanicframework.org/en/">Sanic </a>is a Python 3.7+ web server and web framework that’s written to go fast. It allows the usage of the async/await syntax added in Python 3.5, which makes your code non-blocking and speedy.

Goal : To provide a simple way to get up and running a high-performance HTTP server that is easy to build, expand, and ultimately to scale.

<ul><li>Built-in fast webserver </li><li>Production-ready </li><li>Highly scalable </li><li>ASGI compliant </li><li>Simple and intuitive API design </li><li>By the community, for the community </li> </ul>

In this tutorial, we will create Restful API using Sanic. Data formats of the REST API include application/JSON.

Before getting our hands dirty, we need to configure our project.

The following steps are followed for project configuration.

Creat e a project directory named learnsanic and enter the folder.

To isolate each development environment we will be using a virtual environment.

Before creating the virtual environment we need to ensure we have virtualenv installed. For that execute the following:

If we get an error, execute the following:

And you can see the version of your virtual environment.

Now, create a virtual environment named <code>venv </code>by executing the following command:

After creating a virtual environment, the new directory can be visualized by executing the following command in the terminal:

After creating a virtual environment, activate the virtual environment by running the following command:

Now you can see that in the terminal your virtual environment is activated:

After activating our virtual environment, install packages that are required for the project.

To install the sanic package in our virtual environment using the pip package manager, execute the following command:

And open the file in your preferred editor. If you are using VSCode executing the below command will do the work:

First, create an instance of our Sanic application.

For that import Sanic and create an instance as follows:

Before developing API let us know what we are building.

Our School is planning to make a RESTful API using Sanic so that they can add, get, update the details of their students. Initially, we will be focusing on an in-memory database i.e considering a variable as a database and later we will move to an actual SQL database.

Our School wants to have details of students and the fields contain a name, grade, roll, email, phone, subjects, friends initially.

Let’s create our in-memory DB and provide the data in dictionary format and save it in <code>in_memory_student_db </code>variable like in the figure.

To get the data that is just created i.e <code>in_memory_student_db </code>.

If you are wondering what is <code>@app.get(“/”) </code>, then they are called <a href="https://www.programiz.com/python-programming/decorator">decorators </a>.

For getting the response we will just create a get_student function like above and run the sanic app:

This will run your server and when you hit the route in insomnia you will get the error as mentioned below:

<code>Sanic.exceptions.ServerError: Invalid response type (need HTTPResponse) </code>

This mentions that we cannot return our list of dictionaries the return type must be HTTPResponse. For that we will import a response from sanic:

Similarly, we write a program for update and delete:

This completes the simplest version of our CRUD operation in Sanic. But is it enough?

<ul><li>What if we want to get data if the database is empty? </li><li>what if we want to update a student that is not in the database? </li><li>What if we want to delete a student that is not in the database? </li><li>What if we want to get data by id, not whole data? </li> </ul>

Now, remodeling the functions as follows:

To get data by id or whole data, Change get function as follows:

To update student that is not in the database, provide a message that there is no data with given id or specification. Change update function as follows:

To delete a student that is not in the database, provide the message that there is no data with the given id or specification. Change delete function as follows:

Introducing Sanic: The Python Asynchoronous Web Framework

Features

Questions to solve

CURATED BY

CURATOR'S NOTE

Related collections

More like this