cable_club.data.models module

Models for data sent over the wire.

class cable_club.data.models.ContestStats

Bases: Model

Represent a Pokémon stats for contests.

beauty

cool

cute

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

sheen

smart

tough

class cable_club.data.models.EssentialDeluxeProperties

Bases: Model

Represent optional fields based on game/server configuration.

dmax_able

dmax_level

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

focus_type

gmax_factor

memento

scale

tera_type

class cable_club.data.models.Ev

Bases: Model

Represent a Pokemon’s EV.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

max_val: ClassVar[int] = 0

val

class cable_club.data.models.Iv

Bases: Model

Represent a Pokemon’s IV.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

max_val: ClassVar[int] = 0

maxed

val

class cable_club.data.models.Mail

Bases: Model

Data on a mail.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

item

msg

sender

species

class cable_club.data.models.Model

Bases: ABC

Base class for all data models.

Provides some common logic for all data models.

config: Config

Not present until configure() gets called.

abstract do_read_from(reader: Reader) → None

Model-specific reading.

final classmethod read_from(reader: Reader) → Self

Create an instance by reading values.

validate() → None

Run checks that can not be done in the fields (eg: inter-field relations).

Default to noop rather than being an abstractmethod because most models wont need to do anything here.

class cable_club.data.models.Move

Bases: Model

Represent a Pokemon’s move.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

name

names: ClassVar[set[str]] = {}

class cable_club.data.models.ObtainStats

Bases: Model

Represent how a Pokémon was obtained.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

hatched_map

level

map

mode

text

class cable_club.data.models.Party

Bases: Model

A team of Pokemon.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

pokemons

class cable_club.data.models.Pokemon

Bases: Model

Represent a Pokemon’s data.

ability

ability_index

ability_names: ClassVar[set[str]] = {}

contest_stats

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

essential_deluxe_properties

evs

exp

form

fusion

gender

happiness

item

item_names: ClassVar[set[str]] = {}

ivs

level

mail

mastered_moves

max_ev_sum: ClassVar[int] = 0

max_level: ClassVar[int] = 0

max_name_len: ClassVar[int] = 0

max_owner_name_len: ClassVar[int] = 0

name

nature_id

nature_stats_id

obtain_stats

owner_gender

owner_id

owner_name

personal_id

pokeball

pokeball_names: ClassVar[set[str]] = {}

pokerus

regular_moves

ribbons

shiny

sketched_moves

species

species_names: ClassVar[set[str]] = {}

steps_to_hatch

validate() → None

Run some checks between parsed attributes.

class cable_club.data.models.SketchedMove

Bases: Model

Represent a Pokemon’s move obtained via sketch.

do_read_from(reader: Reader) → None

Initialize an instance by reading input.

mastery

name

names: ClassVar[set[str]] = {}

ppup

cable_club.data.models.configure(config: Config) → None

Apply configuration on fields that depend on it.