openvax / serializable / 24681366731
90%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 5
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 89.778% (+1.4%) from 88.384%
24681366731

push

github

web-flow 
Add DataclassSerializable mixin for @dataclass subclasses (#13)

* Add DataclassSerializable mixin for @dataclass subclasses (#11)

Resolves openvax/serializable#11. Provides a narrow mixin that gives
@dataclass-decorated classes the `to_dict` / `from_dict` / `to_json` /
`from_json` API without overriding the `__init__` / `__eq__` / `__repr__`
/ `__hash__` that `@dataclass` already generates.

Wire format is identical to `Serializable`: `to_serializable_repr`
dispatches on `obj.to_dict()`, so mixed codebases (some classes still
on `Serializable`, some migrated to `DataclassSerializable`) round-trip
JSON cleanly. Pickle routes through the same envelope via `__reduce__`.

Includes the `_SERIALIZABLE_KEYWORD_ALIASES` escape hatch so legacy
field names can be renamed or dropped across releases, mirroring the
same mechanism on `Serializable`.

Bumps version to 1.1.0 — new public API, no breaking changes.

* Address PR #13 review: annotation, pickle test, alias inheritance test, README

- Fix Tagged.tag annotation: LegacyTag -> LegacyTag | None to match the None default.
- Add test_frozen_dataclass_pickle_roundtrip covering __reduce__ on a frozen
  dataclass (cls(**kwargs) must work even with __setattr__ disabled).
  Promoted FrozenPoint to module level so pickle can look it up.
- Add test_keyword_aliases_inherited_from_parent to confirm alias dicts
  declared on a parent class fire for child loads — migrations can live on
  a shared base without every subclass restating them.
- README: new section documenting DataclassSerializable, including usage
  snippet and interop notes for vaxrank/pyensembl/varcode.

202 of 225 relevant lines covered (89.78%)

0.9 hits per line

Jobs
ID Job ID Ran Files Coverage
1 24681366731.1 5
89.78
 GitHub Action Run
Source Files on build 24681366731