Home Backend Development Python Tutorial Detailed explanation of the dataclass decorator, a new feature of Python 3.7

Detailed explanation of the dataclass decorator, a new feature of Python 3.7

Apr 21, 2018 pm 02:44 PM
python new function

This article mainly introduces you to the relevant information about the dataclass decorator, a new feature of Python 3.7. The article introduces it in great detail through example code. It has certain reference learning value for everyone's study or work. Friends who need it Let’s learn together.

Preface

Python 3.7 will be released this summer, and there will be many new things in Python 3.7:

  • Various character set improvements

  • Delayed evaluation of comments

  • and support for dataclass

One of the most exciting new features is the dataclass decorator.

What is Data Class

Most Python developers have written many classes like the following:

class MyClass:
 def __init__(self, var_a, var_b):
 self.var_a = var_a
 self.var_b = var_b
Copy after login

dataclass can automatically generate methods for simple cases, for example, an __init__ that accepts these parameters and assigns them to itself, the previous small example can be rewritten as:

@dataclass
class MyClass:
 var_a: str
 var_b: str
Copy after login

Let’s take an example to see how to use it

Star Wars API

You can use requests to obtain resources from the Star Wars API:

response = requests.get('https://swapi.co/api/films/1/')
dictionary = response.json()
Copy after login

Let's take a look at the dictionary (simplified) results:

{
 'characters': ['https://swapi.co/api/people/1/',… ],
 'created': '2014-12-10T14:23:31.880000Z',
 'director': 'George Lucas',
 'edited': '2015-04-11T09:46:52.774897Z',
 'episode_id': 4,
 'opening_crawl': 'It is a period of civil war.\r\n … ',
 'planets': ['https://swapi.co/api/planets/2/', … ],
 'producer': 'Gary Kurtz, Rick McCallum',
 'release_date': '1977-05-25',
 'species': ['https://swapi.co/api/species/5/',…],
 'starships': ['https://swapi.co/api/starships/2/',…],
 'title': 'A New Hope',
 'url': 'https://swapi.co/api/films/1/',
 'vehicles': ['https://swapi.co/api/vehicles/4/',…]
Copy after login

Encapsulating API

In order to properly encapsulate an API, we should create a user that can Object used in its application, therefore, in Python 3.6 an object is defined to contain requests responses to /films/endpoint:

class StarWarsMovie:
 def __init__(self,
   title: str,
   episode_id: int,
   opening_crawl: str,
   director: str,
   producer: str,
   release_date: datetime,
   characters: List[str],
   planets: List[str],
   starships: List[str],
   vehicles: List[str],
   species: List[str],
   created: datetime,
   edited: datetime,
   url: str
   ):

 self.title = title
 self.episode_id = episode_id
 self.opening_crawl= opening_crawl
 self.director = director
 self.producer = producer
 self.release_date = release_date
 self.characters = characters
 self.planets = planets
 self.starships = starships
 self.vehicles = vehicles
 self.species = species
 self.created = created
 self.edited = edited
 self.url = url

 if type(self.release_date) is str:
  self.release_date = dateutil.parser.parse(self.release_date)

 if type(self.created) is str:
  self.created = dateutil.parser.parse(self.created)

 if type(self.edited) is str:
  self.edited = dateutil.parser.parse(self.edited)
Copy after login

Careful Reader You may have noticed some duplicate code here.

This is a classic case of using the dataclass decorator, we need to create a class that is primarily used to hold data, with just a little validation, so let's see what we need to modify.

First, the data class automatically generates some dunder methods. If we do not specify any options for the data class decorator, the generated methods are: __init__, __eq__ and __repr__, if you have defined __repr__ But __str__ is not defined, and by default Python (not just data classes) will implement the output __str__ method that returns __repr__. Therefore, the four dunder methods can be implemented by simply changing the code to the following code:

@dataclass
class StarWarsMovie:
 title: str
 episode_id: int
 opening_crawl: str
 director: str
 producer: str
 release_date: datetime
 characters: List[str]
 planets: List[str]
 starships: List[str]
 vehicles: List[str]
 species: List[str]
 created: datetime
 edited: datetime
 url: str
Copy after login

We removed the __init__ method to ensure that the data class decoration The converter can add the corresponding methods it generates. However, we lost some functionality in the process, our Python 3.6 constructor not only defines all the values, but also attempts to parse the date, how can we do this with a data class?

If we want to override __init__, we will lose the advantage of data class, so if we want to handle any additional functionality, we can use the new dunder method: __post_init__, let us see the __post_init__ method for our wrapper class What does it look like:

def __post_init__(self):
 if type(self.release_date) is str:
  self.release_date = dateutil.parser.parse(self.release_date)

 if type(self.created) is str:
  self.created = dateutil.parser.parse(self.created)

 if type(self.edited) is str:
  self.edited = dateutil.parser.parse(self.edited)
Copy after login

That’s it! We can use the data class decorator to implement our class in two-thirds of the code.

More good stuff

The data class can be further customized for the use case by using the decorator's options. The default options are:

@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)
Copy after login

  • init determines whether to generate the __init__ dunder method

  • repr determines whether to generate the __repr__ dunder method

  • eq does the same for the __eq__ dunder method, which determines the behavior of the equality check (your_class_instance == another_instance)

  • order actually creates There are four dunder methods that determine the behavior of all checks for less than, and/or, and greater than, and if set to true, the list of objects can be sorted.

