RF: declare our own metaclass so we could centralize population of sc…

…hemaKey

Overloading is allowed by simply specifying the name to be used while declaring
the class in the source code.

dandischema/models.py

@@ -6,6 +6,7 @@
 from typing import Any, Dict, List, Optional, Type, Union
 
 from pydantic import UUID4, BaseModel, ByteSize, EmailStr, Field, HttpUrl, validator
+from pydantic.main import ModelMetaclass
 
 from .consts import DANDI_SCHEMA_VERSION
 from .model_types import (
@@ -94,9 +95,16 @@ def encode(self, o):
         return super().encode(_sanitize(o))
 
 
-class DandiBaseModel(BaseModel):
+class DandiBaseModelMetaclass(ModelMetaclass):
+    def __new__(cls, name, bases, dct):
+        sk_name = dct.pop("schemaKey", None) or name
+        dct["schemaKey"]: Literal[sk_name] = Field(sk_name, readOnly=True)
+        objcls = super().__new__(cls, name, bases, dct)
+        return objcls
+
+
+class DandiBaseModel(BaseModel, metaclass=DandiBaseModelMetaclass):
     id: Optional[str] = Field(description="Uniform resource identifier", readOnly=True)
-    schemaKey: Literal["DandiBaseModel"] = Field("DandiBaseModel", readOnly=True)
 
     @classmethod
     def unvalidated(__pydantic_cls__: Type[BaseModel], **data: Any) -> BaseModel:
@@ -183,7 +191,6 @@ class PropertyValue(DandiBaseModel):
         nskey="schema",
     )
 
-    schemaKey: Literal["PropertyValue"] = Field("PropertyValue", readOnly=True)
     _ldmeta = {"nskey": "schema"}
 
 
@@ -208,45 +215,32 @@ class BaseType(DandiBaseModel):
     name: Optional[str] = Field(
         description="The name of the item.", max_length=150, nskey="schema"
     )
-    schemaKey: Literal["BaseType"] = Field("BaseType", readOnly=True)
     _ldmeta = {"rdfs:subClassOf": ["prov:Entity", "schema:Thing"], "nskey": "dandi"}
 
 
 class AssayType(BaseType):
     """OBI based identifier for the assay(s) used"""
 
-    schemaKey: Literal["AssayType"] = Field("AssayType", readOnly=True)
-
 
 class SampleType(BaseType):
     """OBI based identifier for the sample type used"""
 
-    schemaKey: Literal["SampleType"] = Field("SampleType", readOnly=True)
-
 
 class Anatomy(BaseType):
     """UBERON or other identifier for anatomical part studied"""
 
-    schemaKey: Literal["Anatomy"] = Field("Anatomy", readOnly=True)
-
 
 class StrainType(BaseType):
     """Identifier for the strain of the sample"""
 
-    schemaKey: Literal["StrainType"] = Field("StrainType", readOnly=True)
-
 
 class SexType(BaseType):
     """Identifier for the sex of the sample"""
 
-    schemaKey: Literal["SexType"] = Field("SexType", readOnly=True)
-
 
 class SpeciesType(BaseType):
     """Identifier for species of the sample"""
 
-    schemaKey: Literal["SpeciesType"] = Field("SpeciesType", readOnly=True)
-
 
 class Disorder(BaseType):
     """Biolink, SNOMED, or other identifier for disorder studied"""
@@ -258,40 +252,28 @@ class Disorder(BaseType):
         nskey="dandi",
         rangeIncludes="schema:Date",
     )
-    schemaKey: Literal["Disorder"] = Field("Disorder", readOnly=True)
 
 
 class GenericType(BaseType):
     """An object to capture any type for about"""
 
-    schemaKey: Literal["GenericType"] = Field("GenericType", readOnly=True)
-
 
 class ApproachType(BaseType):
     """Identifier for approach used"""
 
-    schemaKey: Literal["ApproachType"] = Field("ApproachType", readOnly=True)
-
 
 class MeasurementTechniqueType(BaseType):
     """Identifier for measurement technique used"""
 
-    schemaKey: Literal["MeasurementTechniqueType"] = Field(
-        "MeasurementTechniqueType", readOnly=True
-    )
-
 
 class StandardsType(BaseType):
     """Identifier for data standard used"""
 
-    schemaKey: Literal["StandardsType"] = Field("StandardsType", readOnly=True)
-
 
 class ContactPoint(DandiBaseModel):
     email: Optional[EmailStr] = Field(None, nskey="schema")
     url: Optional[HttpUrl] = Field(None, nskey="schema")
 
-    schemaKey: Literal["ContactPoint"] = Field("ContactPoint", readOnly=True)
     _ldmeta = {"nskey": "schema"}
 
 
