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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
|
%global _empty_manifest_terminate_build 0
Name: python-marshy
Version: 4.0.3
Release: 1
Summary: A convention over configuration approach to object marshalling.
License: MIT License
URL: https://github.com/tofarr/marshy
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/0a/ff/2a578cdd0811414709b46d16f3bd9d4cd98474a48d2393b2f4c9ac878249/marshy-4.0.3.tar.gz
BuildArch: noarch
Requires: python3-typing-inspect
Requires: python3-black
Requires: python3-marshmallow-dataclass
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-pytest-xdist
Requires: python3-pylint
%description
# Marshy - Better Marshalling for Python.
This project is a general purpose externalizer for python objects.
(Like Marshmallow or Pedantic) The guiding philosophy is convention
over configuration, with the aim of still making customizations as
pain free as possible, based on python type hints.
Out of the box, it supports primitives, dataclasses, and enums.
## Installation
`pip install marshy`
## General Usage
Given the following dataclass:
```
from typing import List, Optional
import dataclasses
@dataclasses.dataclass
class Doohickey:
title: str
description: Optional[str] = None
tags: List[str] = dataclasses.field(default_factory=list)
```
Marshall data with:
```
import marshy
result = marshy.dump(Doohickey('Thingy', tags=['a','b']))
# result == dict(title='Thingy', description=None, tags=['a','b'])
```
Unmarshall data with:
```
result = marshy.load(Doohickey, dict(title='Thingy'))
# result == Doohickey('Thingy', description=None, tags=[])
```
## Custom properties
Custom properties are also serialized by default. (If they
have a setter, it is used when loading):
```
@dataclass
class Factorial:
value: int
@property
def factorial(self) -> int:
return reduce(lambda a, b: a*b, range(1, self.value+1))
factorial = Factorial(4)
dumped = dump(factorial)
# dumped == dict(value=4, factorial=24)
loaded = load(Factorial, dumped)
# loaded == factorial
```
## Under The Hood
Internally, API defines 3 core concepts:
* A [Marshaller](marshy/marshaller/marshaller_abc.py): Is
responsible for marshalling / unmarshalling a single type of
object.
* A [MarshallerFactory](marshy/factory/marshaller_factory_abc.py): has
a `create` method used to create marshallers for types, and has
a priority which controls the order in which they are run.
(higher first)
* A [MarshallerContext](marshy/marshaller_context.py): coordinates
the activities of Marshallers and Factories
## Creating a Custom Marshaller Context
If you need multiple independent sets of rules for
marshalling data, then you should create your own marshalling
contexts and store references to them. The default works well
otherwise:
```
# Dump a Doohickey using the default context (Same as marshy.dump...)
from marshy import get_default_context
dumped = get_default_context().dump(Doohickey('Thingy'))
# Create a new blank marshaller context - this will fail
# because there are no preset types or factories.
from marshy.marshaller_context import MarshallerContext
my_marshaller_context = MarshallerContext()
dumped = my_marshaller_context.dump(Doohickey('Thingy'))
# Create a new marshaller context which copies the default rules.
from marshy.default_context import new_default_context
my_default_context = new_default_context()
dumped = my_default_context.dump(Doohickey('Thingy'))
```
## Creating a Custom Marshaller
To customize marshalling for a type, write a marshaller and then
register it with your context:
```
from marshy.marshaller.marshaller_abc import MarshallerABC
from marshy.types import ExternalType
class MyDoohickeyMarshaller(MarshallerABC[Doohickey]):
def __init__(self):
super().__init__(Doohickey)
def load(self, item: ExternalType) -> Doohickey:
return Doohickey(item[0], item[1], item[2])
def dump(self, item: Doohickey) -> ExternalType:
return [item.title, item.description, item.tags]
my_default_context.register_marshaller(MyDoohickeyMarshaller())
dumped = my_default_context.dump(Doohickey('Thingy'))
# dumped == ['Thingy', None, []]
loaded = my_default_context.load(Doohickey, dumped)
# dumped == Doohickey('Thingy')
```
## Creating a Custom Marshaller Factory
Sometimes you need to create a marshaller for a while concept of
object rather than a single type - In this case you need a factory,
(this is how the default rules work!). Examples:
* [ListMarshallerFactory](marshy/factory/list_marshaller_factory.py)
looks for typed lists (e.g.,: List[str]) and creates marshallers
for them - you already saw the results in `Doohickey.tags` above.
* [OptionalMarshallerFactory](marshy/factory/optional_marshaller_factory.py)
looks for optional fields (e.g.,: Optional[str]) and creates
marshallers that mean each individual other marshaller does not
need to accommodate the case where a value is None - just mark
it optional!
* [DataClassMarshallerFactory](marshy/factory/dataclass_marshaller_factory.py)
provides a marshaller for dataclasses assuming they have a standard
constructor based on their fields.
## Customizing dataclass attributes:
Taking the doohickey example:
```
from marshy import dump, get_default_context
from marshy.marshaller import str_marshaller, bool_marshaller
from marshy.marshaller.obj_marshaller import ObjMarshaller
attr_marshallers = dict(title=str_marshaller, tags=bool_marshaller)
get_default_context().register_marshaller(ObjMarshaller(Doohickey, attr_marshallers, False))
dumped = dump(Doohickey('Thingy'))
# dumped == dict(title='Thingy', tags=False)
```
## Customizing dataclass marshalling
As an alternative to defining a custom marshaller / factory, it is possible to simply
define a __marshaller_factory__ class method. (Note: this becomes the default for all
contexts) Imagine a case where you have a dataclass representing a 2D point, which you
want to be marshalled in the format [x, y] (An array rather than the standard object):
```
from dataclasses import dataclass
from marshy.marshaller.marshaller_abc import MarshallerABC
from marshy import load, dump
@dataclass
class Point:
x: float
y: float
@classmethod
def __marshaller_factory__(cls, marshaller_context):
return PointMarshaller()
class PointMarshaller(MarshallerABC):
def __init__(self):
super().__init__(Point)
def load(self, item):
return Point(item[0], item[1])
def dump(self, item):
return [item.x, item.y]
dumped = dump(Point(1.2, 3.4))
loaded = load(Point, dumped)
```
## Circular References
Due to the fact that types in the object graph can self reference,
we defer resolution of most marshaller until as late as possible.
[DeferredMarshaller](marshy/marshaller/deferred_marshaller.py)
is responsible for this, and means types can
[self reference](test/test_marshall_deferred.py).
Circular references within objects will still cause an error.
(Unless you decide on an error handling protocol for this an
implement a custom Factory to deal with it!)
## Customizing the default context
The project uses the namespace convention `marshy_config_` to identity configuration packages.
(https://packaging.python.org/guides/creating-and-discovering-plugins/). Configuration packages should have an integer
priority attribute, and a `def configure(context: MarshallerContext)` function. e.g.:
[default_config](marshy_config_default/__init__.py)
## Adding Polymorphic Implementations
Taking the following polymorphic classes where `Pet` has implementations `Cat` and `Dog`:
```
from abc import ABC, abstractmethod
from dataclasses import dataclass
@dataclass
class PetAbc(ABC):
name: str
@abstractmethod
def vocalize(self) -> str:
""" What sound does this make? """
class Cat(PetAbc):
def vocalize(self):
return "Meow!"
class Dog(PetAbc):
def vocalize(self) -> str:
return "Woof!"
```
In order to deserialize a Pet, marshy needs to be informed tha the implementations exist. This can be done at any point
in the configuration:
```
from marshy import load
from marshy.factory.impl_marshaller_factory import register_impl
register_impl(PetAbc, Cat)
register_impl(PetAbc, Dog)
pet = ['Cat', dict(name='Felix')]
loaded = load(PetAbc, pet)
```
[Tests for this are here] (test/test_impl_marshaller.py)
## Performance Tests
Basic Tests show performance is approximate with marshmallow:
```
python -m timeit -s "
from test.performance.marshy_performance import run
run(1000)
"
```
```
python -m timeit -s "
from test.performance.marshmallow_performance import run
run(1000)
"
```
## Release Proceedure

The typical process here is:
* Create a PR with changes. Merge these to main (The `Quality` workflows make sure that your PR
meets the styling, linting, and code coverage standards).
* New releases created in github are automatically uploaded to pypi
%package -n python3-marshy
Summary: A convention over configuration approach to object marshalling.
Provides: python-marshy
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-marshy
# Marshy - Better Marshalling for Python.
This project is a general purpose externalizer for python objects.
(Like Marshmallow or Pedantic) The guiding philosophy is convention
over configuration, with the aim of still making customizations as
pain free as possible, based on python type hints.
Out of the box, it supports primitives, dataclasses, and enums.
## Installation
`pip install marshy`
## General Usage
Given the following dataclass:
```
from typing import List, Optional
import dataclasses
@dataclasses.dataclass
class Doohickey:
title: str
description: Optional[str] = None
tags: List[str] = dataclasses.field(default_factory=list)
```
Marshall data with:
```
import marshy
result = marshy.dump(Doohickey('Thingy', tags=['a','b']))
# result == dict(title='Thingy', description=None, tags=['a','b'])
```
Unmarshall data with:
```
result = marshy.load(Doohickey, dict(title='Thingy'))
# result == Doohickey('Thingy', description=None, tags=[])
```
## Custom properties
Custom properties are also serialized by default. (If they
have a setter, it is used when loading):
```
@dataclass
class Factorial:
value: int
@property
def factorial(self) -> int:
return reduce(lambda a, b: a*b, range(1, self.value+1))
factorial = Factorial(4)
dumped = dump(factorial)
# dumped == dict(value=4, factorial=24)
loaded = load(Factorial, dumped)
# loaded == factorial
```
## Under The Hood
Internally, API defines 3 core concepts:
* A [Marshaller](marshy/marshaller/marshaller_abc.py): Is
responsible for marshalling / unmarshalling a single type of
object.
* A [MarshallerFactory](marshy/factory/marshaller_factory_abc.py): has
a `create` method used to create marshallers for types, and has
a priority which controls the order in which they are run.
(higher first)
* A [MarshallerContext](marshy/marshaller_context.py): coordinates
the activities of Marshallers and Factories
## Creating a Custom Marshaller Context
If you need multiple independent sets of rules for
marshalling data, then you should create your own marshalling
contexts and store references to them. The default works well
otherwise:
```
# Dump a Doohickey using the default context (Same as marshy.dump...)
from marshy import get_default_context
dumped = get_default_context().dump(Doohickey('Thingy'))
# Create a new blank marshaller context - this will fail
# because there are no preset types or factories.
from marshy.marshaller_context import MarshallerContext
my_marshaller_context = MarshallerContext()
dumped = my_marshaller_context.dump(Doohickey('Thingy'))
# Create a new marshaller context which copies the default rules.
from marshy.default_context import new_default_context
my_default_context = new_default_context()
dumped = my_default_context.dump(Doohickey('Thingy'))
```
## Creating a Custom Marshaller
To customize marshalling for a type, write a marshaller and then
register it with your context:
```
from marshy.marshaller.marshaller_abc import MarshallerABC
from marshy.types import ExternalType
class MyDoohickeyMarshaller(MarshallerABC[Doohickey]):
def __init__(self):
super().__init__(Doohickey)
def load(self, item: ExternalType) -> Doohickey:
return Doohickey(item[0], item[1], item[2])
def dump(self, item: Doohickey) -> ExternalType:
return [item.title, item.description, item.tags]
my_default_context.register_marshaller(MyDoohickeyMarshaller())
dumped = my_default_context.dump(Doohickey('Thingy'))
# dumped == ['Thingy', None, []]
loaded = my_default_context.load(Doohickey, dumped)
# dumped == Doohickey('Thingy')
```
## Creating a Custom Marshaller Factory
Sometimes you need to create a marshaller for a while concept of
object rather than a single type - In this case you need a factory,
(this is how the default rules work!). Examples:
* [ListMarshallerFactory](marshy/factory/list_marshaller_factory.py)
looks for typed lists (e.g.,: List[str]) and creates marshallers
for them - you already saw the results in `Doohickey.tags` above.
* [OptionalMarshallerFactory](marshy/factory/optional_marshaller_factory.py)
looks for optional fields (e.g.,: Optional[str]) and creates
marshallers that mean each individual other marshaller does not
need to accommodate the case where a value is None - just mark
it optional!
* [DataClassMarshallerFactory](marshy/factory/dataclass_marshaller_factory.py)
provides a marshaller for dataclasses assuming they have a standard
constructor based on their fields.
## Customizing dataclass attributes:
Taking the doohickey example:
```
from marshy import dump, get_default_context
from marshy.marshaller import str_marshaller, bool_marshaller
from marshy.marshaller.obj_marshaller import ObjMarshaller
attr_marshallers = dict(title=str_marshaller, tags=bool_marshaller)
get_default_context().register_marshaller(ObjMarshaller(Doohickey, attr_marshallers, False))
dumped = dump(Doohickey('Thingy'))
# dumped == dict(title='Thingy', tags=False)
```
## Customizing dataclass marshalling
As an alternative to defining a custom marshaller / factory, it is possible to simply
define a __marshaller_factory__ class method. (Note: this becomes the default for all
contexts) Imagine a case where you have a dataclass representing a 2D point, which you
want to be marshalled in the format [x, y] (An array rather than the standard object):
```
from dataclasses import dataclass
from marshy.marshaller.marshaller_abc import MarshallerABC
from marshy import load, dump
@dataclass
class Point:
x: float
y: float
@classmethod
def __marshaller_factory__(cls, marshaller_context):
return PointMarshaller()
class PointMarshaller(MarshallerABC):
def __init__(self):
super().__init__(Point)
def load(self, item):
return Point(item[0], item[1])
def dump(self, item):
return [item.x, item.y]
dumped = dump(Point(1.2, 3.4))
loaded = load(Point, dumped)
```
## Circular References
Due to the fact that types in the object graph can self reference,
we defer resolution of most marshaller until as late as possible.
[DeferredMarshaller](marshy/marshaller/deferred_marshaller.py)
is responsible for this, and means types can
[self reference](test/test_marshall_deferred.py).
Circular references within objects will still cause an error.
(Unless you decide on an error handling protocol for this an
implement a custom Factory to deal with it!)
## Customizing the default context
The project uses the namespace convention `marshy_config_` to identity configuration packages.
(https://packaging.python.org/guides/creating-and-discovering-plugins/). Configuration packages should have an integer
priority attribute, and a `def configure(context: MarshallerContext)` function. e.g.:
[default_config](marshy_config_default/__init__.py)
## Adding Polymorphic Implementations
Taking the following polymorphic classes where `Pet` has implementations `Cat` and `Dog`:
```
from abc import ABC, abstractmethod
from dataclasses import dataclass
@dataclass
class PetAbc(ABC):
name: str
@abstractmethod
def vocalize(self) -> str:
""" What sound does this make? """
class Cat(PetAbc):
def vocalize(self):
return "Meow!"
class Dog(PetAbc):
def vocalize(self) -> str:
return "Woof!"
```
In order to deserialize a Pet, marshy needs to be informed tha the implementations exist. This can be done at any point
in the configuration:
```
from marshy import load
from marshy.factory.impl_marshaller_factory import register_impl
register_impl(PetAbc, Cat)
register_impl(PetAbc, Dog)
pet = ['Cat', dict(name='Felix')]
loaded = load(PetAbc, pet)
```
[Tests for this are here] (test/test_impl_marshaller.py)
## Performance Tests
Basic Tests show performance is approximate with marshmallow:
```
python -m timeit -s "
from test.performance.marshy_performance import run
run(1000)
"
```
```
python -m timeit -s "
from test.performance.marshmallow_performance import run
run(1000)
"
```
## Release Proceedure

The typical process here is:
* Create a PR with changes. Merge these to main (The `Quality` workflows make sure that your PR
meets the styling, linting, and code coverage standards).
* New releases created in github are automatically uploaded to pypi
%package help
Summary: Development documents and examples for marshy
Provides: python3-marshy-doc
%description help
# Marshy - Better Marshalling for Python.
This project is a general purpose externalizer for python objects.
(Like Marshmallow or Pedantic) The guiding philosophy is convention
over configuration, with the aim of still making customizations as
pain free as possible, based on python type hints.
Out of the box, it supports primitives, dataclasses, and enums.
## Installation
`pip install marshy`
## General Usage
Given the following dataclass:
```
from typing import List, Optional
import dataclasses
@dataclasses.dataclass
class Doohickey:
title: str
description: Optional[str] = None
tags: List[str] = dataclasses.field(default_factory=list)
```
Marshall data with:
```
import marshy
result = marshy.dump(Doohickey('Thingy', tags=['a','b']))
# result == dict(title='Thingy', description=None, tags=['a','b'])
```
Unmarshall data with:
```
result = marshy.load(Doohickey, dict(title='Thingy'))
# result == Doohickey('Thingy', description=None, tags=[])
```
## Custom properties
Custom properties are also serialized by default. (If they
have a setter, it is used when loading):
```
@dataclass
class Factorial:
value: int
@property
def factorial(self) -> int:
return reduce(lambda a, b: a*b, range(1, self.value+1))
factorial = Factorial(4)
dumped = dump(factorial)
# dumped == dict(value=4, factorial=24)
loaded = load(Factorial, dumped)
# loaded == factorial
```
## Under The Hood
Internally, API defines 3 core concepts:
* A [Marshaller](marshy/marshaller/marshaller_abc.py): Is
responsible for marshalling / unmarshalling a single type of
object.
* A [MarshallerFactory](marshy/factory/marshaller_factory_abc.py): has
a `create` method used to create marshallers for types, and has
a priority which controls the order in which they are run.
(higher first)
* A [MarshallerContext](marshy/marshaller_context.py): coordinates
the activities of Marshallers and Factories
## Creating a Custom Marshaller Context
If you need multiple independent sets of rules for
marshalling data, then you should create your own marshalling
contexts and store references to them. The default works well
otherwise:
```
# Dump a Doohickey using the default context (Same as marshy.dump...)
from marshy import get_default_context
dumped = get_default_context().dump(Doohickey('Thingy'))
# Create a new blank marshaller context - this will fail
# because there are no preset types or factories.
from marshy.marshaller_context import MarshallerContext
my_marshaller_context = MarshallerContext()
dumped = my_marshaller_context.dump(Doohickey('Thingy'))
# Create a new marshaller context which copies the default rules.
from marshy.default_context import new_default_context
my_default_context = new_default_context()
dumped = my_default_context.dump(Doohickey('Thingy'))
```
## Creating a Custom Marshaller
To customize marshalling for a type, write a marshaller and then
register it with your context:
```
from marshy.marshaller.marshaller_abc import MarshallerABC
from marshy.types import ExternalType
class MyDoohickeyMarshaller(MarshallerABC[Doohickey]):
def __init__(self):
super().__init__(Doohickey)
def load(self, item: ExternalType) -> Doohickey:
return Doohickey(item[0], item[1], item[2])
def dump(self, item: Doohickey) -> ExternalType:
return [item.title, item.description, item.tags]
my_default_context.register_marshaller(MyDoohickeyMarshaller())
dumped = my_default_context.dump(Doohickey('Thingy'))
# dumped == ['Thingy', None, []]
loaded = my_default_context.load(Doohickey, dumped)
# dumped == Doohickey('Thingy')
```
## Creating a Custom Marshaller Factory
Sometimes you need to create a marshaller for a while concept of
object rather than a single type - In this case you need a factory,
(this is how the default rules work!). Examples:
* [ListMarshallerFactory](marshy/factory/list_marshaller_factory.py)
looks for typed lists (e.g.,: List[str]) and creates marshallers
for them - you already saw the results in `Doohickey.tags` above.
* [OptionalMarshallerFactory](marshy/factory/optional_marshaller_factory.py)
looks for optional fields (e.g.,: Optional[str]) and creates
marshallers that mean each individual other marshaller does not
need to accommodate the case where a value is None - just mark
it optional!
* [DataClassMarshallerFactory](marshy/factory/dataclass_marshaller_factory.py)
provides a marshaller for dataclasses assuming they have a standard
constructor based on their fields.
## Customizing dataclass attributes:
Taking the doohickey example:
```
from marshy import dump, get_default_context
from marshy.marshaller import str_marshaller, bool_marshaller
from marshy.marshaller.obj_marshaller import ObjMarshaller
attr_marshallers = dict(title=str_marshaller, tags=bool_marshaller)
get_default_context().register_marshaller(ObjMarshaller(Doohickey, attr_marshallers, False))
dumped = dump(Doohickey('Thingy'))
# dumped == dict(title='Thingy', tags=False)
```
## Customizing dataclass marshalling
As an alternative to defining a custom marshaller / factory, it is possible to simply
define a __marshaller_factory__ class method. (Note: this becomes the default for all
contexts) Imagine a case where you have a dataclass representing a 2D point, which you
want to be marshalled in the format [x, y] (An array rather than the standard object):
```
from dataclasses import dataclass
from marshy.marshaller.marshaller_abc import MarshallerABC
from marshy import load, dump
@dataclass
class Point:
x: float
y: float
@classmethod
def __marshaller_factory__(cls, marshaller_context):
return PointMarshaller()
class PointMarshaller(MarshallerABC):
def __init__(self):
super().__init__(Point)
def load(self, item):
return Point(item[0], item[1])
def dump(self, item):
return [item.x, item.y]
dumped = dump(Point(1.2, 3.4))
loaded = load(Point, dumped)
```
## Circular References
Due to the fact that types in the object graph can self reference,
we defer resolution of most marshaller until as late as possible.
[DeferredMarshaller](marshy/marshaller/deferred_marshaller.py)
is responsible for this, and means types can
[self reference](test/test_marshall_deferred.py).
Circular references within objects will still cause an error.
(Unless you decide on an error handling protocol for this an
implement a custom Factory to deal with it!)
## Customizing the default context
The project uses the namespace convention `marshy_config_` to identity configuration packages.
(https://packaging.python.org/guides/creating-and-discovering-plugins/). Configuration packages should have an integer
priority attribute, and a `def configure(context: MarshallerContext)` function. e.g.:
[default_config](marshy_config_default/__init__.py)
## Adding Polymorphic Implementations
Taking the following polymorphic classes where `Pet` has implementations `Cat` and `Dog`:
```
from abc import ABC, abstractmethod
from dataclasses import dataclass
@dataclass
class PetAbc(ABC):
name: str
@abstractmethod
def vocalize(self) -> str:
""" What sound does this make? """
class Cat(PetAbc):
def vocalize(self):
return "Meow!"
class Dog(PetAbc):
def vocalize(self) -> str:
return "Woof!"
```
In order to deserialize a Pet, marshy needs to be informed tha the implementations exist. This can be done at any point
in the configuration:
```
from marshy import load
from marshy.factory.impl_marshaller_factory import register_impl
register_impl(PetAbc, Cat)
register_impl(PetAbc, Dog)
pet = ['Cat', dict(name='Felix')]
loaded = load(PetAbc, pet)
```
[Tests for this are here] (test/test_impl_marshaller.py)
## Performance Tests
Basic Tests show performance is approximate with marshmallow:
```
python -m timeit -s "
from test.performance.marshy_performance import run
run(1000)
"
```
```
python -m timeit -s "
from test.performance.marshmallow_performance import run
run(1000)
"
```
## Release Proceedure

The typical process here is:
* Create a PR with changes. Merge these to main (The `Quality` workflows make sure that your PR
meets the styling, linting, and code coverage standards).
* New releases created in github are automatically uploaded to pypi
%prep
%autosetup -n marshy-4.0.3
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-marshy -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 4.0.3-1
- Package Spec generated
|