Skip to content

Options Analysis

This module provides a simplified implementation of a pandas-like options system.

It allows users to get, set, and reset various options that control the behavior of data display and processing. The module also includes a context manager for temporarily changing options.

Example

set_option('display.max_rows', 100) print(get_option('display.max_rows')) 100 with option_context('display.max_rows', 10): ... print(get_option('display.max_rows')) 10 print(get_option('display.max_rows')) 100

ColumnHelper

A class to help with column naming conventions.

Source code in pyretailscience/options.py 
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
class ColumnHelper:
    """A class to help with column naming conventions."""

    def __init__(self) -> None:
        """A class to help with column naming conventions."""
        # Date/Time
        self.transaction_date = get_option("column.transaction_date")
        self.transaction_time = get_option("column.transaction_time")
        # Customers
        self.customer_id = get_option("column.customer_id")
        self.agg_customer_id = get_option("column.agg.customer_id")
        self.agg_customer_id_p1 = self.join_options("column.agg.customer_id", "column.suffix.period_1")
        self.agg_customer_id_p2 = self.join_options("column.agg.customer_id", "column.suffix.period_2")
        self.agg_customer_id_diff = self.join_options("column.agg.customer_id", "column.suffix.difference")
        self.agg_customer_id_pct_diff = self.join_options("column.agg.customer_id", "column.suffix.percent_difference")
        self.agg_customer_id_contrib = self.join_options("column.agg.customer_id", "column.suffix.contribution")
        self.customers_pct = self.join_options("column.agg.customer_id", "column.suffix.percent")
        # Transactions
        self.transaction_id = get_option("column.transaction_id")
        self.agg_transaction_id = get_option("column.agg.transaction_id")
        self.agg_transaction_id_p1 = self.join_options("column.agg.transaction_id", "column.suffix.period_1")
        self.agg_transaction_id_p2 = self.join_options("column.agg.transaction_id", "column.suffix.period_2")
        self.agg_transaction_id_diff = self.join_options("column.agg.transaction_id", "column.suffix.difference")
        self.agg_transaction_id_pct_diff = self.join_options(
            "column.agg.transaction_id",
            "column.suffix.percent_difference",
        )
        # Unit Spend
        self.unit_spend = get_option("column.unit_spend")
        self.agg_unit_spend = get_option("column.agg.unit_spend")
        self.agg_unit_spend_p1 = self.join_options("column.agg.unit_spend", "column.suffix.period_1")
        self.agg_unit_spend_p2 = self.join_options("column.agg.unit_spend", "column.suffix.period_2")
        self.agg_unit_spend_diff = self.join_options("column.agg.unit_spend", "column.suffix.difference")
        self.agg_unit_spend_pct_diff = self.join_options("column.agg.unit_spend", "column.suffix.percent_difference")
        # Spend / Customer
        self.calc_spend_per_cust = get_option("column.calc.spend_per_customer")
        self.calc_spend_per_cust_p1 = self.join_options("column.calc.spend_per_customer", "column.suffix.period_1")
        self.calc_spend_per_cust_p2 = self.join_options("column.calc.spend_per_customer", "column.suffix.period_2")
        self.calc_spend_per_cust_diff = self.join_options("column.calc.spend_per_customer", "column.suffix.difference")
        self.calc_spend_per_cust_pct_diff = self.join_options(
            "column.calc.spend_per_customer",
            "column.suffix.percent_difference",
        )
        self.calc_spend_per_cust_contrib = self.join_options(
            "column.calc.spend_per_customer",
            "column.suffix.contribution",
        )
        # Transactions / Customer
        self.calc_trans_per_cust = get_option("column.calc.transactions_per_customer")
        self.calc_trans_per_cust_p1 = self.join_options(
            "column.calc.transactions_per_customer",
            "column.suffix.period_1",
        )
        self.calc_trans_per_cust_p2 = self.join_options(
            "column.calc.transactions_per_customer",
            "column.suffix.period_2",
        )
        self.calc_trans_per_cust_diff = self.join_options(
            "column.calc.transactions_per_customer",
            "column.suffix.difference",
        )
        self.calc_trans_per_cust_pct_diff = self.join_options(
            "column.calc.transactions_per_customer",
            "column.suffix.percent_difference",
        )
        self.calc_trans_per_cust_contrib = self.join_options(
            "column.calc.transactions_per_customer",
            "column.suffix.contribution",
        )
        # Spend / Transaction
        self.calc_spend_per_trans = get_option("column.calc.spend_per_transaction")
        self.calc_spend_per_trans_p1 = self.join_options("column.calc.spend_per_transaction", "column.suffix.period_1")
        self.calc_spend_per_trans_p2 = self.join_options("column.calc.spend_per_transaction", "column.suffix.period_2")
        self.calc_spend_per_trans_diff = self.join_options(
            "column.calc.spend_per_transaction",
            "column.suffix.difference",
        )
        self.calc_spend_per_trans_pct_diff = self.join_options(
            "column.calc.spend_per_transaction",
            "column.suffix.percent_difference",
        )
        self.calc_spend_per_trans_contrib = self.join_options(
            "column.calc.spend_per_transaction",
            "column.suffix.contribution",
        )
        # Unit Quantity
        self.unit_qty = get_option("column.unit_quantity")
        self.agg_unit_qty = get_option("column.agg.unit_quantity")
        self.agg_unit_qty_p1 = self.join_options("column.agg.unit_quantity", "column.suffix.period_1")
        self.agg_unit_qty_p2 = self.join_options("column.agg.unit_quantity", "column.suffix.period_2")
        self.agg_unit_qty_diff = self.join_options("column.agg.unit_quantity", "column.suffix.difference")
        self.agg_unit_qty_pct_diff = self.join_options("column.agg.unit_quantity", "column.suffix.percent_difference")
        # Units / Transaction
        self.calc_units_per_trans = get_option("column.calc.units_per_transaction")
        self.calc_units_per_trans_p1 = self.join_options("column.calc.units_per_transaction", "column.suffix.period_1")
        self.calc_units_per_trans_p2 = self.join_options("column.calc.units_per_transaction", "column.suffix.period_2")
        self.calc_units_per_trans_diff = self.join_options(
            "column.calc.units_per_transaction",
            "column.suffix.difference",
        )
        self.calc_units_per_trans_pct_diff = self.join_options(
            "column.calc.units_per_transaction",
            "column.suffix.percent_difference",
        )
        self.calc_units_per_trans_contrib = self.join_options(
            "column.calc.units_per_transaction",
            "column.suffix.contribution",
        )
        # Price / Unit
        self.calc_price_per_unit = get_option("column.calc.price_per_unit")
        self.calc_price_per_unit_p1 = self.join_options("column.calc.price_per_unit", "column.suffix.period_1")
        self.calc_price_per_unit_p2 = self.join_options("column.calc.price_per_unit", "column.suffix.period_2")
        self.calc_price_per_unit_diff = self.join_options("column.calc.price_per_unit", "column.suffix.difference")
        self.calc_price_per_unit_pct_diff = self.join_options(
            "column.calc.price_per_unit",
            "column.suffix.percent_difference",
        )
        self.calc_price_per_unit_contrib = self.join_options("column.calc.price_per_unit", "column.suffix.contribution")
        # Cost
        self.unit_cost = get_option("column.unit_cost")
        self.agg_unit_cost = get_option("column.agg.unit_cost")
        self.agg_unit_cost_p1 = self.join_options("column.agg.unit_cost", "column.suffix.period_1")
        self.agg_unit_cost_p2 = self.join_options("column.agg.unit_cost", "column.suffix.period_2")
        self.agg_unit_cost_diff = self.join_options("column.agg.unit_cost", "column.suffix.difference")
        self.agg_unit_cost_pct_diff = self.join_options("column.agg.unit_cost", "column.suffix.percent_difference")
        # Promo Unit Spend
        self.promo_unit_spend = get_option("column.promo_unit_spend")
        self.agg_promo_unit_spend = get_option("column.agg.promo_unit_spend")
        self.agg_promo_unit_spend_p1 = self.join_options("column.agg.promo_unit_spend", "column.suffix.period_1")
        self.agg_promo_unit_spend_p2 = self.join_options("column.agg.promo_unit_spend", "column.suffix.period_2")
        self.agg_promo_unit_spend_diff = self.join_options("column.agg.promo_unit_spend", "column.suffix.difference")
        self.agg_promo_unit_spend_pct_diff = self.join_options(
            "column.agg.promo_unit_spend",
            "column.suffix.percent_difference",
        )
        # Promo Unit Quantity
        self.promo_unit_qty = get_option("column.promo_unit_quantity")
        self.agg_promo_unit_qty = get_option("column.agg.promo_unit_quantity")
        self.agg_promo_unit_qty_p1 = self.join_options("column.agg.promo_unit_quantity", "column.suffix.period_1")
        self.agg_promo_unit_qty_p2 = self.join_options("column.agg.promo_unit_quantity", "column.suffix.period_2")
        self.agg_promo_unit_qty_diff = self.join_options("column.agg.promo_unit_quantity", "column.suffix.difference")
        self.agg_promo_unit_qty_pct_diff = self.join_options(
            "column.agg.promo_unit_quantity",
            "column.suffix.percent_difference",
        )
        # Elasticity
        self.calc_price_elasticity = get_option("column.calc.price_elasticity")
        self.calc_frequency_elasticity = get_option("column.calc.frequency_elasticity")

    @staticmethod
    def join_options(*args: str, sep: str = "_") -> str:
        """A helper function to join multiple options together."""
        return sep.join(map(get_option, args))

__init__()

A class to help with column naming conventions.

Source code in pyretailscience/options.py 
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
def __init__(self) -> None:
    """A class to help with column naming conventions."""
    # Date/Time
    self.transaction_date = get_option("column.transaction_date")
    self.transaction_time = get_option("column.transaction_time")
    # Customers
    self.customer_id = get_option("column.customer_id")
    self.agg_customer_id = get_option("column.agg.customer_id")
    self.agg_customer_id_p1 = self.join_options("column.agg.customer_id", "column.suffix.period_1")
    self.agg_customer_id_p2 = self.join_options("column.agg.customer_id", "column.suffix.period_2")
    self.agg_customer_id_diff = self.join_options("column.agg.customer_id", "column.suffix.difference")
    self.agg_customer_id_pct_diff = self.join_options("column.agg.customer_id", "column.suffix.percent_difference")
    self.agg_customer_id_contrib = self.join_options("column.agg.customer_id", "column.suffix.contribution")
    self.customers_pct = self.join_options("column.agg.customer_id", "column.suffix.percent")
    # Transactions
    self.transaction_id = get_option("column.transaction_id")
    self.agg_transaction_id = get_option("column.agg.transaction_id")
    self.agg_transaction_id_p1 = self.join_options("column.agg.transaction_id", "column.suffix.period_1")
    self.agg_transaction_id_p2 = self.join_options("column.agg.transaction_id", "column.suffix.period_2")
    self.agg_transaction_id_diff = self.join_options("column.agg.transaction_id", "column.suffix.difference")
    self.agg_transaction_id_pct_diff = self.join_options(
        "column.agg.transaction_id",
        "column.suffix.percent_difference",
    )
    # Unit Spend
    self.unit_spend = get_option("column.unit_spend")
    self.agg_unit_spend = get_option("column.agg.unit_spend")
    self.agg_unit_spend_p1 = self.join_options("column.agg.unit_spend", "column.suffix.period_1")
    self.agg_unit_spend_p2 = self.join_options("column.agg.unit_spend", "column.suffix.period_2")
    self.agg_unit_spend_diff = self.join_options("column.agg.unit_spend", "column.suffix.difference")
    self.agg_unit_spend_pct_diff = self.join_options("column.agg.unit_spend", "column.suffix.percent_difference")
    # Spend / Customer
    self.calc_spend_per_cust = get_option("column.calc.spend_per_customer")
    self.calc_spend_per_cust_p1 = self.join_options("column.calc.spend_per_customer", "column.suffix.period_1")
    self.calc_spend_per_cust_p2 = self.join_options("column.calc.spend_per_customer", "column.suffix.period_2")
    self.calc_spend_per_cust_diff = self.join_options("column.calc.spend_per_customer", "column.suffix.difference")
    self.calc_spend_per_cust_pct_diff = self.join_options(
        "column.calc.spend_per_customer",
        "column.suffix.percent_difference",
    )
    self.calc_spend_per_cust_contrib = self.join_options(
        "column.calc.spend_per_customer",
        "column.suffix.contribution",
    )
    # Transactions / Customer
    self.calc_trans_per_cust = get_option("column.calc.transactions_per_customer")
    self.calc_trans_per_cust_p1 = self.join_options(
        "column.calc.transactions_per_customer",
        "column.suffix.period_1",
    )
    self.calc_trans_per_cust_p2 = self.join_options(
        "column.calc.transactions_per_customer",
        "column.suffix.period_2",
    )
    self.calc_trans_per_cust_diff = self.join_options(
        "column.calc.transactions_per_customer",
        "column.suffix.difference",
    )
    self.calc_trans_per_cust_pct_diff = self.join_options(
        "column.calc.transactions_per_customer",
        "column.suffix.percent_difference",
    )
    self.calc_trans_per_cust_contrib = self.join_options(
        "column.calc.transactions_per_customer",
        "column.suffix.contribution",
    )
    # Spend / Transaction
    self.calc_spend_per_trans = get_option("column.calc.spend_per_transaction")
    self.calc_spend_per_trans_p1 = self.join_options("column.calc.spend_per_transaction", "column.suffix.period_1")
    self.calc_spend_per_trans_p2 = self.join_options("column.calc.spend_per_transaction", "column.suffix.period_2")
    self.calc_spend_per_trans_diff = self.join_options(
        "column.calc.spend_per_transaction",
        "column.suffix.difference",
    )
    self.calc_spend_per_trans_pct_diff = self.join_options(
        "column.calc.spend_per_transaction",
        "column.suffix.percent_difference",
    )
    self.calc_spend_per_trans_contrib = self.join_options(
        "column.calc.spend_per_transaction",
        "column.suffix.contribution",
    )
    # Unit Quantity
    self.unit_qty = get_option("column.unit_quantity")
    self.agg_unit_qty = get_option("column.agg.unit_quantity")
    self.agg_unit_qty_p1 = self.join_options("column.agg.unit_quantity", "column.suffix.period_1")
    self.agg_unit_qty_p2 = self.join_options("column.agg.unit_quantity", "column.suffix.period_2")
    self.agg_unit_qty_diff = self.join_options("column.agg.unit_quantity", "column.suffix.difference")
    self.agg_unit_qty_pct_diff = self.join_options("column.agg.unit_quantity", "column.suffix.percent_difference")
    # Units / Transaction
    self.calc_units_per_trans = get_option("column.calc.units_per_transaction")
    self.calc_units_per_trans_p1 = self.join_options("column.calc.units_per_transaction", "column.suffix.period_1")
    self.calc_units_per_trans_p2 = self.join_options("column.calc.units_per_transaction", "column.suffix.period_2")
    self.calc_units_per_trans_diff = self.join_options(
        "column.calc.units_per_transaction",
        "column.suffix.difference",
    )
    self.calc_units_per_trans_pct_diff = self.join_options(
        "column.calc.units_per_transaction",
        "column.suffix.percent_difference",
    )
    self.calc_units_per_trans_contrib = self.join_options(
        "column.calc.units_per_transaction",
        "column.suffix.contribution",
    )
    # Price / Unit
    self.calc_price_per_unit = get_option("column.calc.price_per_unit")
    self.calc_price_per_unit_p1 = self.join_options("column.calc.price_per_unit", "column.suffix.period_1")
    self.calc_price_per_unit_p2 = self.join_options("column.calc.price_per_unit", "column.suffix.period_2")
    self.calc_price_per_unit_diff = self.join_options("column.calc.price_per_unit", "column.suffix.difference")
    self.calc_price_per_unit_pct_diff = self.join_options(
        "column.calc.price_per_unit",
        "column.suffix.percent_difference",
    )
    self.calc_price_per_unit_contrib = self.join_options("column.calc.price_per_unit", "column.suffix.contribution")
    # Cost
    self.unit_cost = get_option("column.unit_cost")
    self.agg_unit_cost = get_option("column.agg.unit_cost")
    self.agg_unit_cost_p1 = self.join_options("column.agg.unit_cost", "column.suffix.period_1")
    self.agg_unit_cost_p2 = self.join_options("column.agg.unit_cost", "column.suffix.period_2")
    self.agg_unit_cost_diff = self.join_options("column.agg.unit_cost", "column.suffix.difference")
    self.agg_unit_cost_pct_diff = self.join_options("column.agg.unit_cost", "column.suffix.percent_difference")
    # Promo Unit Spend
    self.promo_unit_spend = get_option("column.promo_unit_spend")
    self.agg_promo_unit_spend = get_option("column.agg.promo_unit_spend")
    self.agg_promo_unit_spend_p1 = self.join_options("column.agg.promo_unit_spend", "column.suffix.period_1")
    self.agg_promo_unit_spend_p2 = self.join_options("column.agg.promo_unit_spend", "column.suffix.period_2")
    self.agg_promo_unit_spend_diff = self.join_options("column.agg.promo_unit_spend", "column.suffix.difference")
    self.agg_promo_unit_spend_pct_diff = self.join_options(
        "column.agg.promo_unit_spend",
        "column.suffix.percent_difference",
    )
    # Promo Unit Quantity
    self.promo_unit_qty = get_option("column.promo_unit_quantity")
    self.agg_promo_unit_qty = get_option("column.agg.promo_unit_quantity")
    self.agg_promo_unit_qty_p1 = self.join_options("column.agg.promo_unit_quantity", "column.suffix.period_1")
    self.agg_promo_unit_qty_p2 = self.join_options("column.agg.promo_unit_quantity", "column.suffix.period_2")
    self.agg_promo_unit_qty_diff = self.join_options("column.agg.promo_unit_quantity", "column.suffix.difference")
    self.agg_promo_unit_qty_pct_diff = self.join_options(
        "column.agg.promo_unit_quantity",
        "column.suffix.percent_difference",
    )
    # Elasticity
    self.calc_price_elasticity = get_option("column.calc.price_elasticity")
    self.calc_frequency_elasticity = get_option("column.calc.frequency_elasticity")

join_options(*args, sep='_') staticmethod

A helper function to join multiple options together.

Source code in pyretailscience/options.py 
557
558
559
560
@staticmethod
def join_options(*args: str, sep: str = "_") -> str:
    """A helper function to join multiple options together."""
    return sep.join(map(get_option, args))

Options

A class to manage configurable options.

Source code in pyretailscience/options.py 
 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
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
class Options:
    """A class to manage configurable options."""

    def __init__(self) -> None:
        """Initializes the options with default values."""
        self._options: dict[str, OptionTypes] = {
            # Database columns
            "column.customer_id": "customer_id",
            "column.transaction_id": "transaction_id",
            "column.transaction_date": "transaction_date",
            "column.transaction_time": "transaction_time",
            "column.product_id": "product_id",
            "column.unit_quantity": "unit_quantity",
            "column.unit_price": "unit_price",
            "column.unit_spend": "unit_spend",
            "column.unit_cost": "unit_cost",
            "column.promo_unit_spend": "promo_unit_spend",
            "column.promo_unit_quantity": "promo_unit_quantity",
            "column.store_id": "store_id",
            # Aggregation columns
            "column.agg.customer_id": "customers",
            "column.agg.transaction_id": "transactions",
            "column.agg.product_id": "products",
            "column.agg.unit_quantity": "units",
            "column.agg.unit_price": "prices",
            "column.agg.unit_spend": "spend",
            "column.agg.unit_cost": "costs",
            "column.agg.promo_unit_spend": "promo_spend",
            "column.agg.promo_unit_quantity": "promo_quantity",
            "column.agg.store_id": "stores",
            # Calculated columns
            "column.calc.price_per_unit": "price_per_unit",
            "column.calc.units_per_transaction": "units_per_transaction",
            "column.calc.spend_per_customer": "spend_per_customer",
            "column.calc.spend_per_transaction": "spend_per_transaction",
            "column.calc.transactions_per_customer": "transactions_per_customer",
            "column.calc.price_elasticity": "price_elasticity",
            "column.calc.frequency_elasticity": "frequency_elasticity",
            # Abbreviation suffix
            "column.suffix.count": "cnt",
            "column.suffix.percent": "pct",
            "column.suffix.difference": "diff",
            "column.suffix.percent_difference": "pct_diff",
            "column.suffix.contribution": "contrib",
            "column.suffix.period_1": "p1",
            "column.suffix.period_2": "p2",
        }
        self._descriptions: dict[str, str] = {
            # Database columns
            "column.customer_id": "The name of the column containing customer IDs.",
            "column.transaction_id": "The name of the column containing transaction IDs.",
            "column.transaction_date": "The name of the column containing transaction dates.",
            "column.transaction_time": "The name of the column containing transaction times.",
            "column.product_id": "The name of the column containing product IDs.",
            "column.unit_quantity": "The name of the column containing the number of units sold.",
            "column.unit_price": "The name of the column containing the unit price of the product.",
            "column.unit_spend": (
                "The name of the column containing the total spend of the products in the transaction."
                "ie, unit_price * units",
            ),
            "column.unit_cost": (
                "The name of the column containing the total cost of the products in the transaction. "
                "ie, single unit cost * units",
            ),
            "column.promo_unit_spend": (
                "The name of the column containing the total spend on promotion of the products in the transaction. "
                "ie, promotional unit price * units",
            ),
            "column.promo_unit_quantity": ("The name of the column containing the number of units sold on promotion."),
            "column.store_id": "The name of the column containing store IDs of the transaction.",
            # Aggregation columns
            "column.agg.customer_id": "The name of the column containing the number of unique customers.",
            "column.agg.transaction_id": "The name of the column containing the number of transactions.",
            "column.agg.product_id": "The name of the column containing the number of unique products.",
            "column.agg.unit_quantity": "The name of the column containing the total number of units sold.",
            "column.agg.unit_price": "The name of the column containing the total unit price of products.",
            "column.agg.unit_spend": (
                "The name of the column containing the total spend of the units in the transaction."
            ),
            "column.agg.unit_cost": "The name of the column containing the total unit cost of products.",
            "column.agg.promo_unit_spend": (
                "The name of the column containing the total promotional spend of the units in the transaction."
            ),
            "column.agg.promo_unit_quantity": (
                "The name of the column containing the total number of units sold on promotion."
            ),
            "column.agg.store_id": "The name of the column containing the number of unique stores.",
            # Calculated columns
            "column.calc.price_per_unit": "The name of the column containing the price per unit.",
            "column.calc.units_per_transaction": "The name of the column containing the units per transaction.",
            "column.calc.spend_per_customer": "The name of the column containing the spend per customer.",
            "column.calc.spend_per_transaction": "The name of the column containing the spend per transaction.",
            "column.calc.transactions_per_customer": "The name of the column containing the transactions per customer.",
            "column.calc.price_elasticity": "The name of the column containing the price elasticity calculation.",
            "column.calc.frequency_elasticity": "The name of the column containing the price frequency calculation.",
            # Abbreviation suffixes
            "column.suffix.count": "The suffix to use for count columns.",
            "column.suffix.percent": "The suffix to use for percentage columns.",
            "column.suffix.difference": "The suffix to use for difference columns.",
            "column.suffix.percent_difference": "The suffix to use for percentage difference columns.",
            "column.suffix.contribution": "The suffix to use for revenue contribution columns.",
            "column.suffix.period_1": (
                "The suffix to use for period 1 columns. Often this could represent last year for instance."
            ),
            "column.suffix.period_2": (
                "The suffix to use for period 2 columns. Often this could represent this year for instance."
            ),
        }
        self._default_options: dict[str, OptionTypes] = self._options.copy()

    def set_option(self, pat: str, val: OptionTypes) -> None:
        """Set the value of the specified option.

        Args:
            pat: The option name.
            val: The value to set the option to.

        Raises:
            ValueError: If the option name is unknown.
        """
        if pat not in self._options:
            msg = f"Unknown option: {pat}"
            raise ValueError(msg)

        self._options[pat] = val

    def get_option(self, pat: str) -> OptionTypes:
        """Get the value of the specified option.

        Args:
            pat: The option name.

        Returns:
            The value of the option.

        Raises:
            ValueError: If the option name is unknown.
        """
        if pat in self._options:
            return self._options[pat]

        msg = f"Unknown option: {pat}"
        raise ValueError(msg)

    def reset_option(self, pat: str) -> None:
        """Reset the specified option to its default value.

        Args:
            pat: The option name.

        Raises:
            ValueError: If the option name is unknown.
        """
        if pat not in self._options:
            msg = f"Unknown option: {pat}"
            raise ValueError(msg)

        self._options[pat] = self._default_options[pat]

    def list_options(self) -> list[str]:
        """List all available options.

        Returns:
            A list of all option names.
        """
        return list(self._options.keys())

    def describe_option(self, pat: str) -> str:
        """Describe the specified option.

        Args:
            pat: The option name.

        Returns:
            A string describing the option and its current value.

        Raises:
            ValueError: If the option name is unknown.
        """
        if pat in self._descriptions:
            return f"{pat}: {self._descriptions[pat]} (current value: {self._options[pat]})"

        msg = f"Unknown option: {pat}"
        raise ValueError(msg)

    @staticmethod
    def flatten_options(k: str, v: OptionTypes, parent_key: str = "") -> dict[str, OptionTypes]:
        """Flatten nested options into a single dictionary."""
        if parent_key != "":
            parent_key += "."

        if isinstance(v, dict):
            ret_dict = {}
            for sub_key, sub_value in v.items():
                ret_dict.update(Options.flatten_options(sub_key, sub_value, parent_key=f"{parent_key}{k}"))
            return ret_dict

        return {f"{parent_key}{k}": v}

    @classmethod
    def load_from_project(cls) -> "Options":
        """Try to load options from a pyretailscience.toml file in the project root directory.

        If the project root directory cannot be found, return a default Options instance.

        Returns:
            An Options instance with options loaded from the pyretailscience.toml file or default
        """
        options_instance = cls()

        project_root = find_project_root()
        if project_root is None:
            return options_instance

        toml_file = Path(project_root) / "pyretailscience.toml"
        if toml_file.is_file():
            return Options.load_from_toml(toml_file)

        return options_instance

    @classmethod
    def load_from_toml(cls, file_path: str) -> "Options":
        """Load options from a TOML file.

        Args:
            file_path: The path to the TOML file.

        Raises:
            ValueError: If the TOML file contains unknown options.
        """
        options_instance = cls()

        with open(file_path) as f:
            toml_data = toml.load(f)

        for section, options in toml_data.items():
            for option_name, option_value in Options.flatten_options(section, options).items():
                if option_name in options_instance._options:
                    options_instance.set_option(option_name, option_value)
                else:
                    msg = f"Unknown option in TOML file: {option_name}"
                    raise ValueError(msg)

        return options_instance

