venues¶

A publication venue.

Attributes:

Name	Type	Description
`id`	`str`	The venue ID, e.g. "acl".
`acronym`	`str`	The venue's acronym, e.g. "ACL".
`name`	`str`	The venue's name. Should not contain any indications of specific events; i.e., "Workshop on...", not "The 1^st Workshop on..."
`path`	`Path`	The path of the YAML file representing this venue.
`is_acl`	`bool`	True if this is a venue organized or sponsored by the ACL.
`is_toplevel`	`bool`	True if this venue appears on the ACL Anthology's front page.
`oldstyle_letter`	`Optional[str]`	First letter of old-style Anthology IDs that is associated with this venue (e.g., "P" for ACL proceedings).
`url`	`Optional[str]`	A website URL for the venue.

load_from_yaml(path)

Instantiates a venue from its YAML file.

Parameters:

Name	Type	Description	Default
`path`	`PathLike[str]`	The YAML file defining this venue.	required

Warning

Currently assumes that files are named {venue_id}.yaml.

save(path=None)

Saves this venue as a YAML file.

Parameters:

Name	Type	Description	Default
`path`	`Optional[PathLike[str]]`	The filename to save to. If None, defaults to `self.path`.	`None`

Index object through which venues and their associated volumes can be accessed.

Provides dictionary-like functionality mapping venue IDs to Venue objects.

Attributes:

Name	Type	Description
`parent`	`Anthology`	The parent Anthology instance to which this index belongs.
`is_data_loaded`	`bool`	A flag indicating whether the venue YAML files have been loaded.

load()

Loads and parses the venues/*.yaml files.

Raises:

Type	Description
`KeyError`	If a mandatory key is missing in a YAML file.

save()

Saves all venue metadata to venues/*.yaml files.