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": {
         "title": "Family Names",
         "description": "The person's family name (last name in western culture).",
         "type": "string"
      },
      "given_names": {
         "title": "Given Names",
         "description": "The person's given name (first name in western culture).",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "description": "The person's name, an alternative to specifying surname and given names.",
         "type": "string"
      }
   }
}

Fields:

• family_names (Optional[str])

• given_names (Optional[str])

• name (Optional[str])

Validators:

• check_well_defined » all fields

• clean_whitespace » family_names

• clean_whitespace » given_names

• clean_whitespace » name

field family_names: Optional[str] = None

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

Validated by:

• check_well_defined

• clean_whitespace

field given_names: Optional[str] = None

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

Validated by:

• check_well_defined

• clean_whitespace

field name: Optional[str] = None

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

Validated by:

• check_well_defined

• clean_whitespace

validator check_well_defined  »  all fields

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

Parameters:

values (Dict[str, Any]) –

Return type:

Dict[str, Any]

validator clean_whitespace  »  given_names, name, family_names

Parameters:

v (Optional[str]) –

Return type:

Optional[str]

property plain_text_name: str

The name in plain text.

Return type:

str