update examples for series.info

Author: MarcoGorelli

pandas/core/series.py

@@ -4198,7 +4198,52 @@ def replace(
 ---  --------------  -----
  0   5 non-null      object
 dtypes: object(1)
-memory usage: 80.0+ bytes""",
+memory usage: 80.0+ bytes
+
+Prints a summary excluding information about its values:
+
+>>> s.info(verbose=False)
+<class 'pandas.core.series.Series'>
+Int64Index: 5 entries, 1 to 5
+dtypes: object(1)
+memory usage: 80.0+ bytes
+
+Pipe output of DataFrame.info to buffer instead of sys.stdout, get
+buffer content and writes to a text file:
+
+>>> import io
+>>> buffer = io.StringIO()
+>>> s.info(buf=buffer)
+>>> s = buffer.getvalue()
+>>> with open("df_info.txt", "w",
+...           encoding="utf-8") as f:  # doctest: +SKIP
+...     f.write(s)
+260
+
+The `memory_usage` parameter allows deep introspection mode, specially
+useful for big Series and fine-tune memory optimization:
+
+>>> random_strings_array = np.random.choice(['a', 'b', 'c'], 10 ** 6)
+>>> s = pd.Series(np.random.choice(['a', 'b', 'c'], 10 ** 6))
+>>> s.info()
+<class 'pandas.core.series.Series'>
+RangeIndex: 1000000 entries, 0 to 999999
+Series name: None
+    #   Non-Null Count    Dtype
+---  --------------    -----
+    0   1000000 non-null  object
+dtypes: object(1)
+memory usage: 7.6+ MB
+
+>>> s.info(memory_usage='deep')
+    <class 'pandas.core.series.Series'>
+    RangeIndex: 1000000 entries, 0 to 999999
+    Series name: None
+     #   Non-Null Count    Dtype
+    ---  --------------    -----
+     0   1000000 non-null  object
+    dtypes: object(1)
+    memory usage: 62.9 MB""",
         see_also_sub="""
 Series.describe: Generate descriptive statistics of Series.
 Series.memory_usage: Memory usage of Series.""",

pandas/tests/series/test_repr.py

@@ -492,14 +492,15 @@ def test_categorical_series_repr_timedelta_ordered(self):
         assert repr(s) == exp
 
     @pytest.mark.parametrize("verbose", [True, False])
-    def test_info(self, verbose, capsys):
+    def test_info(self, verbose):
         index = MultiIndex(
             levels=[["foo", "bar", "baz", "qux"], ["one", "two", "three"]],
             codes=[[0, 0, 0, 1, 1, 2, 2, 3, 3, 3], [0, 1, 2, 0, 1, 1, 2, 0, 1, 2]],
             names=["first", "second"],
         )
         s = Series(range(len(index)), index=index, name="sth")
-        s.info(verbose=verbose)
+        buf = StringIO()
+        s.info(verbose=verbose, buf=buf)
         expected = """<class 'pandas.core.series.Series'>
 MultiIndex: 10 entries, ('foo', 'one') to ('qux', 'three')
 """
@@ -512,7 +513,7 @@ def test_info(self, verbose, capsys):
         expected += f"""dtypes: int64(1)
 memory usage: {s.memory_usage()}.0+ bytes
 """
-        result = capsys.readouterr().out
+        result = buf.getvalue()
         assert result == expected
 
     @pytest.mark.skipif(PYPY, reason="on PyPy deep=True doesn't change result")