FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

MNT: Privatize Formatter attributes by timhoffm · Pull Request #31416 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

MNT: Privatize Formatter attributes #31416

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
QuLogic merged 1 commit into from
Apr 23, 2026
Conversation 5 Commits 1 Checks 38 Files changed
Merged

MNT: Privatize Formatter attributes #31416

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

Filter by extension

Filter by extension .py  (4) .pyi  (1) .rst  (1) All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
8 changes: 8 additions & 0 deletions doc/api/next_api_changes/deprecations/31416-TH.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Formatter attributes
~~~~~~~~~~~~~~~~~~~~

These following attributes are considered internal and users should not have a need to access them:

- `.ScalarFormatter`: ``orderOfMagnitude`` and ``format``
- `.ConciseDateFormatter`: ``offset_format``
- `.Formatter`: ``locs``
16 changes: 10 additions & 6 deletions lib/matplotlib/dates.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,10 @@ class ConciseDateFormatter(ticker.Formatter):

"""

offset_string = _api.deprecate_privatize_attribute(
"3.11", alternative="get_offset()"
)

def __init__(self, locator, tz=None, formats=None, offset_formats=None,
zero_formats=None, show_offset=True, *, usetex=None):
"""
Expand Down Expand Up @@ -719,7 +723,7 @@ def __init__(self, locator, tz=None, formats=None, offset_formats=None,
'%Y-%b-%d',
'%Y-%b-%d',
'%Y-%b-%d %H:%M']
self.offset_string = ''
self._offset_string = ''

QuLogic Mar 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

There are still all the internal users of this that aren't converted and will raise a warning.
self.show_offset = show_offset
self._usetex = mpl._val_or_rc(usetex, 'text.usetex')

Expand Down Expand Up @@ -799,21 +803,21 @@ def format_ticks(self, values):
if (self._locator.axis and
self._locator.axis.__name__ in ('xaxis', 'yaxis')
and self._locator.axis.get_inverted()):
self.offset_string = tickdatetime[0].strftime(offsetfmts[level])
self._offset_string = tickdatetime[0].strftime(offsetfmts[level])
else:
self.offset_string = tickdatetime[-1].strftime(offsetfmts[level])
self._offset_string = tickdatetime[-1].strftime(offsetfmts[level])
if self._usetex:
self.offset_string = _wrap_in_tex(self.offset_string)
self._offset_string = _wrap_in_tex(self._offset_string)
else:
self.offset_string = ''
self._offset_string = ''

if self._usetex:
return [_wrap_in_tex(l) for l in labels]
else:
return labels

def get_offset(self):
return self.offset_string
return self._offset_string

def format_data_short(self, value):
return num2date(value, tz=self._tz).strftime('%Y-%m-%d %H:%M:%S')
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/testing/jpl_units/UnitDblFormatter.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class UnitDblFormatter(ticker.ScalarFormatter):

def __call__(self, x, pos=None):
# docstring inherited
if len(self.locs) == 0:
if len(self._locs) == 0:
return ''
else:
return f'{x:.12}'
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/tests/test_ticker.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -920,7 +920,7 @@ def test_scilimits(self, sci_type, scilimits, lim, orderOfMag, fewticks):
ax.yaxis.set_major_locator(mticker.MaxNLocator(4))

tmp_form.set_locs(ax.yaxis.get_majorticklocs())
assert orderOfMag == tmp_form.orderOfMagnitude
assert orderOfMag == tmp_form._orderOfMagnitude

@pytest.mark.parametrize('value, expected', format_data)
def test_format_data(self, value, expected):
Expand Down
95 changes: 50 additions & 45 deletions lib/matplotlib/ticker.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,9 @@ class Formatter(TickHelper):
"""
# some classes want to see all the locs to help format
# individual ones
locs = []
_locs = []

locs = _api.deprecate_privatize_attribute("3.11")

def __call__(self, x, pos=None):
"""
Expand Down Expand Up @@ -250,7 +252,7 @@ def set_locs(self, locs):
This method is called before computing the tick labels because some
formatters need to know all tick locations to do so.
"""
self.locs = locs
self._locs = locs

@staticmethod
def fix_minus(s):
Expand Down Expand Up @@ -458,15 +460,18 @@ class ScalarFormatter(Formatter):

"""

orderOfMagnitude = _api.deprecate_privatize_attribute("3.11")
format = _api.deprecate_privatize_attribute("3.11")

