Person

Todo

Docstrings (module, operations)

Operations

indico.modules.events.persons.operations.update_person(person, data)

Placeholders

class indico.modules.events.persons.placeholders.ContributionsPlaceholder

classmethod iter_param_info(person, event, **kwargs)

Yield information for known params.

Each item yielded must be a (value, description) tuple.

Parameters

kwargs – arguments specific to the placeholder’s context

name = 'contributions'

The name of the placeholder. Must be unique within the context where the placeholder is used

param_required = False

Whether the param is required

param_restricted = True

Whether only params defined in iter_param_info are allowed

classmethod render(param, person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context

class indico.modules.events.persons.placeholders.EmailPlaceholder

description = l'Email of the person'

A short description of the placeholder.

name = 'email'

The name of the placeholder. Must be unique within the context where the placeholder is used

classmethod render(person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context

class indico.modules.events.persons.placeholders.EventLinkPlaceholder

description = l'Link to the event'

A short description of the placeholder.

name = 'event_link'

The name of the placeholder. Must be unique within the context where the placeholder is used

classmethod render(person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context

class indico.modules.events.persons.placeholders.EventTitlePlaceholder

description = l'The title of the event'

A short description of the placeholder.

name = 'event_title'

The name of the placeholder. Must be unique within the context where the placeholder is used

classmethod render(person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context

class indico.modules.events.persons.placeholders.FirstNamePlaceholder

description = l'First name of the person'

A short description of the placeholder.

name = 'first_name'

The name of the placeholder. Must be unique within the context where the placeholder is used

classmethod render(person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context

class indico.modules.events.persons.placeholders.LastNamePlaceholder

description = l'Last name of the person'

A short description of the placeholder.

name = 'last_name'

The name of the placeholder. Must be unique within the context where the placeholder is used

classmethod render(person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context

class indico.modules.events.persons.placeholders.RegisterLinkPlaceholder

description = l'The link for the registration page'

A short description of the placeholder.

name = 'register_link'

The name of the placeholder. Must be unique within the context where the placeholder is used

classmethod render(person, event, **kwargs)

Convert the placeholder to a string.

When a placeholder contains HTML that should not be escaped, the returned value should be returned as a markupsafe.Markup instance instead of a plain string.

Subclasses are encouraged to explicitly specify the arguments they expect instead of using **kwargs.

Parameters

kwargs – arguments specific to the placeholder’s context