Skip to content

refactor: eliminate multiple value choices in schemaKey Literals #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
candleindark wants to merge 2 commits into
base: master
Choose a base branch
from
+16 −15
Open

refactor: eliminate multiple value choices in schemaKey Literals #437

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0091b9c
refactor: narrow multi-value `schemaKey` `Literal`s to a single value
candleindark Aug 6, 2026
e45422b
refactor: express `wasGeneratedBy` as an explicit union of activity t…
candleindark Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions dandischema/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
List,
Literal,
Optional,
Sequence,
Type,
TypeVar,
Union,
Expand Down Expand Up @@ -928,7 +927,7 @@ class Contributor(DandiBaseModel):
description="Identifier associated with a sponsored or gift award.",
json_schema_extra={"nskey": DANDI_NSKEY},
)
schemaKey: Literal["Contributor", "Organization", "Person"] = Field(
schemaKey: Literal["Contributor"] = Field(
"Contributor", validate_default=True, json_schema_extra={"readOnly": True}
)

Expand Down Expand Up @@ -965,7 +964,7 @@ class Organization(Contributor):
description="Contact for the organization",
json_schema_extra={"nskey": "schema"},
)
schemaKey: Literal["Organization"] = Field(
schemaKey: Literal["Organization"] = Field( # type: ignore[assignment]
"Organization", validate_default=True, json_schema_extra={"readOnly": True}
)
_ldmeta = {
Expand Down Expand Up @@ -1014,7 +1013,7 @@ class Person(Contributor):
description="An organization that this person is affiliated with.",
json_schema_extra={"nskey": "schema"},
)
schemaKey: Literal["Person"] = Field(
schemaKey: Literal["Person"] = Field( # type: ignore[assignment]
"Person", validate_default=True, json_schema_extra={"readOnly": True}
)

Expand Down Expand Up @@ -1289,7 +1288,7 @@ class Activity(DandiBaseModel):
description="A listing of equipment used for the activity.",
json_schema_extra={"nskey": "prov"},
)
schemaKey: Literal["Activity", "Project", "Session", "PublishActivity"] = Field(
schemaKey: Literal["Activity"] = Field(
"Activity", validate_default=True, json_schema_extra={"readOnly": True}
)

Expand All @@ -1311,7 +1310,7 @@ class Project(Activity):
description="A brief description of the project.",
json_schema_extra={"nskey": "schema"},
)
schemaKey: Literal["Project"] = Field(
schemaKey: Literal["Project"] = Field( # type: ignore[assignment]
"Project", validate_default=True, json_schema_extra={"readOnly": True}
)

Expand All @@ -1328,13 +1327,13 @@ class Session(Activity):
description="A brief description of the session.",
json_schema_extra={"nskey": "schema"},
)
schemaKey: Literal["Session"] = Field(
schemaKey: Literal["Session"] = Field( # type: ignore[assignment]
"Session", validate_default=True, json_schema_extra={"readOnly": True}
)


class PublishActivity(Activity):
schemaKey: Literal["PublishActivity"] = Field(
schemaKey: Literal["PublishActivity"] = Field( # type: ignore[assignment]
"PublishActivity", validate_default=True, json_schema_extra={"readOnly": True}
)

Expand Down Expand Up @@ -1637,9 +1636,9 @@ class CommonModel(DandiBaseModel):
None, json_schema_extra={"nskey": DANDI_NSKEY}
)

wasGeneratedBy: Optional[Sequence[Activity]] = Field(
None, json_schema_extra={"nskey": "prov"}
)
wasGeneratedBy: Optional[
list[Union[Activity, Project, PublishActivity, Session]]
] = Field(None, json_schema_extra={"nskey": "prov"})
schemaKey: str = Field(
"CommonModel", validate_default=True, json_schema_extra={"readOnly": True}
)
Expand Down Expand Up @@ -1784,7 +1783,7 @@ def contributor_musthave_contact(
json_schema_extra={"readOnly": True, "nskey": "schema"},
)

wasGeneratedBy: Optional[Sequence[Project]] = Field(
wasGeneratedBy: Optional[list[Project]] = Field( # type: ignore[assignment]
None,
title="Associated projects",
description="Project(s) that generated this Dandiset.",
Expand Down Expand Up @@ -1927,10 +1926,12 @@ class BareAsset(CommonModel):
description="Associated participant(s) or subject(s).",
json_schema_extra={"nskey": "prov"},
)
wasGeneratedBy: Optional[List[Union[Session, Project, Activity]]] = Field(
wasGeneratedBy: Optional[
list[Union[Activity, Project, PublishActivity, Session]]
] = Field(
None,
title="Name of the session, project or activity.",
description="Describe the session, project or activity that generated this asset.",
title="Associated activities",
description="Activities that generated this asset.",
json_schema_extra={"nskey": "prov"},
)

Expand Down
Loading