__init__()

Initializes the options with default values.

Source code in pyretailscience/options.py 
 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
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def __init__(self) -> None:
    """Initializes the options with default values."""
    self._options: dict[str, OptionTypes] = {
        # Database columns
        "column.customer_id": "customer_id",
        "column.transaction_id": "transaction_id",
        "column.transaction_date": "transaction_date",
        "column.transaction_time": "transaction_time",
        "column.product_id": "product_id",
        "column.unit_quantity": "unit_quantity",
        "column.unit_price": "unit_price",
        "column.unit_spend": "unit_spend",
        "column.unit_cost": "unit_cost",
        "column.promo_unit_spend": "promo_unit_spend",
        "column.promo_unit_quantity": "promo_unit_quantity",
        "column.store_id": "store_id",
        # Aggregation columns
        "column.agg.customer_id": "customers",
        "column.agg.transaction_id": "transactions",
        "column.agg.product_id": "products",
        "column.agg.unit_quantity": "units",
        "column.agg.unit_price": "prices",
        "column.agg.unit_spend": "spend",
        "column.agg.unit_cost": "costs",
        "column.agg.promo_unit_spend": "promo_spend",
        "column.agg.promo_unit_quantity": "promo_quantity",
        "column.agg.store_id": "stores",
        # Calculated columns
        "column.calc.price_per_unit": "price_per_unit",
        "column.calc.units_per_transaction": "units_per_transaction",
        "column.calc.spend_per_customer": "spend_per_customer",
        "column.calc.spend_per_transaction": "spend_per_transaction",
        "column.calc.transactions_per_customer": "transactions_per_customer",
        "column.calc.price_elasticity": "price_elasticity",
        "column.calc.frequency_elasticity": "frequency_elasticity",
        # Abbreviation suffix
        "column.suffix.count": "cnt",
        "column.suffix.percent": "pct",
        "column.suffix.difference": "diff",
        "column.suffix.percent_difference": "pct_diff",
        "column.suffix.contribution": "contrib",
        "column.suffix.period_1": "p1",
        "column.suffix.period_2": "p2",
    }
    self._descriptions: dict[str, str] = {
        # Database columns
        "column.customer_id": "The name of the column containing customer IDs.",
        "column.transaction_id": "The name of the column containing transaction IDs.",
        "column.transaction_date": "The name of the column containing transaction dates.",
        "column.transaction_time": "The name of the column containing transaction times.",
        "column.product_id": "The name of the column containing product IDs.",
        "column.unit_quantity": "The name of the column containing the number of units sold.",
        "column.unit_price": "The name of the column containing the unit price of the product.",
        "column.unit_spend": (
            "The name of the column containing the total spend of the products in the transaction."
            "ie, unit_price * units",
        ),
        "column.unit_cost": (
            "The name of the column containing the total cost of the products in the transaction. "
            "ie, single unit cost * units",
        ),
        "column.promo_unit_spend": (
            "The name of the column containing the total spend on promotion of the products in the transaction. "
            "ie, promotional unit price * units",
        ),
        "column.promo_unit_quantity": ("The name of the column containing the number of units sold on promotion."),
        "column.store_id": "The name of the column containing store IDs of the transaction.",
        # Aggregation columns
        "column.agg.customer_id": "The name of the column containing the number of unique customers.",
        "column.agg.transaction_id": "The name of the column containing the number of transactions.",
        "column.agg.product_id": "The name of the column containing the number of unique products.",
        "column.agg.unit_quantity": "The name of the column containing the total number of units sold.",
        "column.agg.unit_price": "The name of the column containing the total unit price of products.",
        "column.agg.unit_spend": (
            "The name of the column containing the total spend of the units in the transaction."
        ),
        "column.agg.unit_cost": "The name of the column containing the total unit cost of products.",
        "column.agg.promo_unit_spend": (
            "The name of the column containing the total promotional spend of the units in the transaction."
        ),
        "column.agg.promo_unit_quantity": (
            "The name of the column containing the total number of units sold on promotion."
        ),
        "column.agg.store_id": "The name of the column containing the number of unique stores.",
        # Calculated columns
        "column.calc.price_per_unit": "The name of the column containing the price per unit.",
        "column.calc.units_per_transaction": "The name of the column containing the units per transaction.",
        "column.calc.spend_per_customer": "The name of the column containing the spend per customer.",
        "column.calc.spend_per_transaction": "The name of the column containing the spend per transaction.",
        "column.calc.transactions_per_customer": "The name of the column containing the transactions per customer.",
        "column.calc.price_elasticity": "The name of the column containing the price elasticity calculation.",
        "column.calc.frequency_elasticity": "The name of the column containing the price frequency calculation.",
        # Abbreviation suffixes
        "column.suffix.count": "The suffix to use for count columns.",
        "column.suffix.percent": "The suffix to use for percentage columns.",
        "column.suffix.difference": "The suffix to use for difference columns.",
        "column.suffix.percent_difference": "The suffix to use for percentage difference columns.",
        "column.suffix.contribution": "The suffix to use for revenue contribution columns.",
        "column.suffix.period_1": (
            "The suffix to use for period 1 columns. Often this could represent last year for instance."
        ),
        "column.suffix.period_2": (
            "The suffix to use for period 2 columns. Often this could represent this year for instance."
        ),
    }
    self._default_options: dict[str, OptionTypes] = self._options.copy()

