collections.event

Event

An event, such as a meeting or a conference.

Info

To create a new explicit event, use Collection.create_event().

Required Attributes:

Name	Type	Description
id	str	The ID of this event.
parent	Collection	The Collection object that this event belongs to.
is_explicit	bool	True if this event was defined explicitly in the XML.

List Attributes:

Name	Type	Description
colocated_ids	dict[AnthologyIDTuple, EventLink]	A dictionary mapping colocated volume IDs to their EventLink type.
links	dict[str, EventFileReference]	Links to materials for this event paper. The dictionary key specifies the type of link (e.g., "handbook" or "website").
talks	list[Talk]	Zero or more references to talks belonging to this event.

Optional Attributes:

Name	Type	Description
title	Optional[MarkupText]	The title of the event.
location	Optional[str]	The location of the event.
dates	Optional[str]	The dates when the event happened.

collection property

collection

The collection this event belongs to.

collection_id property

collection_id

The collection ID this event belongs to.

root property

root

The Anthology instance to which this object belongs.

add_colocated

add_colocated(volume, type_=EXPLICIT)

Add a co-located volume to this event.

If the volume is already co-located with this event, calling this function can be used to make the connection explicit (i.e. written out to the XML); otherwise, this will do nothing.

Parameters:

Name	Type	Description	Default
volume	Volume | AnthologyID	The ID or Volume object to co-locate with this event.	required
type_	EventLink	Whether this volume is/should be explicitly linked in the XML or is inferred. (Defaults to 'explicit'; you probably don't want to change this.)	EXPLICIT

from_xml classmethod

from_xml(parent, event)

Instantiates a new event from an <event> block in the XML.

to_xml

to_xml()

Returns:

Type	Description
_Element	A serialization of this event as an <event> block in the Anthology XML format.

volumes

volumes()

Returns an iterator over all volumes co-located with this event.

Talk

A talk without an associated paper, such as a keynote or invited talk.

Attributes:

Name	Type	Description
title	MarkupText	The title of the talk.
parent	Optional[Event]	The Event object that this talk belongs to.
type	Optional[str]	Type of talk, e.g. "keynote".
speakers	tuple[NameSpecification, ...]	Name(s) of speaker(s) who gave this talk; can be empty.
attachments	dict[str, EventFileReference]	Links to attachments for this talk. The dictionary key specifies the type of attachment (e.g., "video" or "slides").

collection property

collection

The collection this talk belongs to.

root property

root

The Anthology instance to which this object belongs.

from_xml classmethod

from_xml(element)

Instantiates a Talk from its <talk> block in the XML.

to_xml

to_xml()

Returns:

Type	Description
_Element	A serialization of this talk as a <talk> block in the Anthology XML format.