def __init__(self, useOffset=None, useMathText=None, useLocale=None, *,
usetex=None):
useOffset = mpl._val_or_rc(useOffset, 'axes.formatter.useoffset')
self._offset_threshold = mpl.rcParams['axes.formatter.offset_threshold']
self.set_useOffset(useOffset)
self.set_usetex(usetex)
self.set_useMathText(useMathText)
self.orderOfMagnitude = 0
self.format = ''
self._orderOfMagnitude = 0
self._format = ''
self._scientific = True
self._powerlimits = mpl.rcParams['axes.formatter.limits']
self.set_useLocale(useLocale)
Expand Down Expand Up @@ -615,13 +620,13 @@ def __call__(self, x, pos=None):
"""
Return the format for tick value *x* at position *pos*.
"""
if len(self.locs) == 0:
if len(self._locs) == 0:
return ''
else:
xp = (x - self.offset) / (10. ** self.orderOfMagnitude)
xp = (x - self.offset) / (10. ** self._orderOfMagnitude)
if abs(xp) < 1e-8:
xp = 0
return self._format_maybe_minus_and_locale(self.format, xp)
return self._format_maybe_minus_and_locale(self._format, xp)

def set_scientific(self, b):
"""
Expand Down Expand Up @@ -715,20 +720,20 @@ def get_offset(self):
"""
Return scientific notation, plus offset.
"""
if len(self.locs) == 0:
if len(self._locs) == 0:
return ''
if self.orderOfMagnitude or self.offset:
if self._orderOfMagnitude or self.offset:
offsetStr = ''
sciNotStr = ''
if self.offset:
offsetStr = self.format_data(self.offset)
if self.offset > 0:
offsetStr = '+' + offsetStr
if self.orderOfMagnitude:
if self._orderOfMagnitude:
if self._usetex or self._useMathText:
sciNotStr = self.format_data(10 ** self.orderOfMagnitude)
sciNotStr = self.format_data(10 ** self._orderOfMagnitude)
else:
sciNotStr = '1e%d' % self.orderOfMagnitude
sciNotStr = '1e%d' % self._orderOfMagnitude
if self._useMathText or self._usetex:
if sciNotStr != '':
sciNotStr = r'\times\mathdefault{%s}' % sciNotStr
Expand All @@ -740,15 +745,15 @@ def get_offset(self):

def set_locs(self, locs):
# docstring inherited
self.locs = locs
if len(self.locs) > 0:
self._locs = locs
if len(self._locs) > 0:
if self._useOffset:
self._compute_offset()
self._set_order_of_magnitude()
self._set_format()

def _compute_offset(self):
locs = self.locs
locs = self._locs
# Restrict to visible ticks.
vmin, vmax = sorted(self.axis.get_view_interval())
locs = np.asarray(locs)
Expand Down Expand Up @@ -791,19 +796,19 @@ def _set_order_of_magnitude(self):
# if using a numerical offset, find the exponent after applying the
# offset. When lower power limit = upper <> 0, use provided exponent.
if not self._scientific:
self.orderOfMagnitude = 0
self._orderOfMagnitude = 0
return
if self._powerlimits[0] == self._powerlimits[1] != 0:
# fixed scaling when lower power limit = upper <> 0.
self.orderOfMagnitude = self._powerlimits[0]
self._orderOfMagnitude = self._powerlimits[0]
return
# restrict to visible ticks
vmin, vmax = sorted(self.axis.get_view_interval())
locs = np.asarray(self.locs)
locs = np.asarray(self._locs)
locs = locs[(vmin <= locs) & (locs <= vmax)]
locs = np.abs(locs)
if not len(locs):
self.orderOfMagnitude = 0
self._orderOfMagnitude = 0
return
if self.offset:
oom = math.floor(math.log10(vmax - vmin))
Expand All @@ -814,28 +819,28 @@ def _set_order_of_magnitude(self):
else:
oom = math.floor(math.log10(val))
if oom <= self._powerlimits[0]:
self.orderOfMagnitude = oom
self._orderOfMagnitude = oom
elif oom >= self._powerlimits[1]:
self.orderOfMagnitude = oom
self._orderOfMagnitude = oom
else:
self.orderOfMagnitude = 0
self._orderOfMagnitude = 0

def _set_format(self):
# set the format string to format all the ticklabels
if len(self.locs) < 2:
if len(self._locs) < 2:
# Temporarily augment the locations with the axis end points.
_locs = [*self.locs, *self.axis.get_view_interval()]
_locs = [*self._locs, *self.axis.get_view_interval()]
else:
_locs = self.locs
locs = (np.asarray(_locs) - self.offset) / 10. ** self.orderOfMagnitude
_locs = self._locs
locs = (np.asarray(_locs) - self.offset) / 10. ** self._orderOfMagnitude
loc_range = np.ptp(locs)
# Curvilinear coordinates can yield two identical points.
if loc_range == 0:
loc_range = np.max(np.abs(locs))
# Both points might be zero.
if loc_range == 0:
loc_range = 1
if len(self.locs) < 2:
if len(self._locs) < 2:
# We needed the end points only for the loc_range calculation.
locs = locs[:-2]
loc_range_oom = int(math.floor(math.log10(loc_range)))
Expand All @@ -849,9 +854,9 @@ def _set_format(self):
else:
break
sigfigs += 1
self.format = f'%1.{sigfigs}f'
self._format = f'%1.{sigfigs}f'
if self._usetex or self._useMathText:
self.format = r'$\mathdefault{%s}$' % self.format
self._format = r'$\mathdefault{%s}$' % self._format


class LogFormatter(Formatter):
Expand Down Expand Up @@ -1243,7 +1248,7 @@ def set_minor_number(self, minor_number):
self._minor_number = minor_number

def set_locs(self, locs):
self.locs = np.array(locs)
self._locs = np.array(locs)
self._labelled.clear()

if not self._minor:
Expand All @@ -1269,7 +1274,7 @@ def set_locs(self, locs):
# the previous, and between the ticks and the next one. Ticks
# with smallest minimum are chosen. As tiebreak, the ticks
# with smallest sum is chosen.
diff = np.diff(-np.log(1 / self.locs - 1))
diff = np.diff(-np.log(1 / self._locs - 1))
space_pessimistic = np.minimum(
np.concatenate(((np.inf,), diff)),
np.concatenate((diff, (np.inf,))),
Expand All @@ -1279,7 +1284,7 @@ def set_locs(self, locs):
+ np.concatenate((diff, (0,)))
)
good_minor = sorted(
range(len(self.locs)),
range(len(self._locs)),
key=lambda i: (space_pessimistic[i], space_sum[i]),
)[-self._minor_number:]
self._labelled.update(locs[i] for i in good_minor)
Expand Down Expand Up @@ -1330,11 +1335,11 @@ def __call__(self, x, pos=None):
exponent = round(math.log10(1 - x))
s = self._one_minus("10^{%d}" % exponent)
elif x < 0.1:
s = self._format_value(x, self.locs)
s = self._format_value(x, self._locs)
elif x > 0.9:
s = self._one_minus(self._format_value(1-x, 1-self.locs))
s = self._one_minus(self._format_value(1-x, 1-self._locs))
else:
s = self._format_value(x, self.locs, sci_notation=False)
s = self._format_value(x, self._locs, sci_notation=False)
return r"$\mathdefault{%s}$" % s

def format_data_short(self, value):
Expand Down Expand Up @@ -1440,18 +1445,18 @@ def __call__(self, x, pos=None):
If there is no currently offset in the data, it returns the best
engineering formatting that fits the given argument, independently.
"""
if len(self.locs) == 0 or self.offset == 0:
if len(self._locs) == 0 or self.offset == 0:
return self.fix_minus(self.format_data(x))
else:
xp = (x - self.offset) / (10. ** self.orderOfMagnitude)
xp = (x - self.offset) / (10. ** self._orderOfMagnitude)
if abs(xp) < 1e-8:
xp = 0
return self._format_maybe_minus_and_locale(self.format, xp)
return self._format_maybe_minus_and_locale(self._format, xp)