describe_option(pat)

Describe the specified option.

Parameters:

Name Type Description Default
pat str

The option name.

 required

Returns:

Type Description
str

A string describing the option and its current value.

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def describe_option(self, pat: str) -> str:
    """Describe the specified option.

    Args:
        pat: The option name.

    Returns:
        A string describing the option and its current value.

    Raises:
        ValueError: If the option name is unknown.
    """
    if pat in self._descriptions:
        return f"{pat}: {self._descriptions[pat]} (current value: {self._options[pat]})"

    msg = f"Unknown option: {pat}"
    raise ValueError(msg)

flatten_options(k, v, parent_key='') staticmethod

Flatten nested options into a single dictionary.

Source code in pyretailscience/options.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
@staticmethod
def flatten_options(k: str, v: OptionTypes, parent_key: str = "") -> dict[str, OptionTypes]:
    """Flatten nested options into a single dictionary."""
    if parent_key != "":
        parent_key += "."

    if isinstance(v, dict):
        ret_dict = {}
        for sub_key, sub_value in v.items():
            ret_dict.update(Options.flatten_options(sub_key, sub_value, parent_key=f"{parent_key}{k}"))
        return ret_dict

    return {f"{parent_key}{k}": v}

get_option(pat)

Get the value of the specified option.

Parameters:

