Skip to main content

Less verbose dataclasses

Project description

Module dataclass_baseclass

DataClass - inheritable contagious base class.

Instead of (endless?) @dataclass decorating.

Usage

class A(DataClass):  # it's a dataclass

class B(A):  # it's a dataclass too

as opposed to:

@dataclass
class A(): ...  # it's a dataclass

class B(A): ...  # it's *not* a dataclass, needs decorating

@dataclass
class B(A): ...  # now it's a dataclass

Also:

class B(DataClass, A): ...  # all properties from A are dataclassed

as opposed to:

class A():  ...

@dataclass
class B(A): ...  # no properties from A are dataclassed

Instantiation

class C(DataClass):
    a: str
    b: str

defaults: Data = {"a": "A", "b": "B"}

c = C(defaults, a="a", b="b")

or just:

c = C(a="a", b="b")

Loaders

Tested with following dataclass loaders:

dataclasses-json

Works with DataClassJsonMixin and from_dict() (actually _decode_dataclass().

I could not get it to work with @dataclass_json decorator, probably did not try hard enough.

Documentation and examples

Documentation

Tests should give a good idea of how to use it.

Test report

Name                     Stmts   Miss  Cover
--------------------------------------------
dataclass_baseclass.py     112      0   100%
--------------------------------------------
TOTAL                      112      0   100%

Notes / FAQ

And Pydantic?

Obvious question. Pydantic is Ok if you want to enter that world and stay there. Like Microsoft or Apple or Google. Want to share between those worlds? Good luck with that. In particular, multiple inheritance:

Straight multiple inheritance

class A(BaseModel): ...

class B(BaseModel): ...

class C(A, B): ...

The official stance on this (at least what I could figure out at the time of writing) is:

It will probably work, but not quaranteed, not officially supported

Of course, it could be argued this is an anti-pattern and it is good that it is not supported. I have no strong opinion on that. But:

Protocols (or mix-ins, or whatever)

class A(BaseModel): ...

class P(Protocol): ...

class C(A, P): ...

This is a no-go.

With DataClass intention is to enable all of that.

Why not from scratch, why wrapping dataclasses?

Considering the effort that was put into dataclasses my conclusu=ion is that dataclasses is the recommended way to standardise directly accessible class/instance properties in the standard library.

Has this been tested in real life?

I am using it in my personal (hobby?) projects. But nothing of a decent size in business environment.

What there anything especially annoying?

Not that anyone wanted to ask this question. But I'll say it anyway.

Metaclasses. A quote from the official docs:

The potential uses for metaclasses are boundless. Some ideas that have been explored include enum, logging, interface checking, automatic delegation, automatic property creation, proxies, frameworks, and automatic resource locking/synchronization.

One could be easily forgiven to think that creating custom metaclasses is a valid thing to do, at least not discouraged. Is there any official example of how to c roll out your own metaclass, how do you subclass type? I could not find it. type (meta)class is implementyed in C, and it is not light reading. Quite frustrating if you are after "what methods are available for overriding and what are their footprints".

One is condemned to trawling the internets, which gives you the venerable "Let's make a singleton" example in 99.98% of the cases. That gives you a clue that you ned to override __new__(), which hase the same footprint as type(). Then you look in some corners of the internet, or much better ask ChatGPT, which will give you a hint that you could play with__call__() method.

To sum it up, a very laborious trial and error process. Why not documenting some examples and make life a tad easier - no idea.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dataclass_baseclass-0.0.2.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dataclass_baseclass-0.0.2-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file dataclass_baseclass-0.0.2.tar.gz.

File metadata

  • Download URL: dataclass_baseclass-0.0.2.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for dataclass_baseclass-0.0.2.tar.gz
Algorithm Hash digest
SHA256 3b6ba85e4f24f5184accd5795127ba662f964c63b7b6c893bee8db12eb01a5a5
MD5 9f6b233fbefb9677aeb31fc2da29fdd5
BLAKE2b-256 851660477c72249de372054de164fccf28087feaf0e8c52c6a0f2511890417a2

See more details on using hashes here.

File details

Details for the file dataclass_baseclass-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for dataclass_baseclass-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 83a4a6236755e7f5cfdbb1195aab1817bd48bfb0680fe55506bb2d67e86497cf
MD5 edece25085f7cfc9375592e9f385ad49
BLAKE2b-256 18c67eae68f4c678503ef53b34b7317c7b338671215c90086cfa774bf341bd5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page