Pydantic is a type annotation-based Python library for data verification and model definition. 1. The model can be defined by inheriting BaseModel, and the fields support type checking and default values; 2. Automatically verify the data type, and throw a ValidationError when errors are errored; 3. Use the @validator decorator to implement custom verification logic, such as range checking and format verification; 4. Support parsing data from dictionaries, JSON strings, and use parse_obj or parse_raw methods; 5. Can nest models to process complex structures, such as objects in the list; 6. It is recommended to use model_dump() and model_dump_json() to output data, and supports Config configuration such as extra="ignore" to ignore redundant fields. It is widely used in FastAPI and other scenarios, making data processing safe and concise.
Pydantic is a very popular Python library for data parsing, verification, and type prompts. It is based on Python's type annotations, which can automatically verify data structures, and is very suitable for handling API requests, configuration files, data models and other scenarios.

Here is a practical Pydantic example showing how to define a model, perform data verification, handle errors, and some common features.
? Basic model definition and data verification
from pydantic import BaseModel, ValidationError from typing import Optional class User(BaseModel): name: str age: int email: str is_active: bool = True # Default nickname: Optional[str] = None # Optional field# Normal data try: user = User( name="Alice", age=30, email="alice@example.com", nickname="Al" ) print(user) # Output: name='Alice' age=30 email='alice@example.com' is_active=True nickname='Al' except ValidationError as e: print(e)
?? Example of data verification failure
# Error data: age is a string, does not conform to int type try: user = User( name="Bob", age="not_a_number", # Error type email="bob@example.com" ) except ValidationError as e: print(e) # Output detailed error information, such as: # 1 validation error for User # age # value is not a valid integer (type=type_error.integer)
?? Custom verification logic (using @validator
)
from pydantic import validator import re class User(BaseModel): name: str age: int email: str website: Optional[str] = None @validator('age') def check_age(cls, v): if v < 0 or v > 150: raise ValueError('Age must be between 0 and 150') Return v @validator('email') def validate_email(cls, v): if not re.match(r'^[^@] @[^@] \.[^@] $', v): raise ValueError('Invalid email format') Return v @validator('website', pre=True) # pre=True means to process def validate_website(cls, v): if v and not v.startswith(('http://', 'https://')): v = 'https://' v Return v # Test try: user = User( name="Charlie", age=25, email="charlie@example.com", website="example.com" ) print(user.website) # Output: https://example.com except ValidationError as e: print(e)
? Load data from JSON or dictionary
data = { "name": "Diana", "age": 28, "email": "diana@example.com" } user = User(**data) print(user.json(indent=2)) # Output formatted JSON
Or use .parse_obj()
:

user = User.parse_obj(data)
It can also be parsed from JSON strings:
import json json_str = '{"name": "Eve", "age": 35, "email": "eve@example.com"}' user = User.parse_raw(json_str)
? Model nesting (complex structure)
from typing import List class Address(BaseModel): city: str zipcode: str class Person(BaseModel): name: str addresses: List[Address] # Use example data = { "name": "Frank", "addresses": [ {"city": "Beijing", "zipcode": "100001"}, {"city": "Shanghai", "zipcode": "200001"} ] } person = Person(**data) print(person.json(indent=2))
? Tips
- Use
model_dump()
instead of old version ofdict()
(recommended by Pydantic v2) - Use
model_dump_json()
to output JSON strings - Support default factory (
default_factory
) - You can set
Config
control behavior, such as ignoring unknown fields:
class User(BaseModel): name: str class Config: extra = "ignore" # Ignore extra fields
Basically that's it. Pydantic makes data verification simple and clear, especially in FastAPI. Not complicated, but very practical.

The above is the detailed content of python pydantic example. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

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

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

