fix: `ArrayBuilder.show()` formatter forwarding by aashirvad08 · Pull Request #3796 · scikit-hep/awkward

aashirvad08 · 2026-01-11T09:43:53Z

ArrayBuilder.show is documented to forward arguments unchanged to
snapshot().show, but currently wraps the formatter argument in a
Formatter instance. This causes Array.show to receive a non-mapping
formatter and raises a TypeError.

This change forwards formatter unchanged and adds a regression test
ensuring ArrayBuilder.show behaves identically to snapshot().show.

Fixes #3724

codecov · 2026-01-11T10:21:35Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.66%. Comparing base (c6fc079) to head (d3ff997).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Files with missing lines	Coverage Δ
src/awkward/highlevel.py	`78.52% <100.00%> (+0.22%)`	⬆️

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2026-01-11T10:27:39Z

The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR3796

ikrommyd

Thanks @X0708a for this!

This looks like the right fix and it is apparently something that was just forgotten in #3348

Could you also introduce the other arguments that #3348 introduced to show()? See the changes that this PR made and what Array.show() accepts:

awkward/src/awkward/highlevel.py

Lines 1401 to 1414 in c6fc079

    
           def show( 
        
               self, 
        
               limit_rows=20, 
        
               limit_cols=80, 
        
               *, 
        
               type=False, 
        
               named_axis=False, 
        
               nbytes=False, 
        
               backend=False, 
        
               all=False, 
        
               stream=STDOUT, 
        
               formatter=None, 
        
               precision=3, 
        
           ):

Since snapshot() returns an ak.Array, you can forward all of them to the .snapshot().show(...) call.

I have one comment regarding moving the test in the tests directory and I would also like you to add a bit more testing in the test. Test at least for example the few builder structures that we have in its docstring: https://awkward-array.org/doc/main/reference/generated/ak.ArrayBuilder.html. If you search for ".show()" in your browser in this page, you will see that we do .show() for a few builder types. Just test those in your test.

src/awkward/highlevel.py

aashirvad08 · 2026-01-11T16:13:14Z

Thanks for the review!
I’ve updated ArrayBuilder.show() to forward all arguments supported by Array.show(), moved the test to the appropriate tests directory, and expanded coverage to include multiple builder structures based on the documentation examples.
Please let me know if anything else should be adjusted.

ikrommyd · 2026-01-11T23:43:33Z

Hi @X0708a, thanks for the changes! I would like to ask you to do a few more things:

You'd still need to remove test_arraybuilder_show_forwards_formatter from src/awkward/highlevel.py.
Could you please update the docstring of the show() method you edited like the others? You added new arguments that need to be reflected in the docstring.
I would urge you to create a new test file instead of editing an old one, so please move your tests from tests/test_2055_array_builder_check.py to a new file that is numbered as 3796 (this PR) or 3724 (the issue it fixes) (tests/test_3796_array_builder_show.py or something like that).
And finally, I made a mistake when I set you can do assert builder.show() == builder.snapshot().show() as show() does not return anything. You are just comparing None == None in this case. Please see tests/test_2803_string_formatter.py to see how to capture those strings in a stream and actually compare them.

I'd recommend git pulling first before pushing instead of force-pushing to grab the changes from the pre-commit ci hook btw.

aashirvad08 · 2026-01-12T03:42:25Z

Thanks for the detailed feedback.
I’ve removed the test from the source file, updated the ArrayBuilder.show() docstring to reflect the full argument list, moved the tests into a new dedicated test file for this issue, and updated the tests to capture and compare output via a stream as suggested.
Please let me know if anything else should be adjusted.

ianna

@X0708a - This looks great! Thank you. Just a minor comment - please, move the tests from test_2055*.py to test_3724*.py Thanks!

tests/test_2055_array_builder_check.py

tests/test_3724_arraybuilder_show.py

src/awkward/highlevel.py

ikrommyd

Other than the docstring style change that needs to be consistent with the rest and our docs, this looks good to me!

Fix ArrayBuilder.show formatter forwarding

aashirvad08 · 2026-01-12T12:58:27Z

Updated the docstring to match the project’s Args-style documentation and removed the extra blank line under the docstring.
Please let me know if anything else needs adjustment.

ikrommyd · 2026-01-12T13:14:38Z

