Skip to content

templatepy.demo.dataclass_demo ⚓︎

This module demonstrates the use of dataclasses in Python.

CLASS DESCRIPTION
Address

A nested address dataclass example.

Profile

A more complex profile dataclass with nested dataclass.

User

A simple user dataclass example.

FUNCTION DESCRIPTION
create_sample_profile

Create a sample profile with nested dataclasses.

create_sample_user

Create a sample user for demonstration.

templatepy.demo.dataclass_demo.Address dataclass ⚓︎

Address(
    street: str, city: str, country: str, postal_code: str
)

A nested address dataclass example.

PARAMETER DESCRIPTION
street

Street address including house number

TYPE: str

city

City name

TYPE: str

country

Country name

TYPE: str

postal_code

Postal code

TYPE: str

templatepy.demo.dataclass_demo.Profile dataclass ⚓︎

Profile(
    user: User,
    address: Optional[Address] = None,
    bio: Optional[str] = None,
    followers: List[User] = list(),
)

A more complex profile dataclass with nested dataclass.

PARAMETER DESCRIPTION
user

User information

TYPE: User

address

User's address details

TYPE: Address | None DEFAULT: None

bio

User's biography

TYPE: str | None DEFAULT: None

followers

List of users following this profile

TYPE: List[User] DEFAULT: <dynamic>

templatepy.demo.dataclass_demo.User dataclass ⚓︎

User(
    name: str,
    email: str,
    age: int,
    created_at: datetime = now(),
    tags: List[str] = list(),
    is_active: bool = True,
)

A simple user dataclass example.

PARAMETER DESCRIPTION
name

User's full name

TYPE: str

email

User's email address

TYPE: str

age

User's age

TYPE: int

created_at

Timestamp when the user was created

TYPE: datetime DEFAULT: <dynamic>

tags

List of tags associated with the user

TYPE: List[str] DEFAULT: <dynamic>

is_active

Whether the user account is active

TYPE: bool DEFAULT: True

templatepy.demo.dataclass_demo.create_sample_profile ⚓︎

create_sample_profile() -> Profile

Create a sample profile with nested dataclasses.

templatepy.demo.dataclass_demo.create_sample_user ⚓︎

create_sample_user() -> User

Create a sample user for demonstration.