Add short docs for the unnamed mapping adapter type

juntyr · juntyr · commit 38d7a056bef4 · 2024-08-06T20:44:05.000Z
diff --git a/src/lib.rs b/src/lib.rs
@@ -46,5 +46,5 @@ pub use crate::de::{depythonize, Depythonizer};
 pub use crate::error::{PythonizeError, Result};
 pub use crate::ser::{
     pythonize, pythonize_custom, PythonizeDefault, PythonizeListType, PythonizeMappingType,
-    PythonizeNamedMappingType, PythonizeTypes, PythonizeUnnamedMappingWrapper, Pythonizer,
+    PythonizeNamedMappingType, PythonizeTypes, PythonizeUnnamedMappingAdapter, Pythonizer,
 };
diff --git a/src/ser.rs b/src/ser.rs
@@ -92,12 +92,19 @@ impl<'py> PythonizeMappingType<'py> for PyDict {
     }
 }
 
-pub struct PythonizeUnnamedMappingWrapper<'py, T: PythonizeMappingType<'py>> {
+/// Adapter type to use an unnamed mapping type, i.e. one that implements
+/// [`PythonizeMappingType`], as a named mapping type, i.e. one that implements
+/// [`PythonizeNamedMappingType`]. The adapter simply drops the provided name.
+///
+/// This adapter is commonly applied to use the same unnamed mapping type for
+/// both [`PythonizeTypes::Map`] and [`PythonizeTypes::NamedMap`] while only
+/// implementing [`PythonizeMappingType`].
+pub struct PythonizeUnnamedMappingAdapter<'py, T: PythonizeMappingType<'py>> {
     unnamed: T,
     _marker: PhantomData<&'py ()>,
 }
 
-impl<'py, T: PythonizeMappingType<'py>> PythonizeUnnamedMappingWrapper<'py, T> {
+impl<'py, T: PythonizeMappingType<'py>> PythonizeUnnamedMappingAdapter<'py, T> {
     #[must_use]
     pub fn new(unnamed: T) -> Self {
         Self {
@@ -112,14 +119,14 @@ impl<'py, T: PythonizeMappingType<'py>> PythonizeUnnamedMappingWrapper<'py, T> {
     }
 }
 
-impl<'py, T: PythonizeMappingType<'py>> From<T> for PythonizeUnnamedMappingWrapper<'py, T> {
+impl<'py, T: PythonizeMappingType<'py>> From<T> for PythonizeUnnamedMappingAdapter<'py, T> {
     fn from(value: T) -> Self {
         Self::new(value)
     }
 }
 
 impl<'py, T: PythonizeMappingType<'py>> PythonizeNamedMappingType<'py>
