Skip to content

Volume

BaseVolume

Bases: BaseModel

Contains fields for all Volumes.

ATTRIBUTE DESCRIPTION
aliases

List of names used by the Volume, collected in a string.

TYPE: str | None

api_url

Url to the resource in the Comicvine API.

TYPE: str

date_added

Date and time when the Volume was added.

TYPE: datetime

date_last_updated

Date and time when the Volume was last updated.

TYPE: datetime

description

Long description of the Volume.

TYPE: str | None

first_issue

First issue of the Volume.

TYPE: IssueEntry | None

id

Identifier used by Comicvine.

TYPE: int

image

Different sized images, posters and thumbnails for the Volume.

TYPE: Image

issue_count

Number of issues in the Volume.

TYPE: int

last_issue

Last issue of the Volume.

TYPE: IssueEntry | None

name

Name/Title of the Volume.

TYPE: str

publisher

The publisher of the Volume.

TYPE: GenericEntry | None

site_url

Url to the resource in Comicvine.

TYPE: str

start_year

The year the Volume started.

TYPE: int | None

summary

Short description of the Volume.

TYPE: str | None

Functions

validate_start_year(v: str) -> int | None

Convert start_year to int or None.

PARAMETER DESCRIPTION
v

String value of the start_year

TYPE: str

RETURNS DESCRIPTION
int | None

int or None version of the start_year

Volume

Bases: BaseVolume

Extends BaseVolume by including all the list references of a volume.

ATTRIBUTE DESCRIPTION
characters

List of characters in the Volume.

TYPE: list[CountEntry]

concepts

List of concepts in the Volume.

TYPE: list[CountEntry]

creators

List of creators in the Volume.

TYPE: list[CountEntry]

issues

List of issues in the Volume.

TYPE: list[IssueEntry]

locations

List of locations in the Volume.

TYPE: list[CountEntry]

objects

List of objects in the Volume.

TYPE: list[CountEntry]

VolumeEntry

Bases: BaseVolume

Contains all the fields available when viewing a list of Volumes.