StandardNamedReference

pydantic model StandardNamedReference

An extension to curies.NamedReference that automatically validates prefix and identifier.

>>> StandardNamedReference(prefix="GO", identifier="0032571", name="response to vitamin K")
StandardNamedReference(prefix='GO', identifier='0032571', name='response to vitamin K')

Standardizes capitalization to preferred prefix:

>>> StandardNamedReference(prefix="go", identifier="0032571", name="response to vitamin K")
StandardNamedReference(prefix='GO', identifier='0032571', name='response to vitamin K')

Standardizes prefix synonyms to lowercase:

>>> StandardNamedReference(prefix="GOBP", identifier="0032571", name="response to vitamin K")
StandardNamedReference(prefix='GO', identifier='0032571', name='response to vitamin K')

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Show JSON schema

{
   "title": "StandardNamedReference",
   "description": "An extension to :class:`curies.NamedReference` that automatically validates prefix and identifier.\n\n>>> StandardNamedReference(prefix=\"GO\", identifier=\"0032571\", name=\"response to vitamin K\")\nStandardNamedReference(prefix='GO', identifier='0032571', name='response to vitamin K')\n\nStandardizes capitalization to preferred prefix:\n\n>>> StandardNamedReference(prefix=\"go\", identifier=\"0032571\", name=\"response to vitamin K\")\nStandardNamedReference(prefix='GO', identifier='0032571', name='response to vitamin K')\n\nStandardizes prefix synonyms to lowercase:\n\n>>> StandardNamedReference(prefix=\"GOBP\", identifier=\"0032571\", name=\"response to vitamin K\")\nStandardNamedReference(prefix='GO', identifier='0032571', name='response to vitamin K')",
   "type": "object",
   "properties": {
      "prefix": {
         "description": "The prefix used in a compact URI (CURIE).",
         "title": "Prefix",
         "type": "string"
      },
      "identifier": {
         "description": "The local unique identifier used in a compact URI (CURIE).",
         "title": "Identifier",
         "type": "string"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the entity referenced by this object's prefix and identifier, if exists.",
         "title": "Name"
      }
   },
   "required": [
      "prefix",
      "identifier"
   ]
}

Config:

• frozen: bool = True

Fields:

Validators: