CLN: annotate __str__ and __repr__ methods (pandas-dev#29467)

Author: jbrockmendel

pandas/_libs/internals.pyx

@@ -53,7 +53,7 @@ cdef class BlockPlacement:
             self._as_array = arr
             self._has_array = True
 
-    def __str__(self):
+    def __str__(self) -> str:
         cdef:
             slice s = self._ensure_has_slice()
         if s is not None:
@@ -63,7 +63,7 @@ cdef class BlockPlacement:
 
         return '%s(%r)' % (self.__class__.__name__, v)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return str(self)
 
     def __len__(self):

pandas/_libs/interval.pyx

@@ -377,15 +377,15 @@ cdef class Interval(IntervalMixin):
 
         return left, right
 
-    def __repr__(self):
+    def __repr__(self) -> str:
 
         left, right = self._repr_base()
         name = type(self).__name__
         repr_str = '{name}({left!r}, {right!r}, closed={closed!r})'.format(
             name=name, left=left, right=right, closed=self.closed)
         return repr_str
 
-    def __str__(self):
+    def __str__(self) -> str:
 
         left, right = self._repr_base()
         start_symbol = '[' if self.closed_left else '('

pandas/_libs/intervaltree.pxi.in

@@ -195,7 +195,7 @@ cdef class IntervalTree(IntervalMixin):
         return (result.to_array().astype('intp'),
                 missing.to_array().astype('intp'))
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return ('<IntervalTree[{dtype},{closed}]: '
                 '{n_elements} elements>'.format(
                     dtype=self.dtype, closed=self.closed,
@@ -394,7 +394,7 @@ cdef class {{dtype_title}}Closed{{closed_title}}IntervalNode:
             else:
                 result.extend(self.center_left_indices)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         if self.is_leaf_node:
             return ('<{{dtype_title}}Closed{{closed_title}}IntervalNode: '
                     '%s elements (terminal)>' % self.n_elements)

pandas/_libs/sparse.pyx

@@ -51,7 +51,7 @@ cdef class IntIndex(SparseIndex):
         args = (self.length, self.indices)
         return IntIndex, args
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         output = 'IntIndex\n'
         output += 'Indices: %s\n' % repr(self.indices)
         return output
@@ -341,7 +341,7 @@ cdef class BlockIndex(SparseIndex):
         args = (self.length, self.blocs, self.blengths)
         return BlockIndex, args
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         output = 'BlockIndex\n'
         output += 'Block locations: %s\n' % repr(self.blocs)
         output += 'Block lengths: %s' % repr(self.blengths)

pandas/_libs/tslibs/c_timestamp.pyx

@@ -124,7 +124,7 @@ cdef class _Timestamp(datetime):
         # now __reduce_ex__ is defined and higher priority than __reduce__
         return self.__reduce__()
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         stamp = self._repr_base
         zone = None
 

pandas/_libs/tslibs/nattype.pyx

@@ -259,10 +259,10 @@ cdef class _NaT(datetime):
         """
         return self.to_datetime64()
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return 'NaT'
 
-    def __str__(self):
+    def __str__(self) -> str:
         return 'NaT'
 
     def isoformat(self, sep='T'):

pandas/_libs/tslibs/offsets.pyx

@@ -422,7 +422,7 @@ class _BaseOffset:
         # that allows us to use methods that can go in a `cdef class`
         return self * 1
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         className = getattr(self, '_outputName', type(self).__name__)
 
         if abs(self.n) != 1:

pandas/_libs/tslibs/period.pyx

@@ -2215,12 +2215,12 @@ cdef class _Period:
     def freqstr(self):
         return self.freq.freqstr
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         base, mult = get_freq_code(self.freq)
         formatted = period_format(self.ordinal, base)
         return "Period('%s', '%s')" % (formatted, self.freqstr)
 
-    def __str__(self):
+    def __str__(self) -> str:
         """
         Return a string representation for a particular DataFrame
         """

pandas/_libs/tslibs/timedeltas.pyx

@@ -1142,10 +1142,10 @@ cdef class _Timedelta(timedelta):
 
         return fmt.format(**comp_dict)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "Timedelta('{val}')".format(val=self._repr_base(format='long'))
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self._repr_base(format='long')
 
     def __bool__(self):

pandas/core/arrays/base.py

@@ -913,7 +913,7 @@ def view(self, dtype=None) -> Union[ABCExtensionArray, np.ndarray]:
     # Printing
     # ------------------------------------------------------------------------
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         from pandas.io.formats.printing import format_object_summary
 
         template = "{class_name}{data}\nLength: {length}, dtype: {dtype}"

pandas/core/arrays/categorical.py

@@ -2048,7 +2048,7 @@ def _get_repr(self, length=True, na_rep="NaN", footer=True):
         result = formatter.to_string()
         return str(result)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         """
         String representation.
         """

pandas/core/arrays/integer.py

@@ -45,7 +45,7 @@ class _IntegerDtype(ExtensionDtype):
     type = None  # type: Type
     na_value = np.nan
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         sign = "U" if self.is_unsigned_integer else ""
         return "{sign}Int{size}Dtype()".format(sign=sign, size=8 * self.itemsize)
 

pandas/core/arrays/interval.py

@@ -860,7 +860,7 @@ def _format_data(self):
 
         return summary
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         template = (
             "{class_name}"
             "{data}\n"

pandas/core/arrays/numpy_.py

@@ -44,7 +44,7 @@ def __init__(self, dtype):
         self._name = dtype.name
         self._type = dtype.type
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "PandasDtype({!r})".format(self.name)
 
     @property

pandas/core/arrays/sparse/array.py

@@ -1515,7 +1515,7 @@ def _add_comparison_ops(cls):
     # ----------
     # Formatting
     # -----------
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "{self}\nFill: {fill}\n{index}".format(
             self=printing.pprint_thing(self),
             fill=printing.pprint_thing(self.fill_value),

pandas/core/arrays/sparse/dtype.py

@@ -165,7 +165,7 @@ def subtype(self):
     def name(self):
         return "Sparse[{}, {}]".format(self.subtype.name, self.fill_value)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return self.name
 
     @classmethod

pandas/core/base.py

@@ -55,7 +55,7 @@ def _constructor(self):
         """class constructor (for this class it's just `__class__`"""
         return self.__class__
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         """
         Return a string representation for a particular object.
         """

pandas/core/computation/expr.py

@@ -834,7 +834,7 @@ def assigner(self):
     def __call__(self):
         return self.terms(self.env)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return printing.pprint_thing(self.terms)
 
     def __len__(self):

pandas/core/computation/ops.py

@@ -82,7 +82,7 @@ def __init__(self, name, env, side=None, encoding=None):
     def local_name(self):
         return self.name.replace(_LOCAL_TAG, "")
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return pprint_thing(self.name)
 
     def __call__(self, *args, **kwargs):
@@ -182,7 +182,7 @@ def _resolve_name(self):
     def name(self):
         return self.value
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         # in python 2 str() of float
         # can truncate shorter than repr()
         return repr(self.name)
@@ -204,7 +204,7 @@ def __init__(self, op, operands, *args, **kwargs):
     def __iter__(self):
         return iter(self.operands)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         """
         Print a generic n-ary operator and its operands using infix notation.
         """
@@ -557,7 +557,7 @@ def __call__(self, env):
         operand = self.operand(env)
         return self.func(operand)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return pprint_thing("{0}({1})".format(self.op, self.operand))
 
     @property
@@ -582,7 +582,7 @@ def __call__(self, env):
         with np.errstate(all="ignore"):
             return self.func.func(*operands)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         operands = map(str, self.operands)
         return pprint_thing("{0}({1})".format(self.op, ",".join(operands)))
 

pandas/core/computation/pytables.py

@@ -229,7 +229,7 @@ def convert_values(self):
 
 
 class FilterBinOp(BinOp):
-    def __repr__(self):
+    def __repr__(self) -> str:
         return pprint_thing(
             "[Filter : [{lhs}] -> [{op}]".format(lhs=self.filter[0], op=self.filter[1])
         )
@@ -295,7 +295,7 @@ def evaluate(self):
 
 
 class ConditionBinOp(BinOp):
-    def __repr__(self):
+    def __repr__(self) -> str:
         return pprint_thing("[Condition : [{cond}]]".format(cond=self.condition))
 
     def invert(self):
@@ -545,7 +545,7 @@ def __init__(self, where, queryables=None, encoding=None, scope_level=0):
             )
             self.terms = self.parse()
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         if self.terms is not None:
             return pprint_thing(self.terms)
         return pprint_thing(self.expr)

pandas/core/computation/scope.py

@@ -139,7 +139,7 @@ def __init__(
         self.resolvers = DeepChainMap(*resolvers)
         self.temps = {}
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         scope_keys = _get_pretty_string(list(self.scope.keys()))
         res_keys = _get_pretty_string(list(self.resolvers.keys()))
         unicode_str = "{name}(scope={scope_keys}, resolvers={res_keys})"

pandas/core/dtypes/base.py

@@ -71,7 +71,7 @@ class property**.
 
     _metadata = ()  # type: Tuple[str, ...]
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.name
 
     def __eq__(self, other):

pandas/core/dtypes/dtypes.py

@@ -415,7 +415,7 @@ def __eq__(self, other: Any) -> bool:
                 return True
             return hash(self) == hash(other)
 
-    def __repr__(self):
+    def __repr__(self) -> str_type:
         tpl = "CategoricalDtype(categories={}ordered={})"
         if self.categories is None:
             data = "None, "
@@ -752,7 +752,7 @@ def construct_from_string(cls, string):
 
         raise TypeError("Could not construct DatetimeTZDtype")
 
-    def __str__(self):
+    def __str__(self) -> str_type:
         return "datetime64[{unit}, {tz}]".format(unit=self.unit, tz=self.tz)
 
     @property
@@ -889,7 +889,7 @@ def construct_from_string(cls, string):
                 pass
         raise TypeError("could not construct PeriodDtype")
 
-    def __str__(self):
+    def __str__(self) -> str_type:
         return self.name
 
     @property
@@ -1068,7 +1068,7 @@ def construct_from_string(cls, string):
     def type(self):
         return Interval
 
-    def __str__(self):
+    def __str__(self) -> str_type:
         if self.subtype is None:
             return "interval"
         return "interval[{subtype}]".format(subtype=self.subtype)

pandas/core/generic.py

@@ -2107,7 +2107,7 @@ def __setstate__(self, state):
     # ----------------------------------------------------------------------
     # Rendering Methods
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         # string representation based upon iterating over self
         # (since, by definition, `PandasContainers` are iterable)
         prepr = "[%s]" % ",".join(map(pprint_thing, self))

pandas/core/groupby/groupby.py

@@ -402,7 +402,7 @@ def __init__(
     def __len__(self):
         return len(self.groups)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         # TODO: Better repr for GroupBy object
         return object.__repr__(self)
 

pandas/core/groupby/grouper.py

@@ -210,7 +210,7 @@ def _set_grouper(self, obj, sort=False):
     def groups(self):
         return self.grouper.groups
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         attrs_list = (
             "{}={!r}".format(attr_name, getattr(self, attr_name))
             for attr_name in self._attributes
@@ -372,7 +372,7 @@ def __init__(
 
                 self.grouper = self.grouper.astype("timedelta64[ns]")
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "Grouping({0})".format(self.name)
 
     def __iter__(self):

pandas/core/indexes/frozen.py

@@ -105,10 +105,10 @@ def _disabled(self, *args, **kwargs):
             )
         )
 
-    def __str__(self):
+    def __str__(self) -> str:
         return pprint_thing(self, quote_strings=True, escape_chars=("\t", "\r", "\n"))
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "%s(%s)" % (self.__class__.__name__, str(self))
 
     __setitem__ = __setslice__ = __delitem__ = __delslice__ = _disabled
@@ -148,7 +148,7 @@ def values(self):
         arr = self.view(np.ndarray).copy()
         return arr
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         """
         Return a string representation for this object.
         """