def set_locs(self, locs):
# docstring inherited
self.locs = locs
if len(self.locs) > 0:
self._locs = locs
if len(self._locs) > 0:
vmin, vmax = sorted(self.axis.get_view_interval())
if self._useOffset:
self._compute_offset()
Expand All @@ -1465,25 +1470,25 @@ def set_locs(self, locs):
# value:
self.offset = round((vmin + vmax)/2, 3)
# Use log1000 to use engineers' oom standards
self.orderOfMagnitude = math.floor(math.log(vmax - vmin, 1000))*3
self._orderOfMagnitude = math.floor(math.log(vmax - vmin, 1000))*3
self._set_format()

# Simplify a bit ScalarFormatter.get_offset: We always want to use
# self.format_data. Also we want to return a non-empty string only if there
# is an offset, no matter what is self.orderOfMagnitude. If there _is_ an
# offset, self.orderOfMagnitude is consulted. This behavior is verified
# is an offset, no matter what is self._orderOfMagnitude. If there _is_ an
# offset, self._orderOfMagnitude is consulted. This behavior is verified
# in `test_ticker.py`.
def get_offset(self):
# docstring inherited
if len(self.locs) == 0:
if len(self._locs) == 0:
return ''
if self.offset:
offsetStr = ''
if self.offset:
offsetStr = self.format_data(self.offset)
if self.offset > 0:
offsetStr = '+' + offsetStr
sciNotStr = self.format_data(10 ** self.orderOfMagnitude)
sciNotStr = self.format_data(10 ** self._orderOfMagnitude)
if self._useMathText or self._usetex:
if sciNotStr != '':
sciNotStr = r'\times%s' % sciNotStr
Expand Down
3 changes: 3 additions & 0 deletions lib/matplotlib/ticker.pyi
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class TickHelper:

class Formatter(TickHelper):
locs: list[float]
_locs: list[float]
def __call__(self, x: float, pos: int | None = ...) -> str: ...
def format_ticks(self, values: list[float]) -> list[str]: ...
def format_data(self, value: float) -> str: ...
Expand Down Expand Up @@ -58,7 +59,9 @@ class StrMethodFormatter(Formatter):

class ScalarFormatter(Formatter):
orderOfMagnitude: int
_orderOfMagnitude: int
format: str
_format: str
def __init__(
self,
useOffset: bool | float | None = ...,
Expand Down
Loading
Back | FazBrowse Home | New Git URL