PlaneswalkerLayout¶

`src.layouts.PlaneswalkerLayout` ¶

Bases: NormalLayout

Planeswalker card layout introduced in Lorwyn block.

Source code in src\layouts.py

class PlaneswalkerLayout(NormalLayout):
    """Planeswalker card layout introduced in Lorwyn block."""
    card_class: str = LayoutType.Planeswalker

    """
    * Text Info
    """

    @cached_property
    def oracle_text(self) -> str:
        """Fix Scryfall's minus character."""
        if self.is_alt_lang:
            return self.card.get('printed_text', self.card.get('oracle_text', '')).replace("\u2212", "-")
        return self.oracle_text_raw

    @cached_property
    def oracle_text_raw(self) -> str:
        """Fix Scryfall's minus character."""
        return super().oracle_text_raw.replace("\u2212", "-")

    """
    * Planeswalker Properties
    """

    @cached_property
    def loyalty(self) -> str:
        """Planeswalker starting loyalty."""
        return self.card.get('loyalty', '')

    @cached_property
    def pw_size(self) -> int:
        """Returns the size of this Planeswalker layout, usually based on number of abilities."""
        if self.name in planeswalkers_tall:
            # Special cases, long ability box
            return 4
        # Short ability box for 3 or less, otherwise tall box
        return 3 if len(self.pw_abilities) <= 3 else 4

    @cached_property
    def pw_abilities(self) -> list[dict]:
        """Processes Planeswalker text into listed abilities."""
        lines = CardTextPatterns.PLANESWALKER.findall(self.oracle_text_raw)
        en_lines = lines.copy()

        # Process alternate language lines if needed
        if self.is_alt_lang and 'printed_text' in self.card:

            # Separate alternate language lines
            alt_lines = self.oracle_text.split('\n')
            new_lines: list[str] = []
            for line in lines:

                # Ensure number of breaks matches alternate text
                breaks = line.count('\n') + 1
                if not alt_lines or not (len(alt_lines) >= breaks):
                    new_lines = lines
                    break

                # Slice and add lines
                new_lines.append('\n'.join(alt_lines[:breaks]))
                alt_lines = alt_lines[breaks:]

            # Replace with alternate language lines
            lines = new_lines

        # Create list of ability dictionaries
        abilities: list[dict] = []
        for i, line in enumerate(lines):
            index = en_lines[i].find(": ")
            abilities.append({
                # Activated ability
                'text': line[index + 1:].lstrip(),
                'icon': en_lines[i][0],
                'cost': en_lines[i][0:index]
            } if 5 > index > 0 else {
                # Static ability
                'text': line,
                'icon': None,
                'cost': None
            })
        return abilities

Attributes¶

`art_file: Path` ¶

`artist: str` ¶

Card artist name, prioritizes user provided artist name. Controls for duplicate last names.

`background: str` ¶

Identity of the background.

`card: dict` ¶

Main card data object to pull most relevant data from.

`card_class: str = LayoutType.Planeswalker` ¶

Text Info

`card_count: Optional[int]` ¶

int | None: Number of cards within the card's release set. Only required in 'Normal' Collector Mode.

`collector_data: str` ¶

`collector_number: int` ¶

`collector_number_raw: Optional[str]` ¶

str | None: Card number assigned within release set. Raw string representation, allows non-digits.

`color_identity: list[str]` ¶

Commander relevant color identity array, e.g. [W, U].

`color_indicator: str` ¶

Color indicator identity array, e.g. [W, U].

`creator: str` ¶

`date: date` ¶

`display_name: str` ¶

Card name, GUI appropriate representation.

`file: CardDetails` ¶

Dictionary containing parsed art file details.

`first_print: dict` ¶

Card data fetched from Scryfall representing the first print of this card.

`flavor_text: str` ¶

Card flavor text, alternate language version shares the same key.

`frame: FrameDetails` ¶

Dictionary containing calculated frame information.

`frame_effects: list[str]` ¶

Array of frame effects, e.g. nyxtouched, snow, etc.

`identity: str` ¶

Frame appropriate color identity of the card.

`input_name: str` ¶

Card name, version provided in art file name.

`is_alt_lang: bool` ¶

True if language selected isn't English.

`is_artifact: bool` ¶

True if card is an Artifact.

`is_basic_land: bool` ¶

True if card is a Basic Land.

`is_colorless: bool` ¶

True if card is colorless or devoid.

`is_companion: bool` ¶

True if card is a Companion.

`is_creature: bool` ¶

True if card is a Creature.

`is_emblem: bool` ¶

`is_front: bool` ¶

True if card is front face.

`is_hybrid: bool` ¶

True if card is a hybrid frame.

`is_land: bool` ¶

True if card is a Land.

`is_legendary: bool` ¶

True if card is Legendary.

`is_miracle: bool` ¶

True if card is a 'Miracle' card.

`is_nyx: bool` ¶

True if card has Nyx enchantment background texture.

`is_promo: bool` ¶

True if card is a promotional print.

`is_snow: bool` ¶

True if card is a 'Snow' card.

`is_token: bool` ¶

`is_vehicle: bool` ¶

True if card is a Vehicle.

`keywords: list[str]` ¶

Array of keyword abilities, e.g. Flying, Haste, etc.

`lang: str` ¶

Card print language, uppercase enforced, falls back to settings defined value.

`loyalty: str` ¶

Planeswalker starting loyalty.

`mana_cost: Optional[str]` ¶

Scryfall formatted card mana cost.

`name: str` ¶

Card name, supports alternate language source.

`name_raw: str` ¶

Card name, enforced English representation.

`nickname: str` ¶

Nickname, typically set inside template logic but can be passed in filename.

`oracle_text: str` ¶

Fix Scryfall's minus character.

`oracle_text_raw: str` ¶

Fix Scryfall's minus character.

`other_face: dict` ¶

Card data from opposing face if provided.

`other_face_frame: Union[FrameDetails, dict]` ¶

Calculated frame information of opposing face, if provided.

`other_face_left: Optional[str]` ¶

Abridged type of the opposing side to display on bottom MDFC bar.

`other_face_mana_cost: str` ¶

Mana cost of opposing face.

`other_face_oracle_text: str` ¶

Rules text of opposing face.

`other_face_oracle_text_raw: str` ¶

Rules text of opposing face.

`other_face_power: str` ¶

Creature power of opposing face, if provided.

`other_face_right: str` ¶

Mana cost or mana ability of opposing side, depending on land or nonland.

`other_face_toughness: str` ¶

Creature toughness of opposing face, if provided.

`other_face_twins: str` ¶

Name and title box identity of opposing face.

`other_face_type_line: str` ¶

Type line of opposing face.

`other_face_type_line_raw: str` ¶

Type line of opposing face, English language enforced.

`pinlines: str` ¶

Identity of the pinlines.

`power: str` ¶

Creature power, if provided.

`promo_types: list[str]` ¶

list[str]: Promo types this card matches, e.g. stamped, datestamped, etc.

`pw_abilities: list[dict]` ¶

Processes Planeswalker text into listed abilities.

`pw_size: int` ¶

Returns the size of this Planeswalker layout, usually based on number of abilities.

`rarity: str` ¶

Card rarity, interprets 'special' rarities based on card data.

`rarity_letter: str` ¶

First letter of card rarity, uppercase enforced.

`rarity_raw: str` ¶

Card rarity, doesn't interpret 'special' rarities.

`rules_text: str` ¶

Utility definition comprised of rules and flavor text as available.

`scryfall: dict` ¶

Card data fetched from Scryfall.

`scryfall_scan: str` ¶

Scryfall large image scan, if available.

`set: str` ¶

Card set code, uppercase enforced, falls back to 'MTG' if missing.

`set_data: dict` ¶

Set data from the current hexproof.io data file.

`set_type: str` ¶

`subtypes: list[str]` ¶

Subtypes represented, e.g. Elf, Human, Goblin, etc.

`supertypes: list[str]` ¶

Supertypes represented, e.g. Basic, Legendary, Snow, etc.

`symbol_code: str` ¶

Code used to match a symbol to this card's set. Provided by hexproof.io.

`symbol_svg: Optional[Path]` ¶

SVG path definition for card's expansion symbol.

`template_file: Path` ¶

Template PSD file path, replaced before render process.

`toughness: str` ¶

Creature toughness, if provided.

`transform_icon: str` ¶

Transform icon if provided, data possibly deprecated in modern practice.

`twins: str` ¶

Identity of the name and title boxes.

`type_line: str` ¶

Card type line, supports alternate language source.

`type_line_raw: str` ¶

Card type line, enforced English representation.

`types: list[str]` ¶

Main cards types represented, e.g. Sorcery, Instant, Creature, etc.

`types_raw: list[str]` ¶

List of types extracted from the raw typeline.

`watermark: Optional[str]` ¶

Name of the card's watermark file that is actually used, if provided.

`watermark_basic: Optional[Path]` ¶

Optional[Path]: Path to basic land watermark, if card is a Basic Land.

`watermark_raw: Optional[str]` ¶

Name of the card's watermark from raw Scryfall data, if provided.

`watermark_svg: Optional[Path]` ¶

Path to the watermark SVG file, if provided.

PlaneswalkerLayout¶

src.layouts.PlaneswalkerLayout ¶

Attributes¶

art_file: Path ¶

artist: str ¶

background: str ¶

card: dict ¶

card_class: str = LayoutType.Planeswalker ¶

card_count: Optional[int] ¶

collector_data: str ¶

collector_number: int ¶

collector_number_raw: Optional[str] ¶

color_identity: list[str] ¶

color_indicator: str ¶

creator: str ¶

date: date ¶

display_name: str ¶

file: CardDetails ¶

first_print: dict ¶

flavor_text: str ¶

frame: FrameDetails ¶

frame_effects: list[str] ¶

identity: str ¶

input_name: str ¶

is_alt_lang: bool ¶

is_artifact: bool ¶

is_basic_land: bool ¶

is_colorless: bool ¶

is_companion: bool ¶

is_creature: bool ¶

is_emblem: bool ¶

is_front: bool ¶

is_hybrid: bool ¶

is_land: bool ¶

is_legendary: bool ¶

is_miracle: bool ¶

is_nyx: bool ¶

is_promo: bool ¶

is_snow: bool ¶

is_token: bool ¶

is_vehicle: bool ¶

keywords: list[str] ¶

lang: str ¶

loyalty: str ¶

mana_cost: Optional[str] ¶

name: str ¶

name_raw: str ¶

nickname: str ¶

oracle_text: str ¶

oracle_text_raw: str ¶

other_face: dict ¶

other_face_frame: Union[FrameDetails, dict] ¶

other_face_left: Optional[str] ¶

other_face_mana_cost: str ¶

other_face_oracle_text: str ¶

other_face_oracle_text_raw: str ¶

other_face_power: str ¶

other_face_right: str ¶

other_face_toughness: str ¶

other_face_twins: str ¶

other_face_type_line: str ¶

other_face_type_line_raw: str ¶

pinlines: str ¶

power: str ¶

promo_types: list[str] ¶

pw_abilities: list[dict] ¶

pw_size: int ¶

rarity: str ¶

rarity_letter: str ¶

rarity_raw: str ¶

rules_text: str ¶

scryfall: dict ¶

scryfall_scan: str ¶

set: str ¶

set_data: dict ¶

set_type: str ¶

subtypes: list[str] ¶

supertypes: list[str] ¶

symbol_code: str ¶

symbol_svg: Optional[Path] ¶