The last two options determine whether the object can be hashed, which is necessary if you want to use objects of your class as dictionary keys.

For more information, please refer to: PEP 557 -- Data Classes


##

The above is the detailed content of Detailed explanation of the dataclass decorator, a new feature of Python 3.7. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

PHP and Python: Different Paradigms Explained PHP and Python: Different Paradigms Explained Apr 18, 2025 am 12:26 AM

PHP is mainly procedural programming, but also supports object-oriented programming (OOP); Python supports a variety of paradigms, including OOP, functional and procedural programming. PHP is suitable for web development, and Python is suitable for a variety of applications such as data analysis and machine learning.

Choosing Between PHP and Python: A Guide Choosing Between PHP and Python: A Guide Apr 18, 2025 am 12:24 AM

PHP is suitable for web development and rapid prototyping, and Python is suitable for data science and machine learning. 1.PHP is used for dynamic web development, with simple syntax and suitable for rapid development. 2. Python has concise syntax, is suitable for multiple fields, and has a strong library ecosystem.

Python vs. JavaScript: The Learning Curve and Ease of Use Python vs. JavaScript: The Learning Curve and Ease of Use Apr 16, 2025 am 12:12 AM

Python is more suitable for beginners, with a smooth learning curve and concise syntax; JavaScript is suitable for front-end development, with a steep learning curve and flexible syntax. 1. Python syntax is intuitive and suitable for data science and back-end development. 2. JavaScript is flexible and widely used in front-end and server-side programming.

How to run programs in terminal vscode How to run programs in terminal vscode Apr 15, 2025 pm 06:42 PM

In VS Code, you can run the program in the terminal through the following steps: Prepare the code and open the integrated terminal to ensure that the code directory is consistent with the terminal working directory. Select the run command according to the programming language (such as Python's python your_file_name.py) to check whether it runs successfully and resolve errors. Use the debugger to improve debugging efficiency.

Can vs code run in Windows 8 Can vs code run in Windows 8 Apr 15, 2025 pm 07:24 PM

VS Code can run on Windows 8, but the experience may not be great. First make sure the system has been updated to the latest patch, then download the VS Code installation package that matches the system architecture and install it as prompted. After installation, be aware that some extensions may be incompatible with Windows 8 and need to look for alternative extensions or use newer Windows systems in a virtual machine. Install the necessary extensions to check whether they work properly. Although VS Code is feasible on Windows 8, it is recommended to upgrade to a newer Windows system for a better development experience and security.

Is the vscode extension malicious? Is the vscode extension malicious? Apr 15, 2025 pm 07:57 PM

VS Code extensions pose malicious risks, such as hiding malicious code, exploiting vulnerabilities, and masturbating as legitimate extensions. Methods to identify malicious extensions include: checking publishers, reading comments, checking code, and installing with caution. Security measures also include: security awareness, good habits, regular updates and antivirus software.

Can visual studio code be used in python Can visual studio code be used in python Apr 15, 2025 pm 08:18 PM

VS Code can be used to write Python and provides many features that make it an ideal tool for developing Python applications. It allows users to: install Python extensions to get functions such as code completion, syntax highlighting, and debugging. Use the debugger to track code step by step, find and fix errors. Integrate Git for version control. Use code formatting tools to maintain code consistency. Use the Linting tool to spot potential problems ahead of time.

PHP and Python: A Deep Dive into Their History PHP and Python: A Deep Dive into Their History Apr 18, 2025 am 12:25 AM

PHP originated in 1994 and was developed by RasmusLerdorf. It was originally used to track website visitors and gradually evolved into a server-side scripting language and was widely used in web development. Python was developed by Guidovan Rossum in the late 1980s and was first released in 1991. It emphasizes code readability and simplicity, and is suitable for scientific computing, data analysis and other fields.

See all articles