Skip to main content

Python Flask - Hinting Developers Input and Return Types - Best Practice

Use 'typing' library to hint co-developers reading the code to understand what datatype will a function return.

To hint input types

Example 1

def __init__(self, name: str, price: float, store_id: int):
self.name = name
self.price = price
self.store_id = store_id

Example 2

@classmethod
def find_by_name(cls, name: str) -> "ItemModel": # classmethod to search item in database by name
return cls.query.filter_by(name=name).first()

Example 3

@classmethod
def find_by_id(cls, _id: int) -> "UserModel": # classmethod to search store in database by id
return cls.query.filter_by(id=_id).first()
adding ":str" or ":int" or ":float" in front of the parameter only tells other developers about what is the expected input. It does not actually participate in giving errors when user actually does that.

To hint return types

This requires to import typing library
from typing import Dict, List, Union

When indicating the return type to be Dict

Example 1

Create a new variable that will explain how this particular Dict datatype is designed. Which means, what datatype will be the key and what datatype will be the value.
ItemJSON = Dict[str, Union[int, str, float]]
Then use it in the function to indicate that this is the data type the function would return
def json(self) -> ItemJSON:
return {"id": self.id, "name": self.name, "price": self.price, "store_id": self.store_id}

Example 2

Use previously defined variable for defining the 'Dict' into a new variable to define a new 'Dict', which includes a 'List' of previously defined 'Dict'
StoreJSON = Dict[str, Union[int, str, List[ItemJSON]]]
Then use it in the function to indicate that this is the data type the function would return
def json(self) -> StoreJSON:
return {"id": self.id, "name": self.name, "items": [item.json() for item in self.items.all()]}

When indicating the return type to be a class

Example 1

To indicate that the returning object is a class
@classmethod
def find_by_name(cls, name: str) -> "ItemModel": # classmethod to search in database by name
return cls.query.filter_by(name=name).first()
Example 2
And there could be a list of objects of a class type
@classmethod
def find_all(cls) -> List["ItemModel"]:
return cls.query.all()

Comments

Post a Comment

Popular posts from this blog

Difference between .exec() and .execPopulate() in Mongoose?

Here I answer what is the difference between .exec() and .execPopulate() in Mongoose? .exec() is used with a query while .execPopulate() is used with a document Syntax for .exec() is as follows: Model.query() . populate ( 'field' ) . exec () // returns promise . then ( function ( document ) { console . log ( document ); }); Syntax for .execPopulate() is as follows: fetchedDocument . populate ( 'field' ) . execPopulate () // returns promise . then ( function ( document ) { console . log ( document ); }); When working with individual document use .execPopulate(), for model query use .exec(). Both returns a promise. One can do without .exec() or .execPopulate() but then has to pass a callback in populate.
1 comment
Read more

Python - List - Append, Count, Extend, Index, Insert, Pop, Remove, Reverse, Sort

🐍 Advance List List is widely used and it's functionalities are heavily useful. Append Adds one element at the end of the list. Syntax list1.append(value) Input l1 = [1, 2, 3] l1.append(4) l1 Output [1, 2, 3, 4] append can be used to add any datatype in a list. It can even add list inside list. Caution: Append does not return anything. It just appends the list. Count .count(value) counts the number of occurrences of an element in the list. Syntax list1.count(value) Input l1 = [1, 2, 3, 4, 3] l1.count(3) Output 2 It returns 0 if the value is not found in the list. Extend .count(value) counts the number of occurrences of an element in the list. Syntax list1.extend(list) Input l1 = [1, 2, 3] l1.extend([4, 5]) Output [1, 2, 3, 4, 5] If we use append, entire list will be added to the first list like one element. Extend, i nstead of considering a list as one element, it joins the two lists one after other. Append works in the following way. Input l1 = [1, 2, 3] l1.append([4, 5]) Output...
Post a Comment
Read more

269. Alien Dictionary

  Solution This article assumes you already have some confidence with  graph algorithms , such as  breadth-first search  and  depth-first searching . If you're familiar with those, but not with  topological sort  (the topic tag for this problem), don't panic, as you should still be able to make sense of it. It is one of the many more advanced algorithms that keen programmers tend to "invent" themselves before realizing it's already a widely known and used algorithm. There are a couple of approaches to topological sort;  Kahn's Algorithm  and DFS. A few things to keep in mind: The letters  within a word  don't tell us anything about the relative order. For example, the presence of the word  kitten  in the list does  not  tell us that the letter  k  is before the letter  i . The input can contain words followed by their prefix, for example,  abcd  and then  ab . These cases will never ...
Post a Comment
Read more