-    for PythonizeUnnamedMappingWrapper<'py, T>
+    for PythonizeUnnamedMappingAdapter<'py, T>
 {
     type Builder = <T as PythonizeMappingType<'py>>::Builder;
 
@@ -173,7 +180,7 @@ pub struct PythonizeDefault;
 
 impl<'py> PythonizeTypes<'py> for PythonizeDefault {
     type Map = PyDict;
-    type NamedMap = PythonizeUnnamedMappingWrapper<'py, PyDict>;
+    type NamedMap = PythonizeUnnamedMappingAdapter<'py, PyDict>;
     type List = PyList;
 }
 
diff --git a/tests/test_custom_types.rs b/tests/test_custom_types.rs
@@ -7,7 +7,7 @@ use pyo3::{
 };
 use pythonize::{
     depythonize, pythonize_custom, PythonizeListType, PythonizeMappingType, PythonizeTypes,
-    PythonizeUnnamedMappingWrapper, Pythonizer,
+    PythonizeUnnamedMappingAdapter, Pythonizer,
 };
 use serde::Serialize;
 use serde_json::{json, Value};
@@ -58,7 +58,7 @@ impl PythonizeListType for CustomList {
 struct PythonizeCustomList;
 impl<'py> PythonizeTypes<'py> for PythonizeCustomList {
     type Map = PyDict;
-    type NamedMap = PythonizeUnnamedMappingWrapper<'py, PyDict>;
+    type NamedMap = PythonizeUnnamedMappingAdapter<'py, PyDict>;
     type List = CustomList;
 }
 
@@ -133,7 +133,7 @@ impl<'py> PythonizeMappingType<'py> for CustomDict {
 struct PythonizeCustomDict;
 impl<'py> PythonizeTypes<'py> for PythonizeCustomDict {
     type Map = CustomDict;
-    type NamedMap = PythonizeUnnamedMappingWrapper<'py, CustomDict>;
+    type NamedMap = PythonizeUnnamedMappingAdapter<'py, CustomDict>;
     type List = PyTuple;
 }
 
diff --git a/tests/test_with_serde_path_to_err.rs b/tests/test_with_serde_path_to_err.rs
@@ -4,7 +4,7 @@ use pyo3::{
     prelude::*,
     types::{PyDict, PyList},
 };
-use pythonize::{PythonizeTypes, PythonizeUnnamedMappingWrapper};
+use pythonize::{PythonizeTypes, PythonizeUnnamedMappingAdapter};
 use serde::{Deserialize, Serialize};
 
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
@@ -15,7 +15,7 @@ struct Root<T> {
 
 impl<'py, T> PythonizeTypes<'py> for Root<T> {
     type Map = PyDict;
-    type NamedMap = PythonizeUnnamedMappingWrapper<'py, PyDict>;
+    type NamedMap = PythonizeUnnamedMappingAdapter<'py, PyDict>;
     type List = PyList;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -92,12 +92,19 @@ impl<'py> PythonizeMappingType<'py> for PyDict {`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`
`95`		`-pub struct PythonizeUnnamedMappingWrapper<'py, T: PythonizeMappingType<'py>> {`
	`95`	`+/// Adapter type to use an unnamed mapping type, i.e. one that implements`
	`96`	+/// [`PythonizeMappingType`], as a named mapping type, i.e. one that implements
	`97`	+/// [`PythonizeNamedMappingType`]. The adapter simply drops the provided name.
	`98`	`+///`
	`99`	`+/// This adapter is commonly applied to use the same unnamed mapping type for`
	`100`	+/// both [`PythonizeTypes::Map`] and [`PythonizeTypes::NamedMap`] while only
	`101`	+/// implementing [`PythonizeMappingType`].
	`102`	`+pub struct PythonizeUnnamedMappingAdapter<'py, T: PythonizeMappingType<'py>> {`
`96`	`103`	`unnamed: T,`
`97`	`104`	`_marker: PhantomData<&'py ()>,`
`98`	`105`	`}`
`99`	`106`
`100`		`-impl<'py, T: PythonizeMappingType<'py>> PythonizeUnnamedMappingWrapper<'py, T> {`
	`107`	`+impl<'py, T: PythonizeMappingType<'py>> PythonizeUnnamedMappingAdapter<'py, T> {`
`101`	`108`	`#[must_use]`
`102`	`109`	`pub fn new(unnamed: T) -> Self {`
`103`	`110`	`Self {`
`@@ -112,14 +119,14 @@ impl<'py, T: PythonizeMappingType<'py>> PythonizeUnnamedMappingWrapper<'py, T> {`
`112`	`119`	`}`
`113`	`120`	`}`
`114`	`121`
`115`		`-impl<'py, T: PythonizeMappingType<'py>> From<T> for PythonizeUnnamedMappingWrapper<'py, T> {`
	`122`	`+impl<'py, T: PythonizeMappingType<'py>> From<T> for PythonizeUnnamedMappingAdapter<'py, T> {`
`116`	`123`	`fn from(value: T) -> Self {`
`117`	`124`	`Self::new(value)`
`118`	`125`	`}`
`119`	`126`	`}`
`120`	`127`
`121`	`128`	`impl<'py, T: PythonizeMappingType<'py>> PythonizeNamedMappingType<'py>`
`122`		`- for PythonizeUnnamedMappingWrapper<'py, T>`
	`129`	`+ for PythonizeUnnamedMappingAdapter<'py, T>`
`123`	`130`	`{`
`124`	`131`	`type Builder = <T as PythonizeMappingType<'py>>::Builder;`
`125`	`132`
`@@ -173,7 +180,7 @@ pub struct PythonizeDefault;`
`173`	`180`
`174`	`181`	`impl<'py> PythonizeTypes<'py> for PythonizeDefault {`
`175`	`182`	`type Map = PyDict;`
`176`		`- type NamedMap = PythonizeUnnamedMappingWrapper<'py, PyDict>;`
	`183`	`+ type NamedMap = PythonizeUnnamedMappingAdapter<'py, PyDict>;`
`177`	`184`	`type List = PyList;`
`178`	`185`	`}`
`179`	`186`