{"id":19921490,"url":"https://github.com/pyapp-kit/fieldz","last_synced_at":"2025-12-14T17:10:39.892Z","repository":{"id":195349450,"uuid":"692746608","full_name":"pyapp-kit/fieldz","owner":"pyapp-kit","description":"Unified API for working with multiple dataclass-like libraries","archived":false,"fork":false,"pushed_at":"2025-12-01T22:15:45.000Z","size":81,"stargazers_count":18,"open_issues_count":4,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-04T12:41:23.136Z","etag":null,"topics":["attrs","dataclasses","msgspec","pydantic"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyapp-kit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-09-17T13:12:54.000Z","updated_at":"2025-11-19T05:14:38.000Z","dependencies_parsed_at":"2025-12-03T07:07:51.471Z","dependency_job_id":null,"html_url":"https://github.com/pyapp-kit/fieldz","commit_stats":null,"previous_names":["tlambert03/dataclass-compat","pyapp-kit/fieldz","pyapp-kit/dataclass-compat"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/pyapp-kit/fieldz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyapp-kit%2Ffieldz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyapp-kit%2Ffieldz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyapp-kit%2Ffieldz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyapp-kit%2Ffieldz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyapp-kit","download_url":"https://codeload.github.com/pyapp-kit/fieldz/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyapp-kit%2Ffieldz/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27732295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["attrs","dataclasses","msgspec","pydantic"],"created_at":"2024-11-12T22:07:45.076Z","updated_at":"2025-12-14T17:10:39.836Z","avatar_url":"https://github.com/pyapp-kit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fieldz\n\n[![License](https://img.shields.io/pypi/l/fieldz.svg?color=green)](https://github.com/pyapp-kit/fieldz/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/fieldz.svg?color=green)](https://pypi.org/project/fieldz)\n[![Python Version](https://img.shields.io/pypi/pyversions/fieldz.svg?color=green)](https://python.org)\n[![CI](https://github.com/pyapp-kit/fieldz/actions/workflows/ci.yml/badge.svg)](https://github.com/pyapp-kit/fieldz/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/pyapp-kit/fieldz/branch/main/graph/badge.svg)](https://codecov.io/gh/pyapp-kit/fieldz)\n\nUnified API for working with multiple dataclass-like libraries\n\n## Dataclass patterns\n\nThere are many libraries that implement a similar dataclass-like pattern!\n\n### [`dataclasses.dataclass`](https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass)\n\n```python\nimport dataclasses\n\n@dataclasses.dataclass\nclass SomeDataclass:\n    a: int = 0\n    b: str = \"b\"\n    c: list[int] = dataclasses.field(default_factory=list)\n```\n\n### [`pydantic.BaseModel`](https://docs.pydantic.dev/latest/)\n\n```python\nimport pydantic\n\nclass SomePydanticModel(pydantic.BaseModel):\n    a: int = 0\n    b: str = \"b\"\n    c: list[int] = pydantic.Field(default_factory=list)\n```\n\n### [`attrs.define`](https://www.attrs.org/en/stable/overview.html)\n\n```python\nimport attrs\n\n@attrs.define\nclass SomeAttrsModel:\n    a: int = 0\n    b: str = \"b\"\n    c: list[int] = attrs.field(factory=list)\n```\n\n### [`msgspec.Struct`](https://jcristharif.com/msgspec/)\n\n```python\nimport msgspec\n\nclass SomeMsgspecStruct(msgspec.Struct):\n    a: int = 0\n    b: str = \"b\"\n    c: list[int] = msgspec.field(default_factory=list)\n```\n\netc...\n\n## Unified API\n\nThese are all awesome libraries, and each has its own strengths and weaknesses.\nSometimes, however, you just want to be able to query basic information about a\ndataclass-like object, such as getting field names or types, or converting it to\na dictionary.\n\n`fieldz` provides a unified API for these operations (following or\nextending the API from `dataclasses` when possible).\n\n```python\ndef fields(obj: Any) -\u003e tuple[Field, ...]:\n    \"\"\"Return a tuple of fieldz.Field objects for the object.\"\"\"\n\ndef replace(obj: Any, /, **changes: Any) -\u003e Any:\n    \"\"\"Return a copy of obj with the specified changes.\"\"\"\n\ndef asdict(obj: Any) -\u003e dict[str, Any]:\n    \"\"\"Return a dict representation of obj.\"\"\"\n\ndef astuple(obj: Any) -\u003e tuple[Any, ...]:\n    \"\"\"Return a tuple representation of obj.\"\"\"\n\ndef params(obj: Any) -\u003e DataclassParams:\n    \"\"\"Return parameters used to define the dataclass.\"\"\"\n```\n\nThe `fieldz.Field` and `fieldz.DataclassParam` objects are\nsimple dataclasses that match the protocols of `dataclasses.Field` and the\n(private) `dataclasses._DataclassParams` objects, respectively. The field object\nalso adds a `native_field` attribute that is the original field object from the\nunderlying library.\n\n### Example\n\n```python\nfrom fieldz import Field, fields\n\nstandardized_fields = (\n    Field(name=\"a\", type=int, default=0),\n    Field(name=\"b\", type=str, default=\"b\"),\n    Field(name=\"c\", type=list[int], default_factory=list),\n)\n\nassert (\n    fields(SomeDataclass)\n    == fields(SomePydanticModel)\n    == fields(SomeAttrsModel)\n    == fields(SomeMsgspecStruct)\n    == standardized_fields\n)\n```\n\n### Supported libraries\n\n- [x] [`dataclasses`](https://docs.python.org/3/library/dataclasses.html)\n- [x] [`collections.namedtuple`](https://docs.python.org/3/library/collections.html#collections.namedtuple)\n- [x] [`pydantic`](https://docs.pydantic.dev/latest/) (v1 and v2)\n- [x] [`attrs`](https://www.attrs.org/en/stable/overview.html)\n- [x] [`msgspec`](https://jcristharif.com/msgspec/)\n- [x] [`dataclassy`](https://github.com/biqqles/dataclassy)\n- [x] [`sqlmodel`](https://sqlmodel.tiangolo.com) (it's just pydantic)\n\n... maybe someday?\n\n- [ ] [`pyfields`](https://smarie.github.io/python-pyfields/)\n- [ ] [`marshmallow`](https://marshmallow.readthedocs.io/en/stable/quickstart.html)\n- [ ] [`sqlalchemy`](https://docs.sqlalchemy.org/en/20/orm/quickstart.html)\n- [ ] [`django`](https://docs.djangoproject.com/en/dev/topics/db/models/)\n- [ ] [`peewee`](http://docs.peewee-orm.com/en/latest/peewee/models.html#models)\n- [ ] [`pyrsistent`](https://github.com/tobgu/pyrsistent/)\n- [ ] [`recordclass`](https://pypi.org/project/recordclass/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyapp-kit%2Ffieldz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyapp-kit%2Ffieldz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyapp-kit%2Ffieldz/lists"}