@@ -321,7 +303,6 @@ class Contributor(DandiBaseModel):
         description="Identifier associated with a sponsored or gift award",
         nskey="dandi",
     )
-    schemaKey: Literal["Contributor"] = Field("Contributor", readOnly=True)
 
 
 class Organization(Contributor):
@@ -346,7 +327,6 @@ class Organization(Contributor):
         description="Contact for the organization",
         nskey="schema",
     )
-    schemaKey: Literal["Organization"] = Field("Organization", readOnly=True)
     _ldmeta = {
         "rdfs:subClassOf": ["schema:Organization", "prov:Organization"],
         "nskey": "dandi",
@@ -371,7 +351,6 @@ class Person(Contributor):
         description="An organization that this person is affiliated with.",
         nskey="schema",
     )
-    schemaKey: Literal["Person"] = Field("Person", readOnly=True)
 
     _ldmeta = {"rdfs:subClassOf": ["schema:Person", "prov:Person"], "nskey": "dandi"}
 
@@ -389,7 +368,6 @@ class Software(DandiBaseModel):
     url: Optional[HttpUrl] = Field(
         None, description="Web page for the software", nskey="schema"
     )
-    schemaKey: Literal["Software"] = Field("Software", readOnly=True)
 
     _ldmeta = {
         "rdfs:subClassOf": ["schema:SoftwareApplication", "prov:Software"],
@@ -406,7 +384,6 @@ class Agent(DandiBaseModel):
     )
     name: str = Field(nskey="schema")
     url: Optional[HttpUrl] = Field(None, nskey="schema")
-    schemaKey: Literal["Agent"] = Field("Agent", readOnly=True)
 
     _ldmeta = {
         "rdfs:subClassOf": ["prov:Agent"],
@@ -425,7 +402,6 @@ class EthicsApproval(DandiBaseModel):
     contactPoint: ContactPoint = Field(
         description="Information about the ethics approval committee.", nskey="schema"
     )
-    schemaKey: Literal["EthicsApproval"] = Field("EthicsApproval", readOnly=True)
 
     _ldmeta = {"rdfs:subClassOf": ["schema:Thing", "prov:Entity"], "nskey": "dandi"}
 
@@ -446,7 +422,6 @@ class Resource(DandiBaseModel):
         "This relation should satisfy: dandiset <relation> resource",
         nskey="dandi",
     )
-    schemaKey: Literal["Resource"] = Field("Resource", readOnly=True)
 
     _ldmeta = {
         "rdfs:subClassOf": ["schema:CreativeWork", "prov:Entity"],
@@ -482,9 +457,6 @@ class AccessRequirements(DandiBaseModel):
         nskey="dandi",
         rangeIncludes="schema:Date",
     )
-    schemaKey: Literal["AccessRequirements"] = Field(
-        "AccessRequirements", readOnly=True
-    )
 
     _ldmeta = {"rdfs:subClassOf": ["schema:Thing", "prov:Entity"], "nskey": "dandi"}
 
@@ -513,7 +485,6 @@ class AssetsSummary(DandiBaseModel):
     variableMeasured: Optional[List[str]] = Field(None, readOnly=True, nskey="schema")
 
     species: Optional[List[SpeciesType]] = Field(readOnly=True)
-    schemaKey: Literal["AssetsSummary"] = Field("AssetsSummary", readOnly=True)
 
     _ldmeta = {
         "rdfs:subClassOf": ["schema:CreativeWork", "prov:Entity"],
@@ -534,8 +505,6 @@ class Equipment(DandiBaseModel):
         None, description="The description of the activity.", nskey="schema"
     )
 
-    schemaKey: Literal["Equipment"] = Field("Equipment", readOnly=True)
-
     _ldmeta = {
         "rdfs:subClassOf": ["schema:CreativeWork", "prov:Entity"],
         "nskey": "dandi",
@@ -565,8 +534,6 @@ class Activity(DandiBaseModel):
     ] = Field(None, nskey="prov")
     used: Optional[List[Equipment]] = Field(None, nskey="prov")
 
-    schemaKey: Literal["Activity"] = Field("Activity", readOnly=True)
-
     _ldmeta = {"rdfs:subClassOf": ["prov:Activity", "schema:Thing"], "nskey": "dandi"}
 
 
@@ -580,7 +547,6 @@ class Project(Activity):
     description: Optional[str] = Field(
         None, description="A brief description of the project.", nskey="schema"
     )
-    schemaKey: Literal["Project"] = Field("Project", readOnly=True)
 
 
 class Session(Activity):
@@ -593,19 +559,17 @@ class Session(Activity):
     description: Optional[str] = Field(
         None, description="A brief description of the session.", nskey="schema"
     )