Polymorphism is a core concept in Python object-oriented programming, referring to "one interface, multiple implementations", allowing for unified processing of different types of objects. 1. Polymorphism is implemented through method rewriting. Subclasses can redefine parent class methods. For example, the spoke() method of Animal class has different implementations in Dog and Cat subclasses. 2. The practical uses of polymorphism include simplifying the code structure and enhancing scalability, such as calling the draw() method uniformly in the graphical drawing program, or handling the common behavior of different characters in game development. 3. Python implementation polymorphism needs to satisfy: the parent class defines a method, and the child class overrides the method, but does not require inheritance of the same parent class. As long as the object implements the same method, this is called the "duck type". 4. Things to note include the maintenance

Parameters are placeholders when defining a function, while arguments are specific values ??passed in when calling. 1. Position parameters need to be passed in order, and incorrect order will lead to errors in the result; 2. Keyword parameters are specified by parameter names, which can change the order and improve readability; 3. Default parameter values ??are assigned when defined to avoid duplicate code, but variable objects should be avoided as default values; 4. args and *kwargs can handle uncertain number of parameters and are suitable for general interfaces or decorators, but should be used with caution to maintain readability.

Iterators are objects that implement __iter__() and __next__() methods. The generator is a simplified version of iterators, which automatically implement these methods through the yield keyword. 1. The iterator returns an element every time he calls next() and throws a StopIteration exception when there are no more elements. 2. The generator uses function definition to generate data on demand, saving memory and supporting infinite sequences. 3. Use iterators when processing existing sets, use a generator when dynamically generating big data or lazy evaluation, such as loading line by line when reading large files. Note: Iterable objects such as lists are not iterators. They need to be recreated after the iterator reaches its end, and the generator can only traverse it once.

A class method is a method defined in Python through the @classmethod decorator. Its first parameter is the class itself (cls), which is used to access or modify the class state. It can be called through a class or instance, which affects the entire class rather than a specific instance; for example, in the Person class, the show_count() method counts the number of objects created; when defining a class method, you need to use the @classmethod decorator and name the first parameter cls, such as the change_var(new_value) method to modify class variables; the class method is different from the instance method (self parameter) and static method (no automatic parameters), and is suitable for factory methods, alternative constructors, and management of class variables. Common uses include:

The key to dealing with API authentication is to understand and use the authentication method correctly. 1. APIKey is the simplest authentication method, usually placed in the request header or URL parameters; 2. BasicAuth uses username and password for Base64 encoding transmission, which is suitable for internal systems; 3. OAuth2 needs to obtain the token first through client_id and client_secret, and then bring the BearerToken in the request header; 4. In order to deal with the token expiration, the token management class can be encapsulated and automatically refreshed the token; in short, selecting the appropriate method according to the document and safely storing the key information is the key.

Python's magicmethods (or dunder methods) are special methods used to define the behavior of objects, which start and end with a double underscore. 1. They enable objects to respond to built-in operations, such as addition, comparison, string representation, etc.; 2. Common use cases include object initialization and representation (__init__, __repr__, __str__), arithmetic operations (__add__, __sub__, __mul__) and comparison operations (__eq__, ___lt__); 3. When using it, make sure that their behavior meets expectations. For example, __repr__ should return expressions of refactorable objects, and arithmetic methods should return new instances; 4. Overuse or confusing things should be avoided.

Python's garbage collection mechanism automatically manages memory through reference counting and periodic garbage collection. Its core method is reference counting, which immediately releases memory when the number of references of an object is zero; but it cannot handle circular references, so a garbage collection module (gc) is introduced to detect and clean the loop. Garbage collection is usually triggered when the reference count decreases during program operation, the allocation and release difference exceeds the threshold, or when gc.collect() is called manually. Users can turn off automatic recycling through gc.disable(), manually execute gc.collect(), and adjust thresholds to achieve control through gc.set_threshold(). Not all objects participate in loop recycling. If objects that do not contain references are processed by reference counting, it is built-in

Pythonmanagesmemoryautomaticallyusingreferencecountingandagarbagecollector.Referencecountingtrackshowmanyvariablesrefertoanobject,andwhenthecountreacheszero,thememoryisfreed.However,itcannothandlecircularreferences,wheretwoobjectsrefertoeachotherbuta
