[X ] "closes[ENH]: Allow list of padding values for bar_label #29647 " is in the body of the PR description to [(https://github.com/[ENH]: Allow list of padding values for bar_label #29647)]
[ X] new and changed code istested
[X ]Plotting related features are demonstrated in anexample
New Features andAPI Changes are noted with adirective and release note
[ X] Documentation complies withgeneral anddocstring guidelines

ENH: Add support for per-label padding in bar_label

56fcef2

Implement support for array-like padding in bar_label.This allows users to specify different padding values for individual labels by passing an array-like object to the padding parameter.Updated the docstring to reflect acceptance of float or array-like of correct length.Ex: ax.bar_label(bars, padding=[3, 3, 3, 15])

github-actionsbot reviewed

Mar 2, 2025

View reviewed changes

Copy link

github-actionsbot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join uson gitter for real-time discussion.

For details on testing, writing docs, and our review process, please seethe developer guide

We strive to be a welcoming and open project. Please follow ourCode of Conduct.

rcomer requested changes

Mar 2, 2025

View reviewed changes

Copy link

Member

rcomer left a comment

Choose a reason for hiding this comment

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

Please also add unit tests to verify that the new behaviour does what you intend.

lib/matplotlib/axes/_axes.py Outdated

		for bar, err, dat, lbl in itertools.zip_longest(
		bars, errs, datavalues, labels
		try:
		if not isinstance(padding, (str, bytes)) and np.iterable(padding):

Copy link

Member

rcomerMar 2, 2025

Choose a reason for hiding this comment

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

I do not think it is necessary to check for string or bytes object here. Currently we assume the user correctly passed a float, so I think in future we can assume they correctly passed a float or iterable.

Copy link

ContributorAuthor

brifore13Mar 4, 2025

Choose a reason for hiding this comment

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

Thanks@rcomer, currently making the corrections and will add unit tests. This is my first PR request, so thank you for your help and patience.

Copy link

Member

rcomerMar 4, 2025

Choose a reason for hiding this comment

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

Thanks@brifore13, if you need any help, feel free to ask questions here. Or you may prefer to ask them in ourincubator gitter room.

lib/matplotlib/axes/_axes.py Outdated

		if len(padding_array) != len(bars):
		raise ValueError(
		f"padding must be of length {len(bars)} when passed as a sequence")
		padding_list = list(padding_array)

Copy link

Member

rcomerMar 2, 2025

Choose a reason for hiding this comment

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

The array will work fine inzip_longest, so we do not need to convert this to a list.

lib/matplotlib/axes/_axes.py Outdated

		else:
		# single value, apply to all labels
		padding_list = [padding] * len(bars)
		except (TypeError, ValueError):

Copy link

Member

rcomerMar 2, 2025

Choose a reason for hiding this comment

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

This will catch theValueError you added for the wrong length iterable. I do not think you meant to do that.

lib/matplotlib/axes/_axes.py Outdated

		# single value, apply to all labels
		padding_list = [padding] * len(bars)
		except (TypeError, ValueError):
		# not iterable or wrong length, use scalar padding

Copy link

Member

rcomerMar 2, 2025

Choose a reason for hiding this comment

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

you already handled the "not iterable" case with theelse on line 2948.

Copy link

Member

rcomer commentedMar 2, 2025

The type hint will also need updating

matplotlib/lib/matplotlib/axes/_axes.pyi

Line 271 in03b74ea

padding:float= ...,

Copy link

Member

story645 commentedMar 4, 2025

try installing the pre-commit hooks to help spot and fix the pre-commit errors:

https://matplotlib.org/devdocs/devel/development_setup.html#install-pre-commit-hooks

Add unit tests and modified logic for bar_label padding

5bfa212

Added unit testing for float and array-like processing. Modified logic based on requested changes. Updated type hint.

melissawm added this toFirst Time Contributors

Mar 5, 2025

melissawm moved this toNeeds review inFirst Time Contributors

Mar 5, 2025

rcomer reviewed

Mar 6, 2025

View reviewed changes

Copy link

Member

rcomer left a comment

Choose a reason for hiding this comment

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

Thanks@brifore13 I think this is looking in good shape now. I just have some minor comments on the change and you will also need to runboilerplate.py so thatpyplot.bar_label gets updated too.

lib/matplotlib/axes/_axes.py Outdated

		bars, errs, datavalues, labels
		if np.iterable(padding):
		# if padding iterable, check length
		padding_array = np.asarray(padding)

Copy link

Member

rcomerMar 6, 2025

Choose a reason for hiding this comment

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

Suggested change

	padding_array=np.asarray(padding)
	padding=np.asarray(padding)

I suggest to just call thispadding as it may end up an array or list and we don't mind which. It means we replace the originalpadding but that is OK since we were not going to need the original again.

lib/matplotlib/tests/test_axes.py Outdated

Comment on lines 8880 to 8881

		ax = plt.gca()
		rects = ax.bar(xs, heights)

Copy link

Member

rcomerMar 6, 2025

Choose a reason for hiding this comment

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

Suggested change

	ax=plt.gca()
	rects=ax.bar(xs,heights)

For efficiency, we can remove these lines and just reuse the originalrects.

rcomer added the New feature label

Mar 7, 2025

rcomer added this to thev3.11.0 milestone

Mar 7, 2025

Update pyplot, completed requested changes

f8985e2

1. ran boilerplate.py2. padding_array to padding3. removed second rects in unit testing

github-actionsbot added the topic: pyplot API label

Mar 10, 2025

rcomer approved these changes

Mar 10, 2025

View reviewed changes

timhoffm reviewed

Mar 10, 2025

View reviewed changes

Copy link

Member

timhoffm left a comment

Choose a reason for hiding this comment

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

This should get a What's New entry. Seehttps://matplotlib.org/devdocs/users/next_whats_new/README.html

lib/matplotlib/axes/_axes.pyShow resolvedHide resolved

Added a whats new entry

8fc5578

timhoffm reviewed

Mar 18, 2025

View reviewed changes

doc/users/next_whats_new/bar_label_padding_update.rst OutdatedShow resolvedHide resolved

Versionadded and more concise wording of whats new

fde2fa2

timhoffm approved these changes

Mar 18, 2025

View reviewed changes

timhoffm reviewed

Mar 18, 2025

View reviewed changes

lib/matplotlib/axes/_axes.py OutdatedShow resolvedHide resolved

Fix whitespace

7f6fffe

timhoffm merged commitf730235 intomatplotlib:main

Mar 18, 2025

39 of 41 checks passed

github-project-automationbot moved this fromNeeds review toWaiting for author inFirst Time Contributors

Mar 18, 2025

Copy link

Member

timhoffm commentedMar 18, 2025

Thanks@brifore13, and congratulations on your first contribution to Matplotlib! 🎉 We'd welcome to see you back!

QuLogic moved this fromWaiting for author toMerged inFirst Time Contributors

Mar 18, 2025

Labels

New feature topic: pyplot API

4 participants

Movatterモバイル変換

Uh oh!

ENH: Add support for per-label padding in bar_label#29696

ENH: Add support for per-label padding in bar_label#29696

Uh oh!

Conversation

brifore13 commentedMar 2, 2025

PR summary

PR checklist

Uh oh!

github-actionsbot left a comment

Choose a reason for hiding this comment

Uh oh!

rcomer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rcomer commentedMar 2, 2025

Uh oh!

story645 commentedMar 4, 2025

Uh oh!

rcomer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timhoffm commentedMar 18, 2025

Uh oh!

Uh oh!