ged2doc.writer

Module which defines base class for all writer classes.

Functions

TR(x)

This is no-op function, only used to mark translatable strings, to extract all strings run pygettext -k TR ...

Classes

Writer(flocator, tr[, encoding, …])

Base class for document writers.

class ged2doc.writer.Writer(flocator, tr, encoding=None, encoding_errors='strict', sort_order=<NameOrder.SURNAME_GIVEN: 'last+first'>, name_fmt=0, make_images=True, make_stat=True, make_toc=True, events_without_dates=True)

Bases: object

Base class for document writers.

This class knows how to extract all relevant information from GEDCOM data and convert it into output document. It defines basic structure of the produced document (sequence of section and sub-sections) and it depends on the subclasses to implement specific rendering of output information into document-specific format. Subclasses will need to implement small set of methods (see _render methods below).

Parameters

flocatorged2doc.input.FileLocator

File locator instance.

trged2doc.i18n.I18N

Object supporting translation.

encodingstr, optional

GEDCOM file encoding, if None then encoding is determined from file itself.

encoding_errorsstr, optional

Controls error handling behavior during string decoding, one of “strict” (default), “ignore”, or “replace”.

sort_orderged4py.model.NameOrder, optional

Determines ordering of person in output file, one of the constants defined in ged4py.model.NameOrder enum.

name_fmtint, optional

Bit mask with flags from ged2doc.name module.

make_imagesbool, optional

If True (default) then generate images for persons.

make_statbool, optional

If True (default) then generate statistics section.

make_tocbool, optional

If True (default) then generate Table of Contents.

events_without_datesbool, optional

If True (default) then show events that have no associated dates.

Methods

save()

Produce output document.

save()

Produce output document.

This is the main (and the only one client-callable) method of the writers, it will parse GEDCOM structure and produce output document from it.

_indi_sort_key(indi)

Return name ordering key for individual.

Parameters

indiged4py.model.Individual

INDI record representation.

Returns

ordertuple [ str ]

_events(person)

Returns a list of events for a given person.

Returned list contains tuples (date, info).

Parameters

personged4py.model.Individual

INDI record representation.

Returns

eventslist [ tuple ]

List of tuples with two elements: date and event information.

_make_main_image(person)

Returns image for a person.

Parameters

personged4py.model.Individual

INDI record representation.

Returns

image_databytes or None

Bytes of the image data or None.

_name_freq(people)

Returns name frequency table.

Parameters

peopleiterable of ged4py.model.Individual

Sequence of INDI records.

Returns

tablelist [ tuple ]

List of (name, count) ordered by name.

_format_indi_attr(person, attrib, prefix='ATTR.')

Formatting of the individual’s attributes.

Parameters

personged4py.model.Individual

INDI record representation.

attribged2doc.events.Event

Attribute structure.

prefixstr, optional

Prefix added to attribute tag before translation.

Returns

attributetuple

Tuple (attribute, value).

_person_ref(person, name=None)

Returns encoded person reference.

If person is None then None is returned. If name is not given then properly formatted person full name is used.

Encoded reference consists of ASCII character SOH (
) followed by reference ID, STX (), person name, and ETX (). This sequence will be embedded in the text and it should be interpreted later by subclasses to produce properly formatted reference in a backend- specific format.

Parameters

personged4py.model.Individual

INDI record representation.

namestr, optional

Name to use instead of person name.

Returns

person_refstr

abstract _render_prolog()

Generate initial document header/title.

abstract _render_section(level, ref_id, title, newpage=False)

Produces new section in the output document.

This method should also save section reference so that TOC can be later produced when _render_toc method is called.

Parameters

levelint

Section level (1, 2, 3, etc.).

ref_idstr

Unique section identifier.

titlestr

Printable section name.

newpagebool, optional

If True then start new page (for documents that support pagination).

abstract _render_person(person, image_data, attributes, families, events, notes)

Output person information.

Parameters

personged4py.model.Individual

INDI record representation.

image_databytes or None

Either None or binary image data (typically content of JPEG image).

attributeslist [ tuple ]

List of (attr_name, text) tuples, may be empty.

familieslist [ str ]

List of strings (possibly empty), each string contains description of one family and should be typically rendered as a separate paragraph.

eventslist [ tuple ]

List of (date, text) tuples, may be empty. Date is properly formatted string and does not need any other formatting.

noteslist [ str ]

List of strings, each string should be rendered as separate paragraph.

Notes

Textual information in parameters to this method can include references to other persons (e.g. mother/father). Such references are embedded into text in encoded format determined by _person_ref method. It is responsibility of the subclasses to extract these references from text and re-encode them using proper backend representation.

abstract _render_name_stat(n_total, n_females, n_males)

Produces summary table.

Sum of male and female counters can be lower than total count due to individuals with unknown/unspecified gender.

Parameters

n_totalint

Total number of individuals.

n_femalesint

Number of female individuals.

n_malesint

Number of male individuals.

abstract _render_name_freq(freq_table)

Produces name statistics table.

Parameters

freq_tablelist [ tuple ]

List of (name, count) tuples.

abstract _render_toc()

Produce table of contents using info collected in _render_section().

abstract _finalize()

Finalize output.

_abc_impl = <_abc_data object>