Skip to content

Commit 88af887

Browse files
authored
REF: privatize/annotate in io.formats (#55438)
* REF: privatize in formats.info * privatize in formats.xml * REF: privatize in formats.xml * TYP: annotate in style_render * lint fixup
1 parent a984fed commit 88af887

File tree

3 files changed

+90
-73
lines changed

3 files changed

+90
-73
lines changed

pandas/io/formats/info.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ def _initialize_memory_usage(
356356
return memory_usage
357357

358358

359-
class BaseInfo(ABC):
359+
class _BaseInfo(ABC):
360360
"""
361361
Base class for DataFrameInfo and SeriesInfo.
362362
@@ -439,7 +439,7 @@ def render(
439439
pass
440440

441441

442-
class DataFrameInfo(BaseInfo):
442+
class DataFrameInfo(_BaseInfo):
443443
"""
444444
Class storing dataframe-specific info.
445445
"""
@@ -503,7 +503,7 @@ def render(
503503
verbose: bool | None,
504504
show_counts: bool | None,
505505
) -> None:
506-
printer = DataFrameInfoPrinter(
506+
printer = _DataFrameInfoPrinter(
507507
info=self,
508508
max_cols=max_cols,
509509
verbose=verbose,
@@ -512,7 +512,7 @@ def render(
512512
printer.to_buffer(buf)
513513

514514

515-
class SeriesInfo(BaseInfo):
515+
class SeriesInfo(_BaseInfo):
516516
"""
517517
Class storing series-specific info.
518518
"""
@@ -538,7 +538,7 @@ def render(
538538
"Argument `max_cols` can only be passed "
539539
"in DataFrame.info, not Series.info"
540540
)
541-
printer = SeriesInfoPrinter(
541+
printer = _SeriesInfoPrinter(
542542
info=self,
543543
verbose=verbose,
544544
show_counts=show_counts,
@@ -572,7 +572,7 @@ def memory_usage_bytes(self) -> int:
572572
return self.data.memory_usage(index=True, deep=deep)
573573

574574

575-
class InfoPrinterAbstract:
575+
class _InfoPrinterAbstract:
576576
"""
577577
Class for printing dataframe or series info.
578578
"""
@@ -586,11 +586,11 @@ def to_buffer(self, buf: WriteBuffer[str] | None = None) -> None:
586586
fmt.buffer_put_lines(buf, lines)
587587

588588
@abstractmethod
589-
def _create_table_builder(self) -> TableBuilderAbstract:
589+
def _create_table_builder(self) -> _TableBuilderAbstract:
590590
"""Create instance of table builder."""
591591

592592

593-
class DataFrameInfoPrinter(InfoPrinterAbstract):
593+
class _DataFrameInfoPrinter(_InfoPrinterAbstract):
594594
"""
595595
Class for printing dataframe info.
596596
@@ -650,27 +650,27 @@ def _initialize_show_counts(self, show_counts: bool | None) -> bool:
650650
else:
651651
return show_counts
652652

653-
def _create_table_builder(self) -> DataFrameTableBuilder:
653+
def _create_table_builder(self) -> _DataFrameTableBuilder:
654654
"""
655655
Create instance of table builder based on verbosity and display settings.
656656
"""
657657
if self.verbose:
658-
return DataFrameTableBuilderVerbose(
658+
return _DataFrameTableBuilderVerbose(
659659
info=self.info,
660660
with_counts=self.show_counts,
661661
)
662662
elif self.verbose is False: # specifically set to False, not necessarily None
663-
return DataFrameTableBuilderNonVerbose(info=self.info)
663+
return _DataFrameTableBuilderNonVerbose(info=self.info)
664664
elif self.exceeds_info_cols:
665-
return DataFrameTableBuilderNonVerbose(info=self.info)
665+
return _DataFrameTableBuilderNonVerbose(info=self.info)
666666
else:
667-
return DataFrameTableBuilderVerbose(
667+
return _DataFrameTableBuilderVerbose(
668668
info=self.info,
669669
with_counts=self.show_counts,
670670
)
671671

672672

673-
class SeriesInfoPrinter(InfoPrinterAbstract):
673+
class _SeriesInfoPrinter(_InfoPrinterAbstract):
674674
"""Class for printing series info.
675675
676676
Parameters
@@ -694,17 +694,17 @@ def __init__(
694694
self.verbose = verbose
695695
self.show_counts = self._initialize_show_counts(show_counts)
696696

697-
def _create_table_builder(self) -> SeriesTableBuilder:
697+
def _create_table_builder(self) -> _SeriesTableBuilder:
698698
"""
699699
Create instance of table builder based on verbosity.
700700
"""
701701
if self.verbose or self.verbose is None:
702-
return SeriesTableBuilderVerbose(
702+
return _SeriesTableBuilderVerbose(
703703
info=self.info,
704704
with_counts=self.show_counts,
705705
)
706706
else:
707-
return SeriesTableBuilderNonVerbose(info=self.info)
707+
return _SeriesTableBuilderNonVerbose(info=self.info)
708708

709709
def _initialize_show_counts(self, show_counts: bool | None) -> bool:
710710
if show_counts is None:
@@ -713,13 +713,13 @@ def _initialize_show_counts(self, show_counts: bool | None) -> bool:
713713
return show_counts
714714

715715

716-
class TableBuilderAbstract(ABC):
716+
class _TableBuilderAbstract(ABC):
717717
"""
718718
Abstract builder for info table.
719719
"""
720720

721721
_lines: list[str]
722-
info: BaseInfo
722+
info: _BaseInfo
723723

724724
@abstractmethod
725725
def get_lines(self) -> list[str]:
@@ -769,7 +769,7 @@ def add_dtypes_line(self) -> None:
769769
self._lines.append(f"dtypes: {', '.join(collected_dtypes)}")
770770

771771

772-
class DataFrameTableBuilder(TableBuilderAbstract):
772+
class _DataFrameTableBuilder(_TableBuilderAbstract):
773773
"""
774774
Abstract builder for dataframe info table.
775775
@@ -820,7 +820,7 @@ def add_memory_usage_line(self) -> None:
820820
self._lines.append(f"memory usage: {self.memory_usage_string}")
821821

822822

823-
class DataFrameTableBuilderNonVerbose(DataFrameTableBuilder):
823+
class _DataFrameTableBuilderNonVerbose(_DataFrameTableBuilder):
824824
"""
825825
Dataframe info table builder for non-verbose output.
826826
"""
@@ -838,7 +838,7 @@ def add_columns_summary_line(self) -> None:
838838
self._lines.append(self.ids._summary(name="Columns"))
839839

840840

841-
class TableBuilderVerboseMixin(TableBuilderAbstract):
841+
class _TableBuilderVerboseMixin(_TableBuilderAbstract):
842842
"""
843843
Mixin for verbose info output.
844844
"""
@@ -931,7 +931,7 @@ def _gen_dtypes(self) -> Iterator[str]:
931931
yield pprint_thing(dtype)
932932

933933

934-
class DataFrameTableBuilderVerbose(DataFrameTableBuilder, TableBuilderVerboseMixin):
934+
class _DataFrameTableBuilderVerbose(_DataFrameTableBuilder, _TableBuilderVerboseMixin):
935935
"""
936936
Dataframe info table builder for verbose output.
937937
"""
@@ -997,7 +997,7 @@ def _gen_columns(self) -> Iterator[str]:
997997
yield pprint_thing(col)
998998

999999

1000-
class SeriesTableBuilder(TableBuilderAbstract):
1000+
class _SeriesTableBuilder(_TableBuilderAbstract):
10011001
"""
10021002
Abstract builder for series info table.
10031003
@@ -1029,7 +1029,7 @@ def _fill_non_empty_info(self) -> None:
10291029
"""Add lines to the info table, pertaining to non-empty series."""
10301030

10311031

1032-
class SeriesTableBuilderNonVerbose(SeriesTableBuilder):
1032+
class _SeriesTableBuilderNonVerbose(_SeriesTableBuilder):
10331033
"""
10341034
Series info table builder for non-verbose output.
10351035
"""
@@ -1043,7 +1043,7 @@ def _fill_non_empty_info(self) -> None:
10431043
self.add_memory_usage_line()
10441044

10451045

1046-
class SeriesTableBuilderVerbose(SeriesTableBuilder, TableBuilderVerboseMixin):
1046+
class _SeriesTableBuilderVerbose(_SeriesTableBuilder, _TableBuilderVerboseMixin):
10471047
"""
10481048
Series info table builder for verbose output.
10491049
"""

pandas/io/formats/style_render.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2357,7 +2357,7 @@ def color(value, user_arg, command, comm_arg):
23572357
return latex_styles
23582358

23592359

2360-
def _escape_latex(s):
2360+
def _escape_latex(s: str) -> str:
23612361
r"""
23622362
Replace the characters ``&``, ``%``, ``$``, ``#``, ``_``, ``{``, ``}``,
23632363
``~``, ``^``, and ``\`` in the string with LaTeX-safe sequences.
@@ -2392,7 +2392,7 @@ def _escape_latex(s):
23922392
)
23932393

23942394

2395-
def _math_mode_with_dollar(s):
2395+
def _math_mode_with_dollar(s: str) -> str:
23962396
r"""
23972397
All characters in LaTeX math mode are preserved.
23982398
@@ -2425,7 +2425,7 @@ def _math_mode_with_dollar(s):
24252425
return "".join(res).replace(r"rt8§=§7wz", r"\$")
24262426

24272427

2428-
def _math_mode_with_parentheses(s):
2428+
def _math_mode_with_parentheses(s: str) -> str:
24292429
r"""
24302430
All characters in LaTeX math mode are preserved.
24312431
@@ -2461,7 +2461,7 @@ def _math_mode_with_parentheses(s):
24612461
return "".join(res)
24622462

24632463

2464-
def _escape_latex_math(s):
2464+
def _escape_latex_math(s: str) -> str:
24652465
r"""
24662466
All characters in LaTeX math mode are preserved.
24672467

0 commit comments

Comments
 (0)