Skip to content

Fix examples of enumerations and attrs in OEP-49 App Patterns: data.py #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ormsbee merged 1 commit into from
Apr 27, 2023
Merged

Fix examples of enumerations and attrs in OEP-49 App Patterns: data.py #471

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions oeps/best-practices/oep-0049-django-app-patterns.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,26 +203,17 @@ Example

from enum import Enum

import attr

def ProgramStatus(Enum):
from attrs import field, frozen, validators
class ProgramStatus(Enum):
ACTIVE = "active"
RETIRED = "retired"

@attr.attrs(frozen=True)
@frozen
class ProgramData:
uuid: str = attr.attrib(
validator=[attr.validators.instance_of(str)]
)
title: str = attr.attrib(
validator=[attr.validators.instance_of(str)]
)
status: str = attr.attrib(
validator=[
attr.validators.instance_of(str),
attr.validators.in_(ProgramStatus)
]
)
uuid: str = field(validator=validators.instance_of(str))
title: str = field(validator=validators.instance_of(str))
status: ProgramStatus = field(validator=validators.in_(ProgramStatus), converter=ProgramStatus)

.. _rest_api:

Expand Down Expand Up @@ -290,6 +281,11 @@ At this time, there is no plan to enforce any of these guidelines. The vast majo
Change History
**************

2023-04-26
==========

* In the section about data.py, fixed some broken examples of enum handling and converted to modern ``attrs`` syntax

2023-04-20
==========

Expand Down