StandardReference

pydantic model StandardReference

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

>>> StandardReference(prefix="GO", identifier="0032571")
StandardReference(prefix='GO', identifier='0032571')

Standardizes capitalization to preferred prefix:

>>> StandardReference(prefix="go", identifier="0032571")
StandardReference(prefix='GO', identifier='0032571')

Standardizes prefix synonyms to lowercase:

>>> StandardReference(prefix="GOBP", identifier="0032571")
StandardReference(prefix='GO', identifier='0032571')

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": "StandardReference",
   "description": "An extension to :class:`curies.Reference` that automatically validates prefix and identifier.\n\n>>> StandardReference(prefix=\"GO\", identifier=\"0032571\")\nStandardReference(prefix='GO', identifier='0032571')\n\nStandardizes capitalization to preferred prefix:\n\n>>> StandardReference(prefix=\"go\", identifier=\"0032571\")\nStandardReference(prefix='GO', identifier='0032571')\n\nStandardizes prefix synonyms to lowercase:\n\n>>> StandardReference(prefix=\"GOBP\", identifier=\"0032571\")\nStandardReference(prefix='GO', identifier='0032571')",
   "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"
      }
   },
   "required": [
      "prefix",
      "identifier"
   ]
}

Config:

• frozen: bool = True

Fields:

Validators:

• validate_identifier » all fields

validator validate_identifier  »  all fields

Validate the identifier.