I have just pushed a minor docstring change to make it match exactly with the other two show docstrings and merged main on the feature branch. Should be perfect now.

ikrommyd

LGTM! Thanks!

ikrommyd · 2026-01-12T13:17:20Z

@all-contributors please add @X0708a for code

allcontributors · 2026-01-12T13:17:30Z

@ikrommyd

I've put up a pull request to add @X0708a! 🎉

ianna

@X0708a - Thank you for your contribution! This looks great: all tests pass and the PR is ready to be merged. Thanks!

ikrommyd changed the title ~~Fix ArrayBuilder.show formatter forwarding~~ fix: incorrect ArrayBuilder.show() formatter forwarding Jan 11, 2026

ikrommyd requested changes Jan 11, 2026

View reviewed changes

src/awkward/highlevel.py Outdated Show resolved Hide resolved

aashirvad08 force-pushed the fix-arraybuilder-show-formatter branch from e0d488b to 8cb253c Compare January 11, 2026 16:10

aashirvad08 force-pushed the fix-arraybuilder-show-formatter branch from 6c38511 to 84db75d Compare January 12, 2026 03:41

ianna requested changes Jan 12, 2026

View reviewed changes

tests/test_2055_array_builder_check.py Outdated Show resolved Hide resolved

ianna reviewed Jan 12, 2026

View reviewed changes

tests/test_3724_arraybuilder_show.py Show resolved Hide resolved

aashirvad08 force-pushed the fix-arraybuilder-show-formatter branch from 49acf67 to 2adee49 Compare January 12, 2026 09:18

ikrommyd reviewed Jan 12, 2026

View reviewed changes

src/awkward/highlevel.py Outdated Show resolved Hide resolved

ikrommyd reviewed Jan 12, 2026

View reviewed changes

src/awkward/highlevel.py Outdated Show resolved Hide resolved

ikrommyd self-requested a review January 12, 2026 11:45

ikrommyd requested changes Jan 12, 2026

View reviewed changes

:wq

0bb93d2

Fix ArrayBuilder.show formatter forwarding

aashirvad08 force-pushed the fix-arraybuilder-show-formatter branch from 89df521 to 0bb93d2 Compare January 12, 2026 12:56

style: pre-commit fixes

96a7129

ikrommyd added 2 commits January 12, 2026 14:10

Merge branch 'main' into fix-arraybuilder-show-formatter

42ebcfc

fix docstring variables

d3ff997

ikrommyd requested review from ianna and ikrommyd January 12, 2026 13:14

ikrommyd approved these changes Jan 12, 2026

View reviewed changes

allcontributors bot mentioned this pull request Jan 12, 2026

docs: add X0708a as a contributor for code #3797

Merged

ianna changed the title ~~fix: incorrect ArrayBuilder.show() formatter forwarding~~ fix: ArrayBuilder.show() formatter forwarding Jan 12, 2026

ianna approved these changes Jan 12, 2026

View reviewed changes

ianna enabled auto-merge (squash) January 12, 2026 13:30

ianna disabled auto-merge January 12, 2026 13:34

ianna merged commit 6bb426b into scikit-hep:main Jan 12, 2026
40 checks passed

	def show(
	self,
	limit_rows=20,
	limit_cols=80,
	*,
	type=False,
	named_axis=False,
	nbytes=False,
	backend=False,
	all=False,
	stream=STDOUT,
	formatter=None,
	precision=3,
	):

Conversation

aashirvad08 commented Jan 11, 2026

Uh oh!

codecov bot commented Jan 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Jan 11, 2026

Uh oh!

ikrommyd left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aashirvad08 commented Jan 11, 2026

Uh oh!

ikrommyd commented Jan 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aashirvad08 commented Jan 12, 2026

Uh oh!

ianna left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ikrommyd left a comment

Choose a reason for hiding this comment

Uh oh!

aashirvad08 commented Jan 12, 2026

Uh oh!

ikrommyd commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ikrommyd left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ikrommyd commented Jan 12, 2026

Uh oh!

allcontributors bot commented Jan 12, 2026

Uh oh!

ianna left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 11, 2026 •

edited

Loading

ikrommyd left a comment •

edited

Loading

ikrommyd commented Jan 11, 2026 •

edited

Loading

ikrommyd commented Jan 12, 2026 •

edited

Loading

ikrommyd left a comment •

edited

Loading