-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
config.py
1319 lines (1174 loc) · 49 KB
/
config.py
1
2
3
4
5
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
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
406
407
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
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import contextlib
import os
import sys
from pathlib import Path
from typing import TYPE_CHECKING, Any, Literal, get_args
from polars._utils.deprecation import deprecate_nonkeyword_arguments
from polars._utils.various import normalize_filepath
from polars.dependencies import json
if sys.version_info >= (3, 10):
from typing import TypeAlias
else:
pass
if TYPE_CHECKING:
from types import TracebackType
from typing_extensions import TypeAlias
from polars.type_aliases import FloatFmt
TableFormatNames: TypeAlias = Literal[
"ASCII_FULL",
"ASCII_FULL_CONDENSED",
"ASCII_NO_BORDERS",
"ASCII_BORDERS_ONLY",
"ASCII_BORDERS_ONLY_CONDENSED",
"ASCII_HORIZONTAL_ONLY",
"ASCII_MARKDOWN",
"UTF8_FULL",
"UTF8_FULL_CONDENSED",
"UTF8_NO_BORDERS",
"UTF8_BORDERS_ONLY",
"UTF8_HORIZONTAL_ONLY",
"NOTHING",
]
# note: register all Config-specific environment variable names here; need to constrain
# which 'POLARS_' environment variables are recognized, as there are other lower-level
# and/or unstable settings that should not be saved or reset with the Config vars.
_POLARS_CFG_ENV_VARS = {
"POLARS_WARN_UNSTABLE",
"POLARS_ACTIVATE_DECIMAL",
"POLARS_AUTO_STRUCTIFY",
"POLARS_FMT_MAX_COLS",
"POLARS_FMT_MAX_ROWS",
"POLARS_FMT_NUM_DECIMAL",
"POLARS_FMT_NUM_GROUP_SEPARATOR",
"POLARS_FMT_NUM_LEN",
"POLARS_FMT_STR_LEN",
"POLARS_FMT_TABLE_CELL_ALIGNMENT",
"POLARS_FMT_TABLE_CELL_LIST_LEN",
"POLARS_FMT_TABLE_CELL_NUMERIC_ALIGNMENT",
"POLARS_FMT_TABLE_DATAFRAME_SHAPE_BELOW",
"POLARS_FMT_TABLE_FORMATTING",
"POLARS_FMT_TABLE_HIDE_COLUMN_DATA_TYPES",
"POLARS_FMT_TABLE_HIDE_COLUMN_NAMES",
"POLARS_FMT_TABLE_HIDE_COLUMN_SEPARATOR",
"POLARS_FMT_TABLE_HIDE_DATAFRAME_SHAPE_INFORMATION",
"POLARS_FMT_TABLE_INLINE_COLUMN_DATA_TYPE",
"POLARS_FMT_TABLE_ROUNDED_CORNERS",
"POLARS_STREAMING_CHUNK_SIZE",
"POLARS_TABLE_WIDTH",
"POLARS_VERBOSE",
}
# vars that set the rust env directly should declare themselves here as the Config
# method name paired with a callable that returns the current state of that value:
with contextlib.suppress(ImportError, NameError):
# note: 'plr' not available when building docs
import polars.polars as plr
_POLARS_CFG_DIRECT_VARS = {
"set_fmt_float": plr.get_float_fmt,
"set_float_precision": plr.get_float_precision,
"set_thousands_separator": plr.get_thousands_separator,
"set_decimal_separator": plr.get_decimal_separator,
"set_trim_decimal_zeros": plr.get_trim_decimal_zeros,
}
class Config(contextlib.ContextDecorator):
"""
Configure polars; offers options for table formatting and more.
Notes
-----
Can also be used as a context manager OR a function decorator in order to
temporarily scope the lifetime of specific options. For example:
>>> with pl.Config() as cfg:
... # set verbose for more detailed output within the scope
... cfg.set_verbose(True) # doctest: +IGNORE_RESULT
>>> # scope exit - no longer in verbose mode
This can also be written more compactly as:
>>> with pl.Config(verbose=True):
... pass
(The compact format is available for all `Config` methods that take a single value).
Alternatively, you can use as a decorator in order to scope the duration of the
selected options to a specific function:
>>> @pl.Config(verbose=True)
... def test():
... pass
"""
_original_state: str = ""
def __init__(self, *, restore_defaults: bool = False, **options: Any) -> None:
"""
Initialise a Config object instance for context manager usage.
Any `options` kwargs should correspond to the available named "set_*"
methods, but are allowed to omit the "set_" prefix for brevity.
Parameters
----------
restore_defaults
set all options to their default values (this is applied before
setting any other options).
**options
keyword args that will set the option; equivalent to calling the
named "set_<option>" method with the given value.
Examples
--------
>>> df = pl.DataFrame({"abc": [1.0, 2.5, 5.0], "xyz": [True, False, True]})
>>> with pl.Config(
... # these options will be set for scope duration
... tbl_formatting="ASCII_MARKDOWN",
... tbl_hide_dataframe_shape=True,
... tbl_rows=10,
... ):
... print(df)
| abc | xyz |
| --- | --- |
| f64 | bool |
|-----|-------|
| 1.0 | true |
| 2.5 | false |
| 5.0 | true |
"""
# save original state _before_ any changes are made
self._original_state = self.save()
if restore_defaults:
self.restore_defaults()
for opt, value in options.items():
if not hasattr(self, opt) and not opt.startswith("set_"):
opt = f"set_{opt}"
if not hasattr(self, opt):
msg = f"`Config` has no option {opt!r}"
raise AttributeError(msg)
getattr(self, opt)(value)
def __enter__(self) -> Config:
"""Support setting temporary Config options that are reset on scope exit."""
self._original_state = self._original_state or self.save()
return self
def __exit__(
self,
exc_type: type[BaseException] | None,
exc_val: BaseException | None,
exc_tb: TracebackType | None,
) -> None:
"""Reset any Config options that were set within the scope."""
self.restore_defaults().load(self._original_state)
self._original_state = ""
@classmethod
def load(cls, cfg: str) -> type[Config]:
"""
Load (and set) previously saved Config options from a JSON string.
Parameters
----------
cfg : str
JSON string produced by `Config.save()`.
See Also
--------
load_from_file : Load (and set) Config options from a JSON file.
save: Save the current set of Config options as a JSON string or file.
"""
try:
options = json.loads(cfg)
except json.JSONDecodeError as err:
msg = "invalid Config string (did you mean to use `load_from_file`?)"
raise ValueError(msg) from err
os.environ.update(options.get("environment", {}))
for cfg_methodname, value in options.get("direct", {}).items():
if hasattr(cls, cfg_methodname):
getattr(cls, cfg_methodname)(value)
return cls
@classmethod
def load_from_file(cls, file: Path | str) -> type[Config]:
"""
Load (and set) previously saved Config options from file.
Parameters
----------
file : Path | str
File path to a JSON string produced by `Config.save()`.
See Also
--------
load : Load (and set) Config options from a JSON string.
save: Save the current set of Config options as a JSON string or file.
"""
try:
options = Path(normalize_filepath(file)).read_text()
except OSError as err:
msg = f"invalid Config file (did you mean to use `load`?)\n{err}"
raise ValueError(msg) from err
return cls.load(options)
@classmethod
def restore_defaults(cls) -> type[Config]:
"""
Reset all polars Config settings to their default state.
Notes
-----
This method operates by removing all Config options from the environment,
and then setting any local (non-env) options back to their default value.
Examples
--------
>>> cfg = pl.Config.restore_defaults() # doctest: +SKIP
"""
# unset all Config environment variables
for var in _POLARS_CFG_ENV_VARS:
os.environ.pop(var, None)
# reset all 'direct' defaults
for method in _POLARS_CFG_DIRECT_VARS:
getattr(cls, method)(None)
return cls
@classmethod
def save(cls) -> str:
"""
Save the current set of Config options as a JSON string.
See Also
--------
load : Load (and set) Config options from a JSON string.
load_from_file : Load (and set) Config options from a JSON file.
save_to_file : Save the current set of Config options as a JSON file.
Examples
--------
>>> json_str = pl.Config.save()
Returns
-------
str
JSON string containing current Config options.
"""
environment_vars = {
key: os.environ[key]
for key in sorted(_POLARS_CFG_ENV_VARS)
if (key in os.environ)
}
direct_vars = {
cfg_methodname: get_value()
for cfg_methodname, get_value in _POLARS_CFG_DIRECT_VARS.items()
}
options = json.dumps(
{"environment": environment_vars, "direct": direct_vars},
separators=(",", ":"),
)
return options
@classmethod
def save_to_file(cls, file: Path | str) -> None:
"""
Save the current set of Config options as a JSON file.
Parameters
----------
file
Optional path to a file into which the JSON string will be written.
Leave as `None` to return the JSON string directly.
See Also
--------
load : Load (and set) Config options from a JSON string.
load_from_file : Load (and set) Config options from a JSON file.
save : Save the current set of Config options as a JSON string.
Examples
--------
>>> pl.Config().save_to_file("~/polars/config.json") # doctest: +SKIP
"""
file = Path(normalize_filepath(file)).resolve()
file.write_text(cls.save())
@classmethod
@deprecate_nonkeyword_arguments(version="0.19.3")
def state(
cls,
if_set: bool = False, # noqa: FBT001
env_only: bool = False, # noqa: FBT001
) -> dict[str, str | None]:
"""
Show the current state of all Config variables as a dict.
Parameters
----------
if_set : bool
By default this will show the state of all `Config` environment variables.
change this to `True` to restrict the returned dictionary to include only
those that have been set to a specific value.
env_only : bool
Include only Config environment variables in the output; some options (such
as "set_fmt_float") are set directly, not via an environment variable.
Examples
--------
>>> set_state = pl.Config.state(if_set=True)
>>> all_state = pl.Config.state()
"""
config_state = {
var: os.environ.get(var)
for var in sorted(_POLARS_CFG_ENV_VARS)
if not if_set or (os.environ.get(var) is not None)
}
if not env_only:
for cfg_methodname, get_value in _POLARS_CFG_DIRECT_VARS.items():
config_state[cfg_methodname] = get_value()
return config_state
@classmethod
def activate_decimals(cls, active: bool | None = True) -> type[Config]:
"""
Activate `Decimal` data types.
This is a temporary setting that will be removed once the `Decimal` type
stabilizes (`Decimal` is currently considered to be in beta testing).
"""
if not active:
os.environ.pop("POLARS_ACTIVATE_DECIMAL", None)
else:
os.environ["POLARS_ACTIVATE_DECIMAL"] = str(int(active))
return cls
@classmethod
def set_ascii_tables(cls, active: bool | None = True) -> type[Config]:
"""
Use ASCII characters to display table outlines.
Set False to revert to the default UTF8_FULL_CONDENSED formatting style.
Examples
--------
>>> df = pl.DataFrame({"abc": [1.0, 2.5, 5.0], "xyz": [True, False, True]})
>>> pl.Config.set_ascii_tables(True) # doctest: +SKIP
# ...
# shape: (3, 2) shape: (3, 2)
# ┌─────┬───────┐ +-----+-------+
# │ abc ┆ xyz │ | abc | xyz |
# │ --- ┆ --- │ | --- | --- |
# │ f64 ┆ bool │ | f64 | bool |
# ╞═════╪═══════╡ +=============+
# │ 1.0 ┆ true │ >> | 1.0 | true |
# │ 2.5 ┆ false │ | 2.5 | false |
# │ 5.0 ┆ true │ | 5.0 | true |
# └─────┴───────┘ +-----+-------+
"""
if active is None:
os.environ.pop("POLARS_FMT_TABLE_FORMATTING", None)
else:
fmt = "ASCII_FULL_CONDENSED" if active else "UTF8_FULL_CONDENSED"
os.environ["POLARS_FMT_TABLE_FORMATTING"] = fmt
return cls
@classmethod
def set_auto_structify(cls, active: bool | None = False) -> type[Config]:
"""
Allow multi-output expressions to be automatically turned into Structs.
Examples
--------
>>> df = pl.DataFrame({"v": [1, 2, 3], "v2": [4, 5, 6]})
>>> with pl.Config(set_auto_structify=True):
... out = df.select(pl.all())
>>> out
shape: (3, 1)
┌───────────┐
│ v │
│ --- │
│ struct[2] │
╞═══════════╡
│ {1,4} │
│ {2,5} │
│ {3,6} │
└───────────┘
"""
if active is None:
os.environ.pop("POLARS_AUTO_STRUCTIFY", None)
else:
os.environ["POLARS_AUTO_STRUCTIFY"] = str(int(active))
return cls
@classmethod
def set_decimal_separator(cls, separator: str | None = None) -> type[Config]:
"""
Set the decimal separator character.
Parameters
----------
separator : str, bool
Character to use as the decimal separator.
Set to ``None`` to revert to the default (".").
See Also
--------
set_thousands_separator : Set the thousands grouping separator character.
Examples
--------
>>> df = pl.DataFrame({"v": [9876.54321, 1010101.0, -123456.78]})
>>> with pl.Config(
... tbl_cell_numeric_alignment="RIGHT",
... thousands_separator=".",
... decimal_separator=",",
... float_precision=3,
... ):
... print(df)
shape: (3, 1)
┌───────────────┐
│ v │
│ --- │
│ f64 │
╞═══════════════╡
│ 9.876,543 │
│ 1.010.101,000 │
│ -123.456,780 │
└───────────────┘
"""
if isinstance(separator, str) and len(separator) != 1:
msg = f"`separator` must be a single character; found {separator!r}"
raise ValueError(msg)
plr.set_decimal_separator(sep=separator)
return cls
@classmethod
def set_thousands_separator(
cls, separator: str | bool | None = None
) -> type[Config]:
"""
Set the thousands grouping separator character.
Parameters
----------
separator : str, bool
Set True to use the default "," (thousands) and "." (decimal) separators.
Can also set a custom char, or set ``None`` to omit the separator.
See Also
--------
set_decimal_separator : Set the decimal separator character.
Examples
--------
>>> df = pl.DataFrame(
... {
... "x": [1234567, -987654, 10101],
... "y": [1234.5, 100000.0, -7654321.25],
... }
... )
>>> with pl.Config(
... tbl_cell_numeric_alignment="RIGHT",
... thousands_separator=True,
... float_precision=2,
... ):
... print(df)
shape: (3, 2)
┌───────────┬───────────────┐
│ x ┆ y │
│ --- ┆ --- │
│ i64 ┆ f64 │
╞═══════════╪═══════════════╡
│ 1,234,567 ┆ 1,234.50 │
│ -987,654 ┆ 100,000.00 │
│ 10,101 ┆ -7,654,321.25 │
└───────────┴───────────────┘
>>> with pl.Config(
... tbl_cell_numeric_alignment="RIGHT",
... thousands_separator=".",
... decimal_separator=",",
... float_precision=2,
... ):
... print(df)
shape: (3, 2)
┌───────────┬───────────────┐
│ x ┆ y │
│ --- ┆ --- │
│ i64 ┆ f64 │
╞═══════════╪═══════════════╡
│ 1.234.567 ┆ 1.234,50 │
│ -987.654 ┆ 100.000,00 │
│ 10.101 ┆ -7.654.321,25 │
└───────────┴───────────────┘
"""
if separator is True:
plr.set_decimal_separator(sep=".")
plr.set_thousands_separator(sep=",")
else:
if isinstance(separator, str) and len(separator) > 1:
msg = f"`separator` must be a single character; found {separator!r}"
raise ValueError(msg)
plr.set_thousands_separator(sep=separator or None)
return cls
@classmethod
def set_float_precision(cls, precision: int | None = None) -> type[Config]:
"""
Control the number of decimal places displayed for floating point values.
Parameters
----------
precision : int
Number of decimal places to display; set to `None` to revert to the
default/standard behaviour.
Notes
-----
When setting this to a larger value you should ensure that you are aware of both
the limitations of floating point representations, and of the precision of the
data that you are looking at.
This setting only applies to Float32 and Float64 dtypes; it does not cover
Decimal dtype values (which are displayed at their native level of precision).
Examples
--------
Set a large maximum float precision:
>>> from math import pi, e
>>> df = pl.DataFrame({"const": ["pi", "e"], "value": [pi, e]})
>>> with pl.Config(float_precision=15):
... print(df)
shape: (2, 2)
┌───────┬───────────────────┐
│ const ┆ value │
│ --- ┆ --- │
│ str ┆ f64 │
╞═══════╪═══════════════════╡
│ pi ┆ 3.141592653589793 │
│ e ┆ 2.718281828459045 │
└───────┴───────────────────┘
Set a fixed float precision and align numeric columns to the
right in order to cleanly line-up the decimal separator:
>>> df = pl.DataFrame(
... {
... "a": ["xx", "yy"],
... "b": [-11111111, 44444444444],
... "c": [100000.987654321, -23456789],
... }
... )
>>> with pl.Config(
... tbl_cell_numeric_alignment="RIGHT",
... thousands_separator=",",
... float_precision=3,
... ):
... print(df)
shape: (2, 3)
┌─────┬────────────────┬─────────────────┐
│ a ┆ b ┆ c │
│ --- ┆ --- ┆ --- │
│ str ┆ i64 ┆ f64 │
╞═════╪════════════════╪═════════════════╡
│ xx ┆ -11,111,111 ┆ 100,000.988 │
│ yy ┆ 44,444,444,444 ┆ -23,456,789.000 │
└─────┴────────────────┴─────────────────┘
"""
plr.set_float_precision(precision)
return cls
@classmethod
def set_fmt_float(cls, fmt: FloatFmt | None = "mixed") -> type[Config]:
"""
Control how floating point values are displayed.
Parameters
----------
fmt : {"mixed", "full"}
How to format floating point numbers:
- "mixed": Limit the number of decimal places and use scientific
notation for large/small values.
- "full": Print the full precision of the floating point number.
Examples
--------
"mixed" float formatting:
>>> s = pl.Series([1.2304980958725870923, 1e6, 1e-8])
>>> with pl.Config(set_fmt_float="mixed"):
... print(s)
shape: (3,)
Series: '' [f64]
[
1.230498
1e6
1.0000e-8
]
"full" float formatting:
>>> with pl.Config(set_fmt_float="full"):
... print(s)
shape: (3,)
Series: '' [f64]
[
1.230498095872587
1000000
0.00000001
]
"""
plr.set_float_fmt(fmt="mixed" if fmt is None else fmt)
return cls
@classmethod
def set_fmt_str_lengths(cls, n: int | None) -> type[Config]:
"""
Set the number of characters used to display string values.
Parameters
----------
n : int
Number of characters to display.
Examples
--------
>>> df = pl.DataFrame(
... {
... "txt": [
... "Play it, Sam. Play 'As Time Goes By'.",
... "This is the beginning of a beautiful friendship.",
... ]
... }
... )
>>> df.with_columns(pl.col("txt").str.len_bytes().alias("len"))
shape: (2, 2)
┌─────────────────────────────────┬─────┐
│ txt ┆ len │
│ --- ┆ --- │
│ str ┆ u32 │
╞═════════════════════════════════╪═════╡
│ Play it, Sam. Play 'As Time Go… ┆ 37 │
│ This is the beginning of a bea… ┆ 48 │
└─────────────────────────────────┴─────┘
>>> with pl.Config(fmt_str_lengths=50):
... print(df)
shape: (2, 1)
┌──────────────────────────────────────────────────┐
│ txt │
│ --- │
│ str │
╞══════════════════════════════════════════════════╡
│ Play it, Sam. Play 'As Time Goes By'. │
│ This is the beginning of a beautiful friendship. │
└──────────────────────────────────────────────────┘
"""
if n is None:
os.environ.pop("POLARS_FMT_STR_LEN", None)
else:
if n <= 0:
msg = "number of characters must be > 0"
raise ValueError(msg)
os.environ["POLARS_FMT_STR_LEN"] = str(n)
return cls
@classmethod
def set_fmt_table_cell_list_len(cls, n: int | None) -> type[Config]:
"""
Set the number of elements to display for List values.
Empty lists will always print "[]". Negative values will result in all values
being printed. A value of 0 will always "[…]" for lists with contents. A value
of 1 will print only the final item in the list.
Parameters
----------
n : int
Number of values to display.
Examples
--------
>>> df = pl.DataFrame(
... {
... "nums": [
... [1, 2, 3, 4, 5, 6],
... ]
... }
... )
>>> df
shape: (1, 1)
┌─────────────┐
│ nums │
│ --- │
│ list[i64] │
╞═════════════╡
│ [1, 2, … 6] │
└─────────────┘
>>> with pl.Config(fmt_table_cell_list_len=10):
... print(df)
shape: (1, 1)
┌────────────────────┐
│ nums │
│ --- │
│ list[i64] │
╞════════════════════╡
│ [1, 2, 3, 4, 5, 6] │
└────────────────────┘
"""
if n is None:
os.environ.pop("POLARS_FMT_TABLE_CELL_LIST_LEN", None)
else:
os.environ["POLARS_FMT_TABLE_CELL_LIST_LEN"] = str(n)
return cls
@classmethod
def set_streaming_chunk_size(cls, size: int | None) -> type[Config]:
"""
Overwrite chunk size used in `streaming` engine.
By default, the chunk size is determined by the schema
and size of the thread pool. For some datasets (esp.
when you have large string elements) this can be too
optimistic and lead to Out of Memory errors.
Parameters
----------
size
Number of rows per chunk. Every thread will process chunks
of this size.
"""
if size is None:
os.environ.pop("POLARS_STREAMING_CHUNK_SIZE", None)
else:
if size < 1:
msg = "number of rows per chunk must be >= 1"
raise ValueError(msg)
os.environ["POLARS_STREAMING_CHUNK_SIZE"] = str(size)
return cls
@classmethod
def set_tbl_cell_alignment(
cls, format: Literal["LEFT", "CENTER", "RIGHT"] | None
) -> type[Config]:
"""
Set table cell alignment.
Parameters
----------
format : str
* "LEFT": left aligned
* "CENTER": center aligned
* "RIGHT": right aligned
Examples
--------
>>> df = pl.DataFrame(
... {"column_abc": [1.0, 2.5, 5.0], "column_xyz": [True, False, True]}
... )
>>> pl.Config.set_tbl_cell_alignment("RIGHT") # doctest: +IGNORE_RESULT
>>> print(df)
shape: (3, 2)
┌────────────┬────────────┐
│ column_abc ┆ column_xyz │
│ --- ┆ --- │
│ f64 ┆ bool │
╞════════════╪════════════╡
│ 1.0 ┆ true │
│ 2.5 ┆ false │
│ 5.0 ┆ true │
└────────────┴────────────┘
Raises
------
ValueError: if alignment string not recognised.
"""
if format is None:
os.environ.pop("POLARS_FMT_TABLE_CELL_ALIGNMENT", None)
elif format not in {"LEFT", "CENTER", "RIGHT"}:
msg = f"invalid alignment: {format!r}"
raise ValueError(msg)
else:
os.environ["POLARS_FMT_TABLE_CELL_ALIGNMENT"] = format
return cls
@classmethod
def set_tbl_cell_numeric_alignment(
cls, format: Literal["LEFT", "CENTER", "RIGHT"] | None
) -> type[Config]:
"""
Set table cell alignment for numeric columns.
Parameters
----------
format : str
* "LEFT": left aligned
* "CENTER": center aligned
* "RIGHT": right aligned
Examples
--------
>>> from datetime import date
>>> df = pl.DataFrame(
... {
... "abc": [11, 2, 333],
... "mno": [date(2023, 10, 29), None, date(2001, 7, 5)],
... "xyz": [True, False, None],
... }
... )
>>> pl.Config.set_tbl_cell_numeric_alignment("RIGHT") # doctest: +IGNORE_RESULT
>>> print(df)
shape: (3, 3)
┌─────┬────────────┬───────┐
│ abc ┆ mno ┆ xyz │
│ --- ┆ --- ┆ --- │
│ i64 ┆ date ┆ bool │
╞═════╪════════════╪═══════╡
│ 11 ┆ 2023-10-29 ┆ true │
│ 2 ┆ null ┆ false │
│ 333 ┆ 2001-07-05 ┆ null │
└─────┴────────────┴───────┘
Raises
------
KeyError: if alignment string not recognised.
"""
if format is None:
os.environ.pop("POLARS_FMT_TABLE_CELL_NUMERIC_ALIGNMENT", None)
elif format not in {"LEFT", "CENTER", "RIGHT"}:
msg = f"invalid alignment: {format!r}"
raise ValueError(msg)
else:
os.environ["POLARS_FMT_TABLE_CELL_NUMERIC_ALIGNMENT"] = format
return cls
@classmethod
def set_tbl_cols(cls, n: int | None) -> type[Config]:
"""
Set the number of columns that are visible when displaying tables.
Parameters
----------
n : int
Number of columns to display; if `n < 0` (eg: -1), display all columns.
Examples
--------
Set number of displayed columns to a low value:
>>> with pl.Config() as cfg:
... cfg.set_tbl_cols(5)
... df = pl.DataFrame({str(i): [i] for i in range(100)})
... print(df)
<class 'polars.config.Config'>
shape: (1, 100)
┌─────┬─────┬─────┬───┬─────┬─────┐
│ 0 ┆ 1 ┆ 2 ┆ … ┆ 98 ┆ 99 │
│ --- ┆ --- ┆ --- ┆ ┆ --- ┆ --- │
│ i64 ┆ i64 ┆ i64 ┆ ┆ i64 ┆ i64 │
╞═════╪═════╪═════╪═══╪═════╪═════╡
│ 0 ┆ 1 ┆ 2 ┆ … ┆ 98 ┆ 99 │
└─────┴─────┴─────┴───┴─────┴─────┘
>>> with pl.Config(tbl_cols=10):
... print(df)
shape: (1, 100)
┌─────┬─────┬─────┬─────┬─────┬───┬─────┬─────┬─────┬─────┬─────┐
│ 0 ┆ 1 ┆ 2 ┆ 3 ┆ 4 ┆ … ┆ 95 ┆ 96 ┆ 97 ┆ 98 ┆ 99 │
│ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │
│ i64 ┆ i64 ┆ i64 ┆ i64 ┆ i64 ┆ ┆ i64 ┆ i64 ┆ i64 ┆ i64 ┆ i64 │
╞═════╪═════╪═════╪═════╪═════╪═══╪═════╪═════╪═════╪═════╪═════╡
│ 0 ┆ 1 ┆ 2 ┆ 3 ┆ 4 ┆ … ┆ 95 ┆ 96 ┆ 97 ┆ 98 ┆ 99 │
└─────┴─────┴─────┴─────┴─────┴───┴─────┴─────┴─────┴─────┴─────┘
"""
if n is None:
os.environ.pop("POLARS_FMT_MAX_COLS", None)
else:
os.environ["POLARS_FMT_MAX_COLS"] = str(n)
return cls
@classmethod
def set_tbl_column_data_type_inline(
cls, active: bool | None = True
) -> type[Config]:
"""
Moves the data type inline with the column name (to the right, in parentheses).
Examples
--------
>>> df = pl.DataFrame({"abc": [1.0, 2.5, 5.0], "xyz": [True, False, True]})
>>> pl.Config.set_tbl_column_data_type_inline(True) # doctest: +SKIP
# ...
# shape: (3, 2) shape: (3, 2)
# ┌─────┬───────┐ ┌───────────┬────────────┐
# │ abc ┆ xyz │ │ abc (f64) ┆ xyz (bool) │
# │ --- ┆ --- │ ╞═══════════╪════════════╡
# │ f64 ┆ bool │ │ 1.0 ┆ true │
# ╞═════╪═══════╡ >> │ 2.5 ┆ false │
# │ 1.0 ┆ true │ │ 5.0 ┆ true │
# │ 2.5 ┆ false │ └───────────┴────────────┘
# │ 5.0 ┆ true │
# └─────┴───────┘
"""
if active is None:
os.environ.pop("POLARS_FMT_TABLE_INLINE_COLUMN_DATA_TYPE", None)
else:
os.environ["POLARS_FMT_TABLE_INLINE_COLUMN_DATA_TYPE"] = str(int(active))
return cls
@classmethod
def set_tbl_dataframe_shape_below(cls, active: bool | None = True) -> type[Config]:
"""
Print the DataFrame shape information below the data when displaying tables.
Examples
--------
>>> df = pl.DataFrame({"abc": [1.0, 2.5, 5.0], "xyz": [True, False, True]})
>>> pl.Config.set_tbl_dataframe_shape_below(True) # doctest: +SKIP
# ...
# shape: (3, 2) ┌─────┬───────┐
# ┌─────┬───────┐ │ abc ┆ xyz │
# │ abc ┆ xyz │ │ --- ┆ --- │
# │ --- ┆ --- │ │ f64 ┆ bool │
# │ f64 ┆ bool │ ╞═════╪═══════╡
# ╞═════╪═══════╡ >> │ 1.0 ┆ true │
# │ 1.0 ┆ true │ │ 2.5 ┆ false │
# │ 2.5 ┆ false │ │ 5.0 ┆ true │
# │ 5.0 ┆ true │ └─────┴───────┘
# └─────┴───────┘ shape: (3, 2)
"""
if active is None:
os.environ.pop("POLARS_FMT_TABLE_DATAFRAME_SHAPE_BELOW", None)
else:
os.environ["POLARS_FMT_TABLE_DATAFRAME_SHAPE_BELOW"] = str(int(active))
return cls
@classmethod
def set_tbl_formatting(
cls,
format: TableFormatNames | None = None,
rounded_corners: bool | None = False,
) -> type[Config]:
"""
Set table formatting style.
Parameters
----------
format : str
* "ASCII_FULL": ASCII, with all borders and lines, including row dividers.
* "ASCII_FULL_CONDENSED": Same as ASCII_FULL, but with dense row spacing.
* "ASCII_NO_BORDERS": ASCII, no borders.
* "ASCII_BORDERS_ONLY": ASCII, borders only.
* "ASCII_BORDERS_ONLY_CONDENSED": ASCII, borders only, dense row spacing.
* "ASCII_HORIZONTAL_ONLY": ASCII, horizontal lines only.
* "ASCII_MARKDOWN": ASCII, Markdown compatible.
* "UTF8_FULL": UTF8, with all borders and lines, including row dividers.
* "UTF8_FULL_CONDENSED": Same as UTF8_FULL, but with dense row spacing.
* "UTF8_NO_BORDERS": UTF8, no borders.
* "UTF8_BORDERS_ONLY": UTF8, borders only.
* "UTF8_HORIZONTAL_ONLY": UTF8, horizontal lines only.
* "NOTHING": No borders or other lines.
rounded_corners : bool
Apply rounded corners to UTF8-styled tables (no-op for ASCII formats).
Notes
-----
The UTF8 styles all use one or more of the semigraphic box-drawing characters
found in the Unicode Box Drawing block, which are not ASCII compatible:
https://en.wikipedia.org/wiki/Box-drawing_character#Box_Drawing