PersonName#

pydantic model technote.config.PersonName#

A person’s name.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "PersonName",
   "description": "A person's name.",
   "type": "object",
   "properties": {
      "family_names": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The person's family name (last name in western culture).",
         "title": "Family Names"
      },
      "given_names": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The person's given name (first name in western culture).",
         "title": "Given Names"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The person's name, an alternative to specifying surname and given names.",
         "title": "Name"
      }
   }
}

Fields:
Validators:
field family_names: str | None = None#

The person’s family name (last name in western culture).

Validated by:
field given_names: str | None = None#

The person’s given name (first name in western culture).

Validated by:
field name: str | None = None#

The person’s name, an alternative to specifying surname and given names.

Validated by:
validator check_well_defined  »  all fields#

Check that either surname and given are both provided, or name alone is set.

Return type:

Self

validator clean_whitespace  »  name, given_names, family_names#
Parameters:

v (Optional[str]) –

Return type:

Optional[str]

property plain_text_name: str#

The name in plain text.