sigs

SIG

A special interest group (SIG).

Attributes:

Name	Type	Description
id	str	The SIG ID, e.g. "sigsem".
parent	SIGIndex	The parent SIGIndex instance.
acronym	str	The SIG's acronym or short name, e.g. "SIGSEM".
name	str	The SIG's full name.
url	Optional[str]	A website URL for the SIG.
external_meetings	list[SIGMeeting]	A list of SIGMeeting instances recording meetings that are not part of the Anthology.
item_ids	set[AnthologyIDTuple]	An unordered set of volume IDs associated with this venue.

root property

root

The Anthology instance to which this object belongs.

get_meetings_by_year

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.

save

save(path=None)

Saves this SIG.

volumes

volumes()

Iterate over all volumes that are associated with this SIG.

SIGIndex

Bases: SlottedDict[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.
path	Path	The path to sigs.json.
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 data file has been loaded and the index has been built.

build

build()

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

Raises:

Type	Description
ValueError	If a volume lists a SIG ID that doesn't exist (i.e., isn't defined in sigs.json).

by_volume

by_volume(volume)

Find SIGs associated with a volume.

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 SIG.	required
acronym	str	The acronym of the new SIG.	required
name	str	The name of the new SIG.	required
**kwargs	Any	Any valid optional attribute of SIG, with the exception of item_ids, which cannot be set.	{}

Returns:

Type	Description
SIG	The created SIG object.

Raises:

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

load

load()

Load and parse the sigs.json file.

Raises:

Type	Description
KeyError	If a mandatory key is missing in a SIG entry.

reset

reset()

Reset the index.

save

save(path=None)

Save the sigs.json file.

Parameters:

Name	Type	Description	Default
path	Optional[StrPath]	The filename to save to. If None, defaults to the parent Anthology's sigs.json file.	None

SIGMeeting

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.