ged2doc.name

Methods for manipulating/formatting names.

Functions

name_fmt(name[, fmt])

Format name for output.

Classes

NameFormat(value)

Names can be rendered in different formats, this enum defines different types of presentations that can also be combined with logical OR (|).
class ged2doc.name.NameFormat(value)[source]

Bases: enum.Flag

Names can be rendered in different formats, this enum defines different types of presentations that can also be combined with logical OR (|).

SURNAME_FIRST = 1

Bit flag for surname-first format (e.g. Smith Jane).

COMMA = 2

Bit flag for adding comma in surname-first format (e.g. Smith, Jane).

MAIDEN = 4

Bit flag for adding maiden name (e.g. Jane Smith (Sawyer)).

MAIDEN_ONLY = 8

Bit flag for using maiden name only (e.g. Jane Sawyer).

CAPITAL = 16

Bit flag for rendering surname in capital (e.g. Jane SMITH).

ged2doc.name.name_fmt(name, fmt=<NameFormat.0: 0>)[source]

Format name for output.

Parameters
nameged4py.model.Name

Person name.

fmtNameFormat, optional

Bitmask combination of NameFormat flags.

Returns
namestr

Formatted name representation.