collections.volume

Volume

Bases: SlottedDict[Paper]

A publication volume.

Provides dictionary-like functionality mapping paper IDs to Paper objects in the volume.

Required Attributes:

Name	Type	Description
id	str	The ID of this volume (e.g. "1" or "main").
parent	Collection	The collection this volume belongs to.
type	VolumeType	Value indicating the type of publication, e.g., journal or conference proceedings.
title	MarkupText	The title of the volume. (Aliased to booktitle for initialization.)
year	str	The year of publication.

List Attributes:

Name	Type	Description
editors	list[NameSpecification]	Names of editors associated with this volume.
venue_ids	list[str]	List of venue IDs associated with this volume. See also venues.

Optional Attributes:

Name	Type	Description
address	Optional[str]	The publisher's address for this volume.
doi	Optional[str]	The DOI for the volume.
ingest_date	Optional[str]	The date of ingestion.
isbn	Optional[str]	The ISBN for the volume.
journal_issue	Optional[str]	The journal's issue number, if this volume belongs to a journal.
journal_volume	Optional[str]	The journal's volume number, if this volume belongs to a journal.
journal_title	Optional[str]	The journal's title (without volume/issue/subtitle), if this volume belongs to a journal.
month	Optional[str]	The month of publication.
pdf	Optional[PDFReference]	A reference to the volume's PDF.
publisher	Optional[str]	The volume's publisher.
shorttitle	Optional[MarkupText]	A shortened form of the title. (Aliased to shortbooktitle for initialization.)

collection_id property

collection_id

The collection ID this volume belongs to.

frontmatter property

frontmatter

Returns the volume's frontmatter, if any.

full_id property

full_id

The full anthology ID of this volume (e.g. "L06-1" or "2022.emnlp-main").

full_id_tuple property

full_id_tuple

The full anthology ID of this volume, as a tuple (e.g. ("L06", "1", None)).

has_frontmatter property

has_frontmatter

True if this volume has frontmatter.

is_workshop property

is_workshop

True if this volume is a workshop proceedings.

root property

root

The Anthology instance to which this object belongs.

from_xml classmethod

from_xml(parent, meta)

Instantiates a new volume from its <meta> block in the XML.

get_events

get_events()

Returns:

Type	Description
list[Event]	A list of events associated with this volume.

get_ingest_date

get_ingest_date()

Returns:

Type	Description
date	The date when this volume was added to the Anthology. If not set, will return constants.UNKNOWN_INGEST_DATE instead.

get_journal_title

get_journal_title()

Returns:

Type	Description
str	The journal title for this volume, fetching this information from the associated venue if it isn't explicit set.

Raises:

Type	Description
TypeError	If this volume doesn't represent a journal.
ValueError	If the journal title isn't explicitly set, but there isn't exactly one venue associated with this volume.

papers

papers()

An iterator over all Paper objects in this volume.

to_bibtex

to_bibtex()

Generate a BibTeX entry for this volume.

Returns:

Type	Description
str	The BibTeX entry for this volume as a formatted string. Currently, this is simply the frontmatter's BibTeX.

Raises:

Type	Description
Exception	If this volume has no frontmatter.

to_xml

to_xml(with_papers=True)

Serialize this volume in the Anthology XML format.

Parameters:

Name	Type	Description	Default
with_papers	bool	If False, the returned <volume> will only contain the volume's <meta> block, but no contained papers. Defaults to True.	True

Returns:

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

venues

venues()

A list of venues associated with this volume.