-    schemaKey: Literal["Session"] = Field("Session", readOnly=True)
 
 
 class PublishActivity(Activity):
-    schemaKey: Literal["PublishActivity"] = Field("PublishActivity", readOnly=True)
+    pass
 
 
 class Locus(DandiBaseModel):
     identifier: Union[Identifier, List[Identifier]] = Field(
         description="Identifier for genotyping locus", nskey="schema"
     )
     locusType: Optional[str] = Field(None)
-    schemaKey: Literal["Locus"] = Field("Locus", readOnly=True)
     _ldmeta = {"nskey": "dandi"}
 
 
@@ -615,15 +579,13 @@ class Allele(DandiBaseModel):
     )
     alleleSymbol: Optional[str] = Field(None)
     alleleType: Optional[str] = Field(None)
-    schemaKey: Literal["Allele"] = Field("Allele", readOnly=True)
     _ldmeta = {"nskey": "dandi"}
 
 
 class GenotypeInfo(DandiBaseModel):
     locus: Locus = Field(description="Locus at which information was extracted")
     alleles: List[Allele] = Field(description="Information about alleles at the locus")
     wasGeneratedBy: Optional[List["Session"]] = Field(None, nskey="prov")
-    schemaKey: Literal["GenotypeInfo"] = Field("GenotypeInfo", readOnly=True)
     _ldmeta = {"nskey": "dandi"}
 
 
@@ -639,9 +601,6 @@ class RelatedParticipant(DandiBaseModel):
         "This relation should satisfy: Participant <relation> relatedParticipant",
         nskey="dandi",
     )
-    schemaKey: Literal["RelatedParticipant"] = Field(
-        "RelatedParticipant", readOnly=True
-    )
 
     _ldmeta = {
         "rdfs:subClassOf": ["schema:CreativeWork", "prov:Entity"],
@@ -695,8 +654,6 @@ class Participant(DandiBaseModel):
     relatedParticipant: Optional[List[RelatedParticipant]] = Field(None, nskey="dandi")
     sameAs: Optional[List[Identifier]] = Field(None, nskey="schema")
 
-    schemaKey: Literal["Participant"] = Field("Participant", readOnly=True)
-
     _ldmeta = {
         "rdfs:subClassOf": ["prov:Agent"],
         "rdfs:label": "Information about the participant.",
@@ -728,8 +685,6 @@ class BioSample(DandiBaseModel):
     sameAs: Optional[List[Identifier]] = Field(None, nskey="schema")
     hasMember: Optional[List[Identifier]] = Field(None, nskey="prov")
 
-    schemaKey: Literal["BioSample"] = Field("BioSample", readOnly=True)
-
     _ldmeta = {
         "rdfs:subClassOf": ["schema:Thing", "prov:Entity"],
         "rdfs:label": "Information about the biosample.",
@@ -806,7 +761,6 @@ class CommonModel(DandiBaseModel):
     relatedResource: Optional[List[Resource]] = Field(None, nskey="dandi")
 
     wasGeneratedBy: Optional[List[Activity]] = Field(None, nskey="prov")
-    schemaKey: Literal["CommonModel"] = Field("CommonModel", readOnly=True)
 
     def json_dict(self):
         """
@@ -886,8 +840,6 @@ def contributor_musthave_contact(cls, values):
         nskey="prov",
     )
 
-    schemaKey: Literal["Dandiset"] = Field("Dandiset", readOnly=True)
-
     _ldmeta = {
         "rdfs:subClassOf": ["schema:Dataset", "prov:Entity"],
         "rdfs:label": "Information about the dataset",
@@ -944,7 +896,8 @@ class BareAsset(CommonModel):
         nskey="prov",
     )
 
-    schemaKey: Literal["Asset"] = Field("Asset", readOnly=True)
+    # Bare asset is to be just Asset.
+    schemaKey = "Asset"
 
     _ldmeta = {
         "rdfs:subClassOf": ["schema:CreativeWork", "prov:Entity"],
@@ -979,7 +932,6 @@ class Publishable(DandiBaseModel):
         nskey="dandi",
     )  # TODO: formalize "publish" activity to at least the Actor
     datePublished: datetime = Field(readOnly=True, nskey="schema")
-    schemaKey: Literal["Publishable"] = Field("Publishable", readOnly=True)
 
 
 class PublishedDandiset(Dandiset, Publishable):
@@ -993,8 +945,13 @@ class PublishedDandiset(Dandiset, Publishable):
         readOnly=True, description="permalink to the item", nskey="schema"
     )
 
+    schemaKey = "Dandiset"
+
 
 class PublishedAsset(Asset, Publishable):
+
+    schemaKey = "Asset"
+
     @validator("digest")
     def digest_bothhashes(cls, values):
         try: