Functions¶

def assign_layout(filename: Path) -> str | ForwardRef('CardLayout'):
    """Assign layout object to a card.

    Args:
        filename (Path): Path to the art file, filename supports optional tags.

    Filename Tags:
        | Tag        | Description                                                   |
        | ---------- | ------------------------------------------------------------- |
        | `(artist)` | Forces the card to use a different artist name.               |
        | `[set]`    | Uses a specific set printing when fetching Scryfall data.     |
        | `{number}` | Uses a specific collector number when fetching Scryfall data. |
        | `$creator` | Must be at the end of filename, indicates the creator.        |

    Returns:
        str | CardLayout: Layout object for this card.
    """
    # Get basic card information
    card = parse_card_info(filename)
    name_failed = osp.basename(str(card.get('file', 'None')))

    # Get scryfall data for the card
    scryfall = get_card_data(card, cfg=CFG, logger=CONSOLE)
    if not scryfall:
        return msg_error(name_failed, reason="Scryfall search failed")
    scryfall = process_card_data(scryfall, card)

    # Instantiate layout object
    if scryfall.get('layout', 'None') in layout_map:
        try:
            layout = layout_map[scryfall['layout']](scryfall, card)
        except Exception as e:
            # Couldn't instantiate layout object
            CONSOLE.log_exception(e)
            return msg_error(name_failed, reason="Layout generation failed")
        if not ENV.TEST_MODE:
            CONSOLE.update(f"{msg_success('FOUND:')} {str(layout)}")
        return layout
    # Couldn't find an appropriate layout
    return msg_error(name_failed, reason="Layout incompatible")

def join_dual_card_layouts(layouts: list[Union[str, 'CardLayout']]):
    """Join any layout objects that are dual sides of the same card, i.e. Split cards.

    Args:
        layouts: List of layout objects (or strings which are skipped).

    Returns:
        List of layouts, with split layouts joined.
    """
    # Check if we have any split cards
    normal: list[Union[str, CardLayout]] = [
        n for n in layouts
        if isinstance(n, str)
        or n.card_class != LayoutType.Split]
    split: list[SplitLayout] = [
        n for n in layouts
        if not isinstance(n, str)
        and n.card_class == LayoutType.Split]
    if not split:
        return normal

    # Join any identical split cards
    skip, add = [], []
    for card in split:
        if card in skip:
            continue
        for c in split:
            if c == card:
                continue
            if str(c) == str(card):
                # Order them according to name position
                card.art_file = [*card.art_file, *c.art_file] if (
                        normalize_str(card.name[0]) == normalize_str(card.file['name'])
                ) else [*c.art_file, *card.art_file]
                skip.extend([card, c])
        add.append(card)
    return [*normal, *add]