Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
Hands-On RESTful Python Web Services

You're reading from   Hands-On RESTful Python Web Services Develop RESTful web services or APIs with modern Python 3.7

Arrow left icon
Product type Paperback
Published in Dec 2018
Publisher
ISBN-13 9781789532227
Length 500 pages
Edition 2nd Edition
Languages
Tools
Concepts
Arrow right icon
Author (1):
Arrow left icon
Gaston C. Hillar Gaston C. Hillar
Author Profile Icon Gaston C. Hillar
Gaston C. Hillar
Arrow right icon
View More author details
Toc

Table of Contents (14) Chapters Close

Preface 1. Developing RESTful APIs and Microservices with Flask 1.0.2 FREE CHAPTER 2. Working with Models, SQLAlchemy, and Hyperlinked APIs in Flask 3. Improving Our API and Adding Authentication to it with Flask 4. Testing and Deploying an API in a Microservice with Flask 5. Developing RESTful APIs with Django 2.1 6. Working with Class-Based Views and Hyperlinked APIs in Django 2.1 7. Improving Our API and Adding Authentication to it with Django 8. Throttling, Filtering, Testing, and Deploying an API with Django 2.1 9. Developing RESTful APIs with Pyramid 1.10 10. Developing RESTful APIs with Tornado 5.1.1 11. Working with Asynchronous Code, Testing, and Deploying an API with Tornado 12. Assessment 13. Other Books You May Enjoy

Using a dictionary as a repository

Now, we will create a NotificationManager class that we will use to persist the NotificationModel instances in an in-memory dictionary. Our API methods will call methods for the NotificationManager class to retrieve, insert, update, and delete NotificationModel instances. Create a new service.py file in the service folder. The following lines show the code that creates a NotificationManager class in the service/service.py file. In addition, the following lines declare all the imports we will need for all the code we will write in this file. The code file for the sample is included in the restful_python_2_01_01 folder, in the Flask01/service/service.py file:

from flask import Flask 
from flask_restful import abort, Api, fields, marshal_with, reqparse, Resource 
from datetime import datetime 
from models import NotificationModel 
from http_status import HttpStatus 
from pytz import utc 
 
 
class NotificationManager(): 
    last_id = 0 
    def __init__(self): 
        self.notifications = {} 
 
    def insert_notification(self, notification): 
        self.__class__.last_id += 1 
        notification.id = self.__class__.last_id 
        self.notifications[self.__class__.last_id] = notification 
 
    def get_notification(self, id): 
        return self.notifications[id] 
 
    def delete_notification(self, id): 
        del self.notifications[id] 

The NotificationManager class declares a last_id class attribute and initializes it to 0. This class attribute stores the last ID that was generated and assigned to a NotificationModel instance stored in a dictionary. The constructor, that is, the __init__ method, creates and initializes the notifications attribute as an empty dictionary.

The code declares the following three methods for the class:

  • insert_notification: This method receives a recently created NotificationModel instance in the notification argument. The code increases the value for the last_id class attribute and then assigns the resulting value to the ID for the received notification. The code uses self.__class__ to reference the type of the current instance. Finally, the code adds notification as a value to the key identified with the generated ID, last_id, in the self.notifications dictionary.
  • get_notification: This method receives the id of the notification that has to be retrieved from the self.notifications dictionary. The code returns the value related to the key that matches the received id in the self.notifications dictionary that we are using as our data source.
  • delete_notification: This method receives the id of the notification that has to be removed from the self.notifications dictionary. The code deletes the key-value pair whose key matches the ID received in the self.notifications dictionary that we are using as our data source.

We don't need a method to update a notification because we will just make changes to the attributes of the NotificationModel instance that is already stored in the self.notifications dictionary. The value stored in the dictionary is a reference to the NotificationModel instance that we are updating and, therefore, we don't need to call a specific method to update the instance in the dictionary. However, in case we were working with a database, we would need to call an update method for our ORM, data repository, or database service.

You have been reading a chapter from
Hands-On RESTful Python Web Services - Second Edition
Published in: Dec 2018
Publisher:
ISBN-13: 9781789532227
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $19.99/month. Cancel anytime
Banner background image