sigs¶

A special interest group (SIG).

Attributes:

Name	Type	Description
`parent`	`SIGIndex`	The parent SIGIndex instance.
`id`	`str`	The SIG ID, e.g. "sigsem".
`acronym`	`str`	The SIG's acronym or short name, e.g. "SIGSEM".
`name`	`str`	The SIG's full name.
`path`	`Path`	The path of the YAML file representing this SIG.
`url`	`Optional[str]`	A website URL for the SIG.

root

The Anthology instance to which this object belongs.

get_meetings_by_year()

Get all associated meetings, grouped by year.

Returns:

Type	Description
`dict[str, list[str \| SIGMeeting]]`	A dictionary where keys are strings representing years, and values are meetings of this SIG in that year.

load_from_yaml(parent, path)

Instantiates a SIG from its YAML file.

Parameters:

Name	Type	Description	Default
`parent`	`SIGIndex`	The parent SIGIndex instance.	required
`path`	`PathLike[str]`	The YAML file defining this SIG.	required

Warning

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

save(path=None)

Saves this SIG 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`

volumes()

Iterate over all volumes that are associated with this SIG.

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

Provides dictionary-like functionality mapping SIG IDs to SIG 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 sigs/*.yaml files.

Raises:

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

A meeting of a SIG that doesn't have a volume in the Anthology.

Attributes:

Name	Type	Description
`year`	`str`	The year of the meeting.
`name`	`str`	The name of the event/proceedings.
`url`	`Optional[str]`	A website URL for the meeting.