AttributeError: 'EnhancedProgressBar' object has no attribute 'is_hidden'. Did you mean: 'hidden'?

[CacucoH]

Background

I've installed this program via pip, python version is 3.13.2. Here's the list of versions of deps being installed:

attrs==25.3.0
banal==1.0.6
beartype==0.20.2
beautifulsoup4==4.13.4
binaryornot==0.4.4
boolean.py==5.0
certifi==2025.4.26
cffi==1.17.1
chardet==5.2.0
charset-normalizer==3.4.2
click==8.2.0
colorama==0.4.6
commoncode==32.2.1
container-inspector==33.0.0
cryptography==44.0.3
debian_inspector==31.1.0
dockerfile-parse==2.0.1
dparse2==0.7.0
extractcode==31.0.0
extractcode-7z==16.5.210531
extractcode-libarchive==3.5.1.210531
fasteners==0.19
fingerprints==1.2.3
ftfy==6.3.1
gemfileparser2==0.9.4
html5lib==1.1
idna==3.10
importlib_metadata==8.7.0
intbitset==4.0.0
jaraco.functools==4.1.0
javaproperties==0.8.2
Jinja2==3.1.6
jsonstreams==0.6.0
license-expression==30.4.1
lxml==5.4.0
MarkupSafe==3.0.2
more-itertools==10.7.0
normality==2.6.1
packageurl-python==0.16.0
packaging==25.0
packvers==21.5
parameter-expansion-patched==0.3.1
pdfminer.six==20250506
pefile==2024.8.26
pip-requirements-parser==32.0.1
pkginfo2==30.0.0
pluggy==1.6.0
plugincode==32.0.0
ply==3.11
publicsuffix2==2.20191221
pyahocorasick==2.1.0
pycparser==2.22
pygmars==0.9.0
Pygments==2.19.1
pymaven-patch==0.3.2
pyparsing==3.2.3
PyYAML==6.0.2
rdflib==7.1.4
requests==2.32.3
saneyaml==0.6.1
scancode-toolkit==32.3.3
semantic-version==2.10.0
six==1.17.0
soupsieve==2.7
spdx-tools==0.8.2
text-unidecode==1.3
toml==0.10.2
typecode==30.0.2
typecode-libmagic==5.39.210531
typing_extensions==4.13.2
uritools==5.0.0
urllib3==2.4.0
urlpy==0.5
wcwidth==0.2.13
webencodings==0.5.1
xmltodict==0.14.2
zipp==3.21.0

The problem

I tried to run extractcode on my project and got:

Extracting archives...
[--------------------] 0
Traceback (most recent call last):
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/bin/extractcode", line 8, in <module>
    sys.exit(extractcode())
             ~~~~~~~~~~~^^
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/click/core.py", line 1442, in __call__
    return self.main(*args, **kwargs)
           ~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/commoncode/cliutils.py", line 73, in main
    return click.Command.main(
           ~~~~~~~~~~~~~~~~~~^
        self,
        ^^^^^
    ...<4 lines>...
        **extra,
        ^^^^^^^^
    )
    ^
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/click/core.py", line 1363, in main
    rv = self.invoke(ctx)
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/click/core.py", line 1226, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/click/core.py", line 794, in invoke
    return callback(*args, **kwargs)
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/click/decorators.py", line 34, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/extractcode/cli.py", line 301, in extractcode
    for xev in extraction_events:
               ^^^^^^^^^^^^^^^^^
  File "/home/segfault/VSCode/Code/SPRING_25/SNA/Advanced-semi-formal-static-analyzer/INSPECTION/myenv/lib/python3.13/site-packages/commoncode/cliutils.py", line 180, in generator
    if self.is_hidden:
       ^^^^^^^^^^^^^^
AttributeError: 'EnhancedProgressBar' object has no attribute 'is_hidden'. Did you mean: 'hidden'?

Same thing occured on command scancode --license --copyright --package --json-pp </project/path>

What worked for me

I believe this bug is happened due to new version of EnhancedProgressBar. I fixed it by changing all occurencies of self.is_hidden to self.hidden

• What version of scancode-toolkit was used to generate the scan file?
• What installation method was used to install/run scancode? (pip/source download/other)

[armijnhemel]

This is indeed a change in click:

pallets/click@fcd8503

[pombredanne]

Indeed, this PR by @ bhuffman-usgs introduced the regression which was just released in Click 8.2.0

• Add functionality to hide the progress bar Issue #2609 pallets/click#2727
• progressbar(hide=True) option for hiding the progress bar pallets/click#2609

@CacucoH PR welcomed, eventually using tqdm would work too. See also these related issues:

• progress bar displays wrong results #3344
• display total number of files being scanned above progress bar #3342

[AyanSinhaMahapatra]

any pip install of scancode-toolkit is broken for this, we need a new release of scancode with either of these:

1. upper bound on click version on the short term (unlikely to get fixed later)
2. change all instances of is_hidden, new release of commoncode and scancode with a lower bound on click version click >= 8.2 like Fix using incorrect hidden property on ProgressBar instance commoncode#86
3. use something else for progressbar, new release of SCTK and commoncode

Click has been problematic like this before too: see #4044 and we also skip click v7.0 similarly

[piiq]

@AyanSinhaMahapatra I am fine with updating all is_hidden to use the new property and bumping the lower bound for support for click, but this would require a bigger change to the azure pipelines in the commoncode repo. The tests currently test a lot of earlier versions of click. That would be a bigger PR vs the one I have initially opened. Let me know if you want me to make one.

I could probably integrate tqdm to be used as a progressbar, but I am not that familiar with the logic of all the progressbars that are in the commoncode repo, so I didn't pursue this.

[AyanSinhaMahapatra]

I am fine with updating all is_hidden to use the new property and bumping the lower bound for support for click

@piiq a PR there is much welcomed, I can help you with any changes required there too.

The tests currently test a lot of earlier versions of click

Yes, these are supported versions from earlier (since it has been a bit problematic like this issue), since we will place a lower bound much higher, we don't need to test all the version anymore, but only the versions above that as they release. We also want to keep the test where we update all dependencies to the latest too.

I could probably integrate tqdm to be used as a progressbar

This is not required atm, just considering the options for future references :P

[rexhinvorpsi]

Hi,
Is there a timeframe on the new version or what to actually change, we are using scancode toolkit version v32.3.3 do we need to downgrade from this version

[AyanSinhaMahapatra]

@rexhinvorpsi yes we're looking to do a scancode-toolkit release with this fixed and a couple other changes by the end of next week.

Otherwise you can downgrade and pin the click version to https://github.com/pallets/click/releases/tag/8.1.7 in your lockfile or do a pip install --force-reinstall -v click==8.1.7 in your activated virtualenv with scancode which should also fix this issue.

[AyanSinhaMahapatra]

click does not support python3.9 anymore, see pallets/click#2975, in addition to this breaking change.

I am going ahead with putting an upper bound on click version on the short term as there are no other options to fix this in the short term, even though putting an upper bound is not ideal for usage as a library.
See aboutcode-org/commoncode#86 (comment) for more details, we would update to click >= 8.2.0 once python3.9 is EOL.

[piiq]

The PR to cap click at <8.2 on commoncode side is here aboutcode-org/commoncode#87