Skip to content

simplify serialization filtering #578

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
merged 1 commit into from
May 4, 2023
Merged

simplify serialization filtering #578

Show file tree
Hide file tree
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
15 changes: 1 addition & 14 deletions src/serializers/filter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use std::hash::Hash;
use pyo3::exceptions::PyTypeError;
use pyo3::intern;
use pyo3::prelude::*;
use pyo3::types::{PyBool, PyDict, PySet, PyString};
use pyo3::types::{PyBool, PyDict, PySet};

use crate::build_tools::SchemaDict;

Expand Down Expand Up @@ -63,19 +63,6 @@ impl SchemaFilter<isize> {
Ok(Self { include, exclude })
}

pub fn from_vec_hash(py: Python, exclude: Vec<Py<PyString>>) -> PyResult<Self> {
let exclude = if exclude.is_empty() {
None
} else {
let mut set: AHashSet<isize> = AHashSet::with_capacity(exclude.len());
for item in exclude {
set.insert(item.as_ref(py).hash()?);
}
Some(set)
};
Ok(Self { include: None, exclude })
}

fn build_set_hashes(v: Option<&PyAny>) -> PyResult<Option<AHashSet<isize>>> {
match v {
Some(value) => {
Expand Down
14 changes: 6 additions & 8 deletions src/serializers/type_serializers/dataclass.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ use crate::build_tools::{py_error_type, SchemaDict};
use crate::definitions::DefinitionsBuilder;

use super::model::ModelSerializer;
use super::typed_dict::{TypedDictField, TypedDictSerializer};
use super::{BuildSerializer, CombinedSerializer, ComputedFields, SchemaFilter};
use super::typed_dict::{FieldSerializer, TypedDictSerializer};
use super::{BuildSerializer, CombinedSerializer, ComputedFields};

pub struct DataclassArgsBuilder;

Expand All @@ -24,8 +24,7 @@ impl BuildSerializer for DataclassArgsBuilder {
let py = schema.py();

let fields_list: &PyList = schema.get_as_req(intern!(py, "fields"))?;
let mut fields: AHashMap<String, TypedDictField> = AHashMap::with_capacity(fields_list.len());
let mut exclude: Vec<Py<PyString>> = Vec::with_capacity(fields_list.len());
let mut fields: AHashMap<String, FieldSerializer> = AHashMap::with_capacity(fields_list.len());

for (index, item) in fields_list.iter().enumerate() {
let field_info: &PyDict = item.downcast()?;
Expand All @@ -34,21 +33,20 @@ impl BuildSerializer for DataclassArgsBuilder {
let key_py: Py<PyString> = PyString::intern(py, &name).into_py(py);

if field_info.get_as(intern!(py, "serialization_exclude"))? == Some(true) {
exclude.push(key_py.clone_ref(py));
fields.insert(name, FieldSerializer::new(py, key_py, None, None, true));
} else {
let schema = field_info.get_as_req(intern!(py, "schema"))?;
let serializer = CombinedSerializer::build(schema, config, definitions)
.map_err(|e| py_error_type!("Field `{}`:\n {}", index, e))?;

let alias = field_info.get_as(intern!(py, "serialization_alias"))?;
fields.insert(name, TypedDictField::new(py, key_py, alias, serializer, true));
fields.insert(name, FieldSerializer::new(py, key_py, alias, Some(serializer), true));
}
}

let filter = SchemaFilter::from_vec_hash(py, exclude)?;
let computed_fields = ComputedFields::new(schema)?;

Ok(TypedDictSerializer::new(fields, false, filter, computed_fields).into())
Ok(TypedDictSerializer::new(fields, false, computed_fields).into())
}
}

Expand Down
13 changes: 5 additions & 8 deletions src/serializers/type_serializers/model.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ use crate::build_tools::{py_error_type, ExtraBehavior, SchemaDict};
use crate::definitions::DefinitionsBuilder;
use crate::serializers::computed_fields::ComputedFields;
use crate::serializers::extra::SerCheck;
use crate::serializers::filter::SchemaFilter;
use crate::serializers::infer::{infer_serialize, infer_to_python};
use crate::serializers::ob_type::ObType;
use crate::serializers::type_serializers::typed_dict::{TypedDictField, TypedDictSerializer};
use crate::serializers::type_serializers::typed_dict::{FieldSerializer, TypedDictSerializer};

use super::{
infer_json_key, infer_json_key_known, object_to_dict, py_err_se_err, BuildSerializer, CombinedSerializer, Extra,
Expand All @@ -38,8 +37,7 @@ impl BuildSerializer for ModelFieldsBuilder {
);

let fields_dict: &PyDict = schema.get_as_req(intern!(py, "fields"))?;
let mut fields: AHashMap<String, TypedDictField> = AHashMap::with_capacity(fields_dict.len());
let mut exclude: Vec<Py<PyString>> = Vec::with_capacity(fields_dict.len());
let mut fields: AHashMap<String, FieldSerializer> = AHashMap::with_capacity(fields_dict.len());

for (key, value) in fields_dict.iter() {
let key_py: &PyString = key.downcast()?;
Expand All @@ -49,22 +47,21 @@ impl BuildSerializer for ModelFieldsBuilder {
let key_py: Py<PyString> = key_py.into_py(py);

if field_info.get_as(intern!(py, "serialization_exclude"))? == Some(true) {
exclude.push(key_py.clone_ref(py));
fields.insert(key, FieldSerializer::new(py, key_py, None, None, true));
} else {
let alias: Option<String> = field_info.get_as(intern!(py, "serialization_alias"))?;

let schema = field_info.get_as_req(intern!(py, "schema"))?;
let serializer = CombinedSerializer::build(schema, config, definitions)
.map_err(|e| py_error_type!("Field `{}`:\n {}", key, e))?;

fields.insert(key, TypedDictField::new(py, key_py, alias, serializer, true));
fields.insert(key, FieldSerializer::new(py, key_py, alias, Some(serializer), true));
}
}

let filter = SchemaFilter::from_vec_hash(py, exclude)?;
let computed_fields = ComputedFields::new(schema)?;

Ok(TypedDictSerializer::new(fields, include_extra, filter, computed_fields).into())
Ok(TypedDictSerializer::new(fields, include_extra, computed_fields).into())
}
}

Expand Down
74 changes: 33 additions & 41 deletions src/serializers/type_serializers/typed_dict.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,23 @@ use super::{
ComputedFields, Extra, PydanticSerializer, SchemaFilter, SerializeInfer, TypeSerializer,
};

/// representation of a field for serialization, used by `TypedDictSerializer` and `ModelFieldsSerializer`
#[derive(Debug, Clone)]
pub(super) struct TypedDictField {
pub(super) struct FieldSerializer {
key_py: Py<PyString>,
alias: Option<String>,
alias_py: Option<Py<PyString>>,
serializer: CombinedSerializer,
// None serializer means exclude
serializer: Option<CombinedSerializer>,
required: bool,
}

impl TypedDictField {
impl FieldSerializer {
pub(super) fn new(
py: Python,
key_py: Py<PyString>,
alias: Option<String>,
serializer: CombinedSerializer,
serializer: Option<CombinedSerializer>,
required: bool,
) -> Self {
let alias_py = alias.as_ref().map(|alias| PyString::new(py, alias.as_str()).into());
Expand Down Expand Up @@ -64,10 +66,10 @@ impl TypedDictField {

#[derive(Debug, Clone)]
pub struct TypedDictSerializer {
fields: AHashMap<String, TypedDictField>,
fields: AHashMap<String, FieldSerializer>,
computed_fields: Option<ComputedFields>,
include_extra: bool,
// isize because we look up include exclude via `.hash()` which returns an isize
// isize because we look up filter via `.hash()` which returns an isize
filter: SchemaFilter<isize>,
}

Expand All @@ -90,56 +92,44 @@ impl BuildSerializer for TypedDictSerializer {
);

let fields_dict: &PyDict = schema.get_as_req(intern!(py, "fields"))?;
let mut fields: AHashMap<String, TypedDictField> = AHashMap::with_capacity(fields_dict.len());
let mut exclude: Vec<Py<PyString>> = Vec::with_capacity(fields_dict.len());
let mut fields: AHashMap<String, FieldSerializer> = AHashMap::with_capacity(fields_dict.len());

for (key, value) in fields_dict.iter() {
let key_py: &PyString = key.downcast()?;
let key: String = key_py.extract()?;
let field_info: &PyDict = value.downcast()?;

let key_py: Py<PyString> = key_py.into_py(py);
let required = field_info.get_as(intern!(py, "required"))?.unwrap_or(total);

if field_info.get_as(intern!(py, "serialization_exclude"))? == Some(true) {
exclude.push(key_py.clone_ref(py));
fields.insert(key, FieldSerializer::new(py, key_py, None, None, required));
} else {
let alias: Option<String> = field_info.get_as(intern!(py, "serialization_alias"))?;

let schema = field_info.get_as_req(intern!(py, "schema"))?;
let serializer = CombinedSerializer::build(schema, config, definitions)
.map_err(|e| py_error_type!("Field `{}`:\n {}", key, e))?;

fields.insert(
key,
TypedDictField::new(
py,
key_py,
alias,
serializer,
field_info.get_as(intern!(py, "required"))?.unwrap_or(total),
),
);
fields.insert(key, FieldSerializer::new(py, key_py, alias, Some(serializer), required));
}
}

let filter = SchemaFilter::from_vec_hash(py, exclude)?;
let computed_fields = ComputedFields::new(schema)?;

Ok(Self::new(fields, include_extra, filter, computed_fields).into())
Ok(Self::new(fields, include_extra, computed_fields).into())
}
}

impl TypedDictSerializer {
pub(super) fn new(
fields: AHashMap<String, TypedDictField>,
fields: AHashMap<String, FieldSerializer>,
include_extra: bool,
filter: SchemaFilter<isize>,
computed_fields: Option<ComputedFields>,
) -> Self {
Self {
fields,
include_extra,
filter,
filter: SchemaFilter::default(),
computed_fields,
}
}
Expand All @@ -151,9 +141,9 @@ impl TypedDictSerializer {
}
}

fn exclude_default(&self, value: &PyAny, extra: &Extra, field: &TypedDictField) -> PyResult<bool> {
fn exclude_default(&self, value: &PyAny, extra: &Extra, serializer: &CombinedSerializer) -> PyResult<bool> {
if extra.exclude_defaults {
if let Some(default) = field.serializer.get_default(value.py())? {
if let Some(default) = serializer.get_default(value.py())? {
if value.eq(default)? {
return Ok(true);
}
Expand Down Expand Up @@ -190,21 +180,25 @@ impl TypeSerializer for TypedDictSerializer {
};

for (key, value) in py_dict {
let extra = Extra {
field_name: Some(key.extract()?),
..td_extra
};
if extra.exclude_none && value.is_none() {
continue;
}
if let Some((next_include, next_exclude)) = self.filter.key_filter(key, include, exclude)? {
let extra = Extra {
field_name: Some(key.extract()?),
..td_extra
};
if let Ok(key_py_str) = key.downcast::<PyString>() {
let key_str = key_py_str.to_str()?;
if let Some(field) = self.fields.get(key_str) {
if self.exclude_default(value, &extra, field)? {
let serializer = match field.serializer {
Some(ref serializer) => serializer,
None => continue,
};
if self.exclude_default(value, &extra, serializer)? {
continue;
}
let value = field.serializer.to_python(value, next_include, next_exclude, &extra)?;
let value = serializer.to_python(value, next_include, next_exclude, &extra)?;
let output_key = field.get_key_py(py, &extra);
output_dict.set_item(output_key, value)?;

Expand Down Expand Up @@ -289,17 +283,15 @@ impl TypeSerializer for TypedDictSerializer {
if let Ok(key_py_str) = key.downcast::<PyString>() {
let key_str = key_py_str.to_str().map_err(py_err_se_err)?;
if let Some(field) = self.fields.get(key_str) {
if self.exclude_default(value, &extra, field).map_err(py_err_se_err)? {
let serializer = match field.serializer {
Some(ref serializer) => serializer,
None => continue,
};
if self.exclude_default(value, &extra, serializer).map_err(py_err_se_err)? {
continue;
}
let output_key = field.get_key_json(key_str, &extra);
let s = PydanticSerializer::new(
value,
&field.serializer,
next_include,
next_exclude,
&extra,
);
let s = PydanticSerializer::new(value, serializer, next_include, next_exclude, &extra);
map.serialize_entry(&output_key, &s)?;
continue;
}
Expand Down
Loading