Skip to content

BUG: Plotting use FixedLocator #26185

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

Merged
merged 7 commits into from
Apr 30, 2019
Merged

BUG: Plotting use FixedLocator #26185

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2e732b1
BUG: Plotting use FixedLocator
nrebena Apr 22, 2019
7cea50a
TST: Add test for #7612 #22334 #15912
Apr 23, 2019
7e67f99
CLN: Fiex visual indent for PEP8
Apr 23, 2019
3620080
TST: Split test for #15912
Apr 24, 2019
f343631
CLN: Fix import position in _post_plot_logic_common
Apr 24, 2019
62874fb
DOC: Add whatsnew entry in Plotting
Apr 24, 2019
863ba3d
DOC: Minor doc correction in whatsnew entry
nrebena Apr 30, 2019
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
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.25.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ Plotting

- Fixed bug where :class:`api.extensions.ExtensionArray` could not be used in matplotlib plotting (:issue:`25587`)
- Bug in an error message in :meth:`DataFrame.plot`. Improved the error message if non-numerics are passed to :meth:`DataFrame.plot` (:issue:`25481`)
-
- If the index of a data frame is objects (i.e. non-numerical/non-datetime), the ticklabel position are now fixed using matplotlib.ticker.FixedLocator (:issue:`7612` :issue:`15912` :issue:`22334`)
-
-

Expand Down
12 changes: 10 additions & 2 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,7 @@ def _add_table(self):

def _post_plot_logic_common(self, ax, data):
"""Common post process for each axes"""
from matplotlib.ticker import FixedLocator, FixedFormatter

def get_label(i):
try:
Expand All @@ -410,8 +411,12 @@ def get_label(i):

if self.orientation == 'vertical' or self.orientation is None:
if self._need_to_set_index:
xticklabels = [get_label(x) for x in ax.get_xticks()]
xticks = ax.get_xticks()
xticklabels = [get_label(x) for x in xticks]
ax.set_xticklabels(xticklabels)
ax.xaxis.set_major_locator(FixedLocator(xticks))
ax.xaxis.set_major_formatter(FixedFormatter(xticklabels))

self._apply_axis_properties(ax.xaxis, rot=self.rot,
fontsize=self.fontsize)
self._apply_axis_properties(ax.yaxis, fontsize=self.fontsize)
Expand All @@ -422,8 +427,11 @@ def get_label(i):

elif self.orientation == 'horizontal':
if self._need_to_set_index:
yticklabels = [get_label(y) for y in ax.get_yticks()]
yticks = ax.get_yticks()
yticklabels = [get_label(y) for y in yticks]
ax.set_yticklabels(yticklabels)
ax.xaxis.set_major_locator(FixedLocator(yticks))
ax.xaxis.set_major_formatter(FixedFormatter(yticklabels))
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the x axis given the y-tick(label)s here? Seems like an error to me.
Meaning the "horizontal" direction is not sufficiently tested.

Also note that ax.set_xticklabels(xticklabels) and ax.xaxis.set_major_formatter(FixedFormatter(xticklabels)) are redundant. One of those lines should be enough.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is definitly an error.
And this part is definitly not tested at all. None of the tests in plotting even hit this lines. This is because the self._need_to_set_index is only set to True for plot that have a self.orientation "vertical", so there is no way to go inside this loop.
What is the best course of action? Deleting this part that could never get hits?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have identified dead code you can submit a follow up PR to remove

self._apply_axis_properties(ax.yaxis, rot=self.rot,
fontsize=self.fontsize)
self._apply_axis_properties(ax.xaxis, fontsize=self.fontsize)
Expand Down
34 changes: 34 additions & 0 deletions pandas/tests/plotting/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2995,6 +2995,40 @@ def test_secondary_axis_font_size(self, method):
self._check_ticks_props(axes=ax.right_ax,
ylabelsize=fontsize)

@pytest.mark.slow
def test_x_string_values_ticks(self):
# Test if string plot index have a fixed xtick position
# GH: 7612, GH: 22334
df = pd.DataFrame({'sales': [3, 2, 3],
'visits': [20, 42, 28],
'day': ['Monday', 'Tuesday', 'Wednesday']})
ax = df.plot.area(x='day')
ax.set_xlim(-1, 3)
xticklabels = [t.get_text() for t in ax.get_xticklabels()]
labels_position = dict(zip(xticklabels, ax.get_xticks()))
# Testing if the label stayed at the right position
assert labels_position['Monday'] == 0.0
assert labels_position['Tuesday'] == 1.0
assert labels_position['Wednesday'] == 2.0

@pytest.mark.slow
def test_x_multiindex_values_ticks(self):
# Test if multiindex plot index have a fixed xtick position
# GH: 15912
index = pd.MultiIndex.from_product([[2012, 2013], [1, 2]])
df = pd.DataFrame(np.random.randn(4, 2),
columns=['A', 'B'],
index=index)
ax = df.plot()
ax.set_xlim(-1, 4)
xticklabels = [t.get_text() for t in ax.get_xticklabels()]
labels_position = dict(zip(xticklabels, ax.get_xticks()))
# Testing if the label stayed at the right position
assert labels_position['(2012, 1)'] == 0.0
assert labels_position['(2012, 2)'] == 1.0
assert labels_position['(2013, 1)'] == 2.0
assert labels_position['(2013, 2)'] == 3.0


def _generate_4_axes_via_gridspec():
import matplotlib.pyplot as plt
Expand Down