people.models.person

Classes

Person

A person.

Module Contents

class people.models.person.Person[source]

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, onegov.core.orm.mixins.TimestampMixin, onegov.search.ORMSearchable, onegov.core.orm.mixins.UTCPublicationMixin

A person.

__tablename__ = 'people'[source]

type: sqlalchemy.Column[str][source]

__mapper_args__[source]

fts_public = True[source]: Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results.

fts_properties[source]

property fts_suggestion: tuple[str, Ellipsis][source]

Returns suggest-as-you-type value of the document. The field used for this property should also be indexed, or the suggestion will lead to nowhere.

If a single string is returned, the completion input equals the completion output. (My Title -> My Title)

If an array of strings is returned, all values are possible inputs and the first value is the output. (My Title/Title My -> My Title)

property fts_last_change: None[source]: Returns the date the document was created/last modified.

property phone_fts: list[str][source]

property title: str[source]: Returns the Eastern-ordered name.

property spoken_title: str[source]: Returns the Western-ordered name. Includes the academic title if available.

id: sqlalchemy.Column[uuid.UUID][source]

salutation: sqlalchemy.Column[str | None][source]

academic_title: sqlalchemy.Column[str | None][source]

first_name: sqlalchemy.Column[str][source]

last_name: sqlalchemy.Column[str][source]

born: sqlalchemy.Column[str | None][source]

profession: sqlalchemy.Column[str | None][source]

function: sqlalchemy.Column[str | None][source]

organisation: sqlalchemy.Column[str | None][source]

organisations_multiple: onegov.core.orm.mixins.content.dict_property[list[str] | None][source]

sub_organisation: sqlalchemy.Column[str | None][source]

political_party: sqlalchemy.Column[str | None][source]

parliamentary_group: sqlalchemy.Column[str | None][source]

picture_url: sqlalchemy.Column[str | None][source]

email: sqlalchemy.Column[str | None][source]

phone: sqlalchemy.Column[str | None][source]

phone_direct: sqlalchemy.Column[str | None][source]

website: sqlalchemy.Column[str | None][source]

website_2: sqlalchemy.Column[str | None][source]

address: sqlalchemy.Column[str | None][source]

location_address: sqlalchemy.Column[str | None][source]

location_code_city: sqlalchemy.Column[str | None][source]

postal_address: sqlalchemy.Column[str | None][source]

postal_code_city: sqlalchemy.Column[str | None][source]

notes: sqlalchemy.Column[str | None][source]

memberships: sqlalchemy.orm.relationship[onegov.core.types.AppenderQuery[onegov.people.models.AgencyMembership]][source]

vcard_object(exclude: collections.abc.Collection[str] | None = None, include_memberships: bool = True) → vobject.base.Component[source]

Returns the person as vCard (3.0) object.

Allows to specify the included attributes, provides a reasonable default if none are specified. Always includes the first and last name.

vcard(exclude: collections.abc.Collection[str] | None = None) → str[source]

Returns the person as vCard (3.0).

Allows to specify the included attributes, provides a reasonable default if none are specified. Always includes the first and last name.

property memberships_by_agency: list[onegov.people.models.AgencyMembership][source]: Returns the memberships sorted alphabetically by the agency.