venues

Venue

A publication venue.

Attributes:

Name	Type	Description
id	str	The venue ID, e.g. "acl".
parent	Anthology	The parent Anthology instance to which this venue belongs.
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 1st 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.
item_ids	set[AnthologyIDTuple]	An unordered set of volume IDs associated with this venue.
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 classmethod

load_from_yaml(path, parent)

Instantiates a venue from its YAML file.

Parameters:

Name	Type	Description	Default
path	StrPath	The YAML file defining this venue.	required
parent	Anthology	The parent Anthology instance.	required

Warning

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

save

save(path=None)

Saves this venue as a YAML file.

Parameters:

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

volumes

volumes()

Returns an iterator over all volumes associated with this venue.

VenueIndex

Bases: SlottedDict[Venue]

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.
no_item_ids	bool	If set to True, skips parsing all XML files, which means the reverse-indexing of Volumes via Venue.item_ids will not be available.
is_data_loaded	bool	A flag indicating whether the venue YAML files have been loaded and the index has been built.

build

build()

Load the entire Anthology data and build an index of venues.

Raises:

Type	Description
ValueError	If a volume lists a venue ID that doesn't exist (i.e., isn't defined in the venue YAML files).

create

create(id, acronym, name, **kwargs)

Create a new venue and add it to the index.

Parameters:

Name	Type	Description	Default
id	str	The ID of the new venue.	required
acronym	str	The acronym of the new venue.	required
name	str	The name of the new venue.	required
**kwargs	Any	Any valid optional attribute of Venue, with the exception of path, which is automatically set based on the venue ID, as well as item_ids and oldstyle_letter, which cannot be set.	{}

Returns:

Type	Description
Venue	The created Venue object.

Raises:

Type	Description
KeyError	If an invalid attribute is supplied in **kwargs.

load

load()

Load and parse the venues/*.yaml files.

Raises:

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

reset

reset()

Reset the index.

save

save()

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