Skip to content

Volume

BaseVolume

Bases: BaseModel

Contains fields for all Volumes.

ATTRIBUTE DESCRIPTION
aliases

List of names used by the Volume, separated by ~\r\n.

TYPE: Optional[str]

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: Optional[str]

first_issue

First issue of the Volume.

TYPE: Optional[IssueEntry]

volume_id

Identifier used by Comicvine.

TYPE: int

image

Different sized images, posters and thumbnails for the Volume.

TYPE: ImageEntry

issue_count

Number of issues in the Volume.

TYPE: int

last_issue

Last issue of the Volume.

TYPE: Optional[IssueEntry]

name

Name/Title of the Volume.

TYPE: str

publisher

The publisher of the Volume.

TYPE: Optional[GenericEntry]

site_url

Url to the resource in Comicvine.

TYPE: str

start_year

The year the Volume started.

TYPE: Optional[int]

summary

Short description of the Volume.

TYPE: Optional[str]

Attributes

alias_list: List[str] property

List of aliases the Volume has used.

RETURNS DESCRIPTION
List[str]

List of aliases, split by ~\r\n

Functions

validate_start_year(v: str) -> Optional[int]

Convert start_year to int or None.

PARAMETER DESCRIPTION
v

String value of the start_year

TYPE: str

RETURNS DESCRIPTION
Optional[int]

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.