Skip to content

Collection

is_collection_valid(collection)

Checks input collection file for compliance to prevent code breaking downstream. This is almost certainly not exhaustive.

Parameters:

Name Type Description Default
collection LazyFrame

Lazyframe of input collection file.

 required
Source code in src/mtg_pynance/collection.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def is_collection_valid(collection: pl.LazyFrame):
    """
    Checks input collection file for compliance to prevent code breaking downstream.
    This is almost certainly not exhaustive.

    Parameters
    ----------
    collection: pl.LazyFrame
        Lazyframe of input collection file.
    """
    num_cards: int = collection.select(pl.count()).collect().item()

    if collection.select(pl.col("cid")).count().collect().item() != num_cards:
        raise Exception(
            "Some cards are missing collection ID's! Check collection file!"
        )

    if (
        collection.select(pl.col("cid")).collect().unique(keep="any").height
        != num_cards
    ):
        raise Exception(
            "Not every card has a unique collection ID! Check collection file!"
        )

    # Note that polars seems to default interpret ints as int64
    schema = {
        "cid": pl.Int64,
        "id": pl.String,
        "foiling": pl.String,
        "purchase_price": pl.Float64,
    }
    if collection.collect_schema() != schema:
        raise Exception(
            textwrap.fill(
                f"""Some or all of the required columns in the collection file are not of the correct
                    data type. The required columns and their data types are {schema}."""
            )
        )

    if collection.select(pl.col("foiling")).count().collect().item() != num_cards:
        raise Exception("Some cards are missing foil types! Check collection file!")

    foil_types = ["none", "foil", "etched"]
    if (
        collection.filter(pl.col("foiling").is_in(foil_types)).collect().height
        != num_cards
    ):
        raise Exception("Some cards have invalid foil types! Check collection file!")

    if collection.select(pl.col("id")).count().collect().item() != num_cards:
        raise Exception("Some cards are missing ID's! Check collection file!")

    if (
        collection.select(pl.col("purchase_price")).count().collect().item()
        != num_cards
    ):
        raise Exception(
            "Some cards are missing purchase prices! Check collection file!"
        )

load_collection(collection_path)

Loads card collection csv file as lazyframe and checks if it is valid.

Parameters:

Name Type Description Default
collection_path Path

Path to the card collection csv file.

 required
Source code in src/mtg_pynance/collection.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def load_collection(collection_path: Path):
    """
    Loads card collection csv file as lazyframe and checks if it is valid.

    Parameters
    ----------
    collection_path: Path
        Path to the card collection csv file.
    """
    collection_lf: pl.LazyFrame = pl.scan_csv(collection_path)
    collection_lf: pl.LazyFrame = collection_lf.select(
        "cid", "id", "foiling", "purchase_price"
    )
    is_collection_valid(collection_lf)

    return collection_lf