Name Type Description Default
pat str

The option name.

 required

Returns:

Type Description
OptionTypes

The value of the option.

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def get_option(self, pat: str) -> OptionTypes:
    """Get the value of the specified option.

    Args:
        pat: The option name.

    Returns:
        The value of the option.

    Raises:
        ValueError: If the option name is unknown.
    """
    if pat in self._options:
        return self._options[pat]

    msg = f"Unknown option: {pat}"
    raise ValueError(msg)

list_options()

List all available options.

Returns:

Type Description
list[str]

A list of all option names.
Source code in pyretailscience/options.py 
188
189
190
191
192
193
194
def list_options(self) -> list[str]:
    """List all available options.

    Returns:
        A list of all option names.
    """
    return list(self._options.keys())

load_from_project() classmethod

Try to load options from a pyretailscience.toml file in the project root directory.

If the project root directory cannot be found, return a default Options instance.

Returns:

Type Description
Options

An Options instance with options loaded from the pyretailscience.toml file or default
Source code in pyretailscience/options.py 
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
@classmethod
def load_from_project(cls) -> "Options":
    """Try to load options from a pyretailscience.toml file in the project root directory.

    If the project root directory cannot be found, return a default Options instance.

    Returns:
        An Options instance with options loaded from the pyretailscience.toml file or default
    """
    options_instance = cls()

    project_root = find_project_root()
    if project_root is None:
        return options_instance

    toml_file = Path(project_root) / "pyretailscience.toml"
    if toml_file.is_file():
        return Options.load_from_toml(toml_file)

    return options_instance

