Skip to content

DOC: Added series example variable to flex_doc #23117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

DOC: Added series example variable to flex_doc #23117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 59 additions & 38 deletions pandas/core/ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ def make_invalid_op(name):
-------
invalid_op : function
"""

def invalid_op(self, other=None):
raise TypeError("cannot perform {name} with this index type: "
"{typ}".format(name=name, typ=type(self).__name__))
Expand Down Expand Up @@ -486,66 +487,104 @@ def _get_op_name(op, special):
e NaN -4.0 NaN
"""

_mul_example_SERIES = """
>>> a = pd.Series([1, 1, 1, np.nan], index=['a', 'b', 'c', 'd'])
>>> a
a 1.0
b 1.0
c 1.0
d NaN
dtype: float64
>>> b = pd.Series([1, np.nan, 1, np.nan], index=['a', 'b', 'd', 'e'])
>>> b
a 1.0
b NaN
d 1.0
e NaN
dtype: float64
>>> a.multiply(b, fill_value=0)
a 1.0
b 0.0
c 0.0
d 0.0
e NaN
dtype: float64
"""

_op_descriptions = {
# Arithmetic Operators
'add': {'op': '+',
'desc': 'Addition',
'reverse': 'radd',
'df_examples': _add_example_FRAME},
'df_examples': _add_example_FRAME,
'series_examples': None},
'sub': {'op': '-',
'desc': 'Subtraction',
'reverse': 'rsub',
'df_examples': _sub_example_FRAME},
'df_examples': _sub_example_FRAME,
'series_examples': None},
'mul': {'op': '*',
'desc': 'Multiplication',
'reverse': 'rmul',
'df_examples': None},
'df_examples': None,
'series_examples': _mul_example_SERIES},
'mod': {'op': '%',
'desc': 'Modulo',
'reverse': 'rmod',
'df_examples': _mod_example_FRAME},
'df_examples': _mod_example_FRAME,
'series_examples': None},
'pow': {'op': '**',
'desc': 'Exponential power',
'reverse': 'rpow',
'df_examples': None},
'df_examples': None,
'series_examples': None},
'truediv': {'op': '/',
'desc': 'Floating division',
'reverse': 'rtruediv',
'df_examples': None},
'df_examples': None,
'series_examples': None},
'floordiv': {'op': '//',
'desc': 'Integer division',
'reverse': 'rfloordiv',
'df_examples': None},
'df_examples': None,
'series_examples': None},
'divmod': {'op': 'divmod',
'desc': 'Integer division and modulo',
'reverse': None,
'df_examples': None},
'df_examples': None,
'series_examples': None},

# Comparison Operators
'eq': {'op': '==',
'desc': 'Equal to',
'reverse': None,
'df_examples': None},
'df_examples': None,
'series_examples': None},
'ne': {'op': '!=',
'desc': 'Not equal to',
'reverse': None,
'df_examples': None},
'df_examples': None,
'series_examples': None},
'lt': {'op': '<',
'desc': 'Less than',
'reverse': None,
'df_examples': None},
'df_examples': None,
'series_examples': None},
'le': {'op': '<=',
'desc': 'Less than or equal to',
'reverse': None,
'df_examples': None},
'df_examples': None,
'series_examples': None},
'gt': {'op': '>',
'desc': 'Greater than',
'reverse': None,
'df_examples': None},
'df_examples': None,
'series_examples': None},
'ge': {'op': '>=',
'desc': 'Greater than or equal to',
'reverse': None,
'df_examples': None}}
'df_examples': None,
'series_examples': None}}

_op_names = list(_op_descriptions.keys())
for key in _op_names:
Expand Down Expand Up @@ -580,31 +619,12 @@ def _get_op_name(op, special):

Examples
--------
>>> a = pd.Series([1, 1, 1, np.nan], index=['a', 'b', 'c', 'd'])
>>> a
a 1.0
b 1.0
c 1.0
d NaN
dtype: float64
>>> b = pd.Series([1, np.nan, 1, np.nan], index=['a', 'b', 'd', 'e'])
>>> b
a 1.0
b NaN
d 1.0
e NaN
dtype: float64
>>> a.add(b, fill_value=0)
a 2.0
b 1.0
c 1.0
d 1.0
e NaN
dtype: float64
{series_examples}

See also
--------
Series.{reverse}

"""

_arith_doc_FRAME = """
Expand Down Expand Up @@ -690,7 +710,6 @@ def _get_op_name(op, special):
Panel.{reverse}
"""


_agg_doc_PANEL = """
Wrapper method for {op_name}

Expand Down Expand Up @@ -732,7 +751,8 @@ def _make_flex_doc(op_name, typ):
if typ == 'series':
base_doc = _flex_doc_SERIES
doc = base_doc.format(desc=op_desc['desc'], op_name=op_name,
equiv=equiv, reverse=op_desc['reverse'])
equiv=equiv, reverse=op_desc['reverse'],
series_examples=op_desc['series_examples'])
elif typ == 'dataframe':
base_doc = _flex_doc_FRAME
doc = base_doc.format(desc=op_desc['desc'], op_name=op_name,
Expand Down Expand Up @@ -1086,6 +1106,7 @@ def add_special_arithmetic_methods(cls):
_, _, arith_method, comp_method, bool_method = _get_method_wrappers(cls)
new_methods = _create_methods(cls, arith_method, comp_method, bool_method,
special=True)

# inplace operators (I feel like these should get passed an `inplace=True`
# or just be removed

Expand Down Expand Up @@ -1296,7 +1317,7 @@ def wrapper(left, right):
"{op}".format(typ=type(left).__name__, op=str_rep))

elif (is_extension_array_dtype(left) or
(is_extension_array_dtype(right) and not is_scalar(right))):
(is_extension_array_dtype(right) and not is_scalar(right))):
# GH#22378 disallow scalar to exclude e.g. "category", "Int64"
return dispatch_to_extension_op(op, left, right)

Expand Down