Person¶
Todo
Docstrings (module, operations)
Placeholders¶
- class indico.modules.events.persons.placeholders.AbstractIDPlaceholder¶
- description = l'The ID of the abstract'¶
A short description of the placeholder.
- name = 'abstract_id'¶
The name of the placeholder. Must be unique within the context where the placeholder is used
- classmethod render(abstract, **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.AbstractTitlePlaceholder¶
- description = l'The title of the abstract'¶
A short description of the placeholder.
- name = 'abstract_title'¶
The name of the placeholder. Must be unique within the context where the placeholder is used
- classmethod render(abstract, **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.ContributionCodePlaceholder¶
- description = l'The program code of the contribution'¶
A short description of the placeholder.
- name = 'contribution_code'¶
The name of the placeholder. Must be unique within the context where the placeholder is used
- classmethod render(contribution, **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.ContributionIDPlaceholder¶
- description = l'The ID of the contribution'¶
A short description of the placeholder.
- name = 'contribution_id'¶
The name of the placeholder. Must be unique within the context where the placeholder is used
- classmethod render(contribution, **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.ContributionTitlePlaceholder¶
- description = l'The title of the contribution'¶
A short description of the placeholder.
- name = 'contribution_title'¶
The name of the placeholder. Must be unique within the context where the placeholder is used
- classmethod render(contribution, **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.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.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