load_from_toml(file_path) classmethod

Load options from a TOML file.

Parameters:

Name Type Description Default
file_path str

The path to the TOML file.

 required

Raises:

Type Description
ValueError

If the TOML file contains unknown options.
Source code in pyretailscience/options.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
@classmethod
def load_from_toml(cls, file_path: str) -> "Options":
    """Load options from a TOML file.

    Args:
        file_path: The path to the TOML file.

    Raises:
        ValueError: If the TOML file contains unknown options.
    """
    options_instance = cls()

    with open(file_path) as f:
        toml_data = toml.load(f)

    for section, options in toml_data.items():
        for option_name, option_value in Options.flatten_options(section, options).items():
            if option_name in options_instance._options:
                options_instance.set_option(option_name, option_value)
            else:
                msg = f"Unknown option in TOML file: {option_name}"
                raise ValueError(msg)

    return options_instance

reset_option(pat)

Reset the specified option to its default value.

Parameters:

Name Type Description Default
pat str

The option name.

 required

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def reset_option(self, pat: str) -> None:
    """Reset the specified option to its default value.

    Args:
        pat: The option name.

    Raises:
        ValueError: If the option name is unknown.
    """
    if pat not in self._options:
        msg = f"Unknown option: {pat}"
        raise ValueError(msg)

    self._options[pat] = self._default_options[pat]

set_option(pat, val)

Set the value of the specified option.

Parameters:

Name Type Description Default
pat str

