1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
|
"""Test utilities and fixtures."""
import datetime as dt
import functools
import uuid
from enum import Enum, IntEnum
from zoneinfo import ZoneInfo
import simplejson
from marshmallow import Schema, fields, missing, post_load, validate
from marshmallow.exceptions import ValidationError
central = ZoneInfo("America/Chicago")
class GenderEnum(IntEnum):
male = 1
female = 2
non_binary = 3
class HairColorEnum(Enum):
black = "black hair"
brown = "brown hair"
blond = "blond hair"
red = "red hair"
class DateEnum(Enum):
date_1 = dt.date(2004, 2, 29)
date_2 = dt.date(2008, 2, 29)
date_3 = dt.date(2012, 2, 29)
ALL_FIELDS = [
fields.String,
fields.Integer,
fields.Boolean,
fields.Float,
fields.DateTime,
fields.Time,
fields.Date,
fields.TimeDelta,
fields.Dict,
fields.Url,
fields.Email,
fields.UUID,
fields.Decimal,
fields.IP,
fields.IPv4,
fields.IPv6,
fields.IPInterface,
fields.IPv4Interface,
fields.IPv6Interface,
functools.partial(fields.Enum, GenderEnum),
functools.partial(fields.Enum, HairColorEnum, by_value=fields.String),
functools.partial(fields.Enum, GenderEnum, by_value=fields.Integer),
]
##### Custom asserts #####
def assert_date_equal(d1, d2):
assert d1.year == d2.year
assert d1.month == d2.month
assert d1.day == d2.day
def assert_time_equal(t1, t2):
assert t1.hour == t2.hour
assert t1.minute == t2.minute
assert t1.second == t2.second
assert t1.microsecond == t2.microsecond
##### Models #####
class User:
SPECIES = "Homo sapiens"
def __init__(
self,
name,
*,
age=0,
id_=None,
homepage=None,
email=None,
registered=True,
time_registered=None,
birthdate=None,
birthtime=None,
balance=100,
sex=GenderEnum.male,
hair_color=HairColorEnum.black,
employer=None,
various_data=None,
):
self.name = name
self.age = age
# A naive datetime
self.created = dt.datetime(2013, 11, 10, 14, 20, 58)
# A TZ-aware datetime
self.updated = dt.datetime(2013, 11, 10, 14, 20, 58, tzinfo=central)
self.id = id_
self.homepage = homepage
self.email = email
self.balance = balance
self.registered = registered
self.hair_colors = list(HairColorEnum.__members__)
self.sex_choices = list(GenderEnum.__members__)
self.finger_count = 10
self.uid = uuid.uuid1()
self.time_registered = time_registered or dt.time(1, 23, 45, 6789)
self.birthdate = birthdate or dt.date(2013, 1, 23)
self.birthtime = birthtime or dt.time(0, 1, 2, 3333)
self.activation_date = dt.date(2013, 12, 11)
self.sex = sex
self.hair_color = hair_color
self.employer = employer
self.relatives = []
self.various_data = various_data or {
"pets": ["cat", "dog"],
"address": "1600 Pennsylvania Ave\nWashington, DC 20006",
}
@property
def since_created(self):
return dt.datetime(2013, 11, 24) - self.created
def __repr__(self):
return f"<User {self.name}>"
class Blog:
def __init__(self, title, user, collaborators=None, categories=None, id_=None):
self.title = title
self.user = user
self.collaborators = collaborators or [] # List/tuple of users
self.categories = categories
self.id = id_
def __contains__(self, item):
return item.name in [each.name for each in self.collaborators]
class DummyModel:
def __init__(self, foo):
self.foo = foo
def __eq__(self, other):
return self.foo == other.foo
def __str__(self):
return f"bar {self.foo}"
###### Schemas #####
class Uppercased(fields.Field):
"""Custom field formatting example."""
def _serialize(self, value, attr, obj):
if value:
return value.upper()
return None
def get_lowername(obj):
if obj is None:
return missing
if isinstance(obj, dict):
return obj.get("name").lower()
return obj.name.lower()
class UserSchema(Schema):
name = fields.String()
age: fields.Field = fields.Float()
created = fields.DateTime()
created_formatted = fields.DateTime(
format="%Y-%m-%d", attribute="created", dump_only=True
)
created_iso = fields.DateTime(format="iso", attribute="created", dump_only=True)
updated = fields.DateTime()
species = fields.String(attribute="SPECIES")
id = fields.String(dump_default="no-id")
uppername = Uppercased(attribute="name", dump_only=True)
homepage = fields.Url()
email = fields.Email()
balance = fields.Decimal()
is_old: fields.Field = fields.Method("get_is_old")
lowername = fields.Function(get_lowername)
registered = fields.Boolean()
hair_colors = fields.List(fields.Raw)
sex_choices = fields.List(fields.Raw)
finger_count = fields.Integer()
uid = fields.UUID()
time_registered = fields.Time()
birthdate = fields.Date()
birthtime = fields.Time()
activation_date = fields.Date()
since_created = fields.TimeDelta()
sex = fields.Str(validate=validate.OneOf(list(GenderEnum.__members__)))
various_data = fields.Dict()
class Meta:
render_module = simplejson
def get_is_old(self, obj):
if obj is None:
return missing
if isinstance(obj, dict):
age = obj.get("age")
else:
age = obj.age
try:
return age > 80
except TypeError as te:
raise ValidationError(str(te)) from te
@post_load
def make_user(self, data, **kwargs):
return User(**data)
class UserMetaSchema(Schema):
"""The equivalent of the UserSchema, using the ``fields`` option."""
uppername = Uppercased(attribute="name", dump_only=True)
balance = fields.Decimal()
is_old = fields.Method("get_is_old")
lowername = fields.Function(get_lowername)
species = fields.String(attribute="SPECIES")
homepage = fields.Url()
email = fields.Email()
various_data = fields.Dict()
def get_is_old(self, obj):
if obj is None:
return missing
if isinstance(obj, dict):
age = obj.get("age")
else:
age = obj.age
try:
return age > 80
except TypeError as te:
raise ValidationError(str(te)) from te
class Meta:
fields = (
"name",
"age",
"created",
"updated",
"id",
"homepage",
"uppername",
"email",
"balance",
"is_old",
"lowername",
"species",
"registered",
"hair_colors",
"sex_choices",
"finger_count",
"uid",
"time_registered",
"birthdate",
"birthtime",
"since_created",
"various_data",
)
class UserExcludeSchema(UserSchema):
class Meta:
exclude = ("created", "updated")
class UserAdditionalSchema(Schema):
lowername = fields.Function(lambda obj: obj.name.lower())
class Meta:
additional = ("name", "age", "created", "email")
class UserIntSchema(UserSchema):
age = fields.Integer()
class UserFloatStringSchema(UserSchema):
age = fields.Float(as_string=True)
class ExtendedUserSchema(UserSchema):
is_old = fields.Boolean()
class UserRelativeUrlSchema(UserSchema):
homepage = fields.Url(relative=True)
class BlogSchema(Schema):
title = fields.String()
user = fields.Nested(UserSchema)
collaborators = fields.List(fields.Nested(UserSchema()))
categories = fields.List(fields.String)
id = fields.String()
class BlogUserMetaSchema(Schema):
user = fields.Nested(UserMetaSchema())
collaborators = fields.List(fields.Nested(UserMetaSchema()))
class BlogSchemaMeta(Schema):
"""Same as BlogSerializer but using ``fields`` options."""
user = fields.Nested(UserSchema)
collaborators = fields.List(fields.Nested(UserSchema()))
class Meta:
fields = ("title", "user", "collaborators", "categories", "id")
class BlogOnlySchema(Schema):
title = fields.String()
user = fields.Nested(UserSchema)
collaborators = fields.List(fields.Nested(UserSchema(only=("id",))))
class BlogSchemaExclude(BlogSchema):
user = fields.Nested(UserSchema, exclude=("uppername", "species"))
class BlogSchemaOnlyExclude(BlogSchema):
user = fields.Nested(UserSchema, only=("name",), exclude=("name", "species"))
class mockjson: # noqa: N801
@staticmethod
def dumps(val):
return b"{'foo': 42}"
@staticmethod
def loads(val):
return {"foo": 42}
|