The option name.

 required
val OptionTypes

The value to set the option to.

 required

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def set_option(self, pat: str, val: OptionTypes) -> None:
    """Set the value of the specified option.

    Args:
        pat: The option name.
        val: The value to set the option to.

    Raises:
        ValueError: If the option name is unknown.
    """
    if pat not in self._options:
        msg = f"Unknown option: {pat}"
        raise ValueError(msg)

    self._options[pat] = val

describe_option(pat)

Describe the specified option.

This is a global function that delegates to the _global_options instance.

Parameters:

Name Type Description Default
pat str

The option name.

 required

Returns:

Type Description
str

A string describing the option and its current value.

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
def describe_option(pat: str) -> str:
    """Describe the specified option.

    This is a global function that delegates to the _global_options instance.

    Args:
        pat: The option name.

    Returns:
        A string describing the option and its current value.

    Raises:
        ValueError: If the option name is unknown.
    """
    return _global_options.describe_option(pat)

find_project_root() cached

Returns the directory containing .git, .hg, or pyproject.toml, starting from the current working directory.

Source code in pyretailscience/options.py 
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
@lru_cache
def find_project_root() -> str | None:
    """Returns the directory containing .git, .hg, or pyproject.toml, starting from the current working directory."""
    current_dir = Path.cwd()

    while True:
        if (Path(current_dir / ".git")).is_dir() or (Path(current_dir / "pyretailscience.toml")).is_file():
            return current_dir

        parent_dir = Path(current_dir).parent
        reached_root = parent_dir == current_dir
        if reached_root:
            return None

        current_dir = parent_dir

get_option(pat)

Get the value of the specified option.

This is a global function that delegates to the _global_options instance.

Parameters:

Name Type Description Default
pat str

The option name.

 required

Returns:

Type Description
OptionTypes

The value of the option.

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def get_option(pat: str) -> OptionTypes:
    """Get the value of the specified option.

    This is a global function that delegates to the _global_options instance.

    Args:
        pat: The option name.

    Returns:
        The value of the option.

    Raises:
        ValueError: If the option name is unknown.
    """
    return _global_options.get_option(pat)

list_options()

List all available options.

This is a global function that delegates to the _global_options instance.

Returns:

Type Description
list[str]

A list of all option names.
Source code in pyretailscience/options.py 
342
343
344
345
346
347
348
349
350
def list_options() -> list[str]:
    """List all available options.

    This is a global function that delegates to the _global_options instance.

    Returns:
        A list of all option names.
    """
    return _global_options.list_options()

option_context(*args)

Context manager to temporarily set options.

Temporarily set options and restore them to their previous values after the context exits. The arguments should be supplied as alternating option names and values.

Parameters:

Name Type Description Default
*args OptionTypes

An even number of arguments, alternating between option names (str) and their corresponding values.

 ()

Yields:

Type Description
Generator[None, None, None]

None

Raises:

Type Description
ValueError

If an odd number of arguments is supplied.
Example

with option_context('display.max_rows', 10, 'display.max_columns', 5): ... # Do something with modified options ... pass

Options are restored to their previous values here

Source code in pyretailscience/options.py 
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
@contextmanager
def option_context(*args: OptionTypes) -> Generator[None, None, None]:
    """Context manager to temporarily set options.

    Temporarily set options and restore them to their previous values after the
    context exits. The arguments should be supplied as alternating option names
    and values.

    Args:
        *args: An even number of arguments, alternating between option names (str)
               and their corresponding values.

    Yields:
        None

    Raises:
        ValueError: If an odd number of arguments is supplied.

    Example:
        >>> with option_context('display.max_rows', 10, 'display.max_columns', 5):
        ...     # Do something with modified options
        ...     pass
        >>> # Options are restored to their previous values here
    """
    if len(args) % 2 != 0:
        raise ValueError("The context manager requires an even number of arguments")

    old_options: dict[str, OptionTypes] = {}
    try:
        for pat, val in zip(args[::2], args[1::2], strict=True):
            old_options[pat] = get_option(pat)
            set_option(pat, val)
        yield
    finally:
        for pat, val in old_options.items():
            set_option(pat, val)

reset_option(pat)

Reset the specified option to its default value.

This is a global function that delegates to the _global_options instance.

Parameters:

Name Type Description Default
pat str

The option name.

 required

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
328
329
330
331
332
333
334
335
336
337
338
339
def reset_option(pat: str) -> None:
    """Reset the specified option to its default value.

    This is a global function that delegates to the _global_options instance.

    Args:
        pat: The option name.

    Raises:
        ValueError: If the option name is unknown.
    """
    _global_options.reset_option(pat)

set_option(pat, val)

Set the value of the specified option.

This is a global function that delegates to the _global_options instance.

Parameters:

Name Type Description Default
pat str

The option name.

 required
val OptionTypes

The value to set the option to.

 required

Raises:

Type Description
ValueError

If the option name is unknown.
Source code in pyretailscience/options.py 
296
297
298
299
300
301
302
303
304
305
306
307
308
def set_option(pat: str, val: OptionTypes) -> None:
    """Set the value of the specified option.

    This is a global function that delegates to the _global_options instance.

    Args:
        pat: The option name.
        val: The value to set the option to.

    Raises:
        ValueError: If the option name is unknown.
    """
    _global_options.set_option(pat, val)