ImportError: cannot import name 'get_terminal_size' from 'click.termui'

[jmhummel]

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

import typer

Description

• Install latest versions of typer (0.4.0) and click (8.1.0)
• Run script with single line import typer
• Import fails due to method get_terminal_size having been removed in click 8.1.0 (remove deprecated code pallets/click#2130)

Traceback (most recent call last):
  File "test.py", line 1, in <module>
    import typer
  File "/.venv/lib/python3.8/site-packages/typer/__init__.py", line 12, in <module>
    from click.termui import get_terminal_size as get_terminal_size
ImportError: cannot import name 'get_terminal_size' from 'click.termui' (/.venv/lib/python3.8/site-packages/click/termui.py)

Operating System

Linux

Operating System Details

Ubunutu 20.04

Typer Version

0.4.0

Python Version

Python 3.8.10

Additional Context

No response

[browniebroke]

I think that'll be fixed in #375

[DimIsaev]

confirm the problem
appeared on import

import spacy

[fkoehlin]

Same here, also running into this exception with import spacy for spacy version 3.2.3. Reverting to spacy version 3.1.3 "solves" the problem for now.

CORRECTION:
It wasn't the spacy version... It's click (direct dependency from typer).
In both projects I have typer version 0.4.0 installed, the one which installed the newer click version 8.1.0 (and spacy 3.2.3) doesn't work, the older one (spacy 3.1.3) which installed click version 8.0.4 works.

tl;dr: Check your click version and force it <8.1.0.

[drorata]

Same issue also with the minimal example from the docs on a clean Conda environment with Python 3.9.11. Actually, the error is raised when merely running import typer in the Python console:

➜ python
Python 3.9.11 (main, Mar 28 2022, 05:06:49)
[Clang 12.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import typer
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/drorata/anaconda3/envs/foo/lib/python3.9/site-packages/typer/__init__.py", line 12, in <module>
    from click.termui import get_terminal_size as get_terminal_size
ImportError: cannot import name 'get_terminal_size' from 'click.termui' (/Users/drorata/anaconda3/envs/foo/lib/python3.9/site-packages/click/termui.py)

[Achuttarsing]

Exactly the same error for me with Python 3.7.13 :

Python 3.7.13 (default, Mar 18 2022, 17:46:12) 
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import typer
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/var/www/ai/env/lib/python3.7/site-packages/typer/__init__.py", line 12, in <module>
    from click.termui import get_terminal_size as get_terminal_size
ImportError: cannot import name 'get_terminal_size' from 'click.termui' (/var/www/ai/env/lib/python3.7/site-packages/click/termui.py)

[drorata]

After downgrading Typer to 0.3.2 the problem is gone.

[DimIsaev]

After downgrading Click to 0.4.1 the problem is gone.

[Achuttarsing]

This temporary solution : explosion/spaCy#10564 (comment) works for me → pip install click==8.0.4

[KritsanaMike]

This temporary solution : explosion/spaCy#10564 (comment) works for me → pip install click==8.0.4

That correct !! I just fix the same your way. I downgrade click from 8.1.0 to 8.0.4 It's working now.

[jofegan]

I am seeing the same on a dependabot PR proposing to update the click version to 8.1
All my "import typer" statements fail with this error:

.tox/py3/lib/python3.8/site-packages/typer/__init__.py:12: in <module>
    from click.termui import get_terminal_size as get_terminal_size
E   ImportError: cannot import name 'get_terminal_size' from 'click.termui' (/home/feganj/wip/.tox/py3/lib/python3.8/

[caetanovidal]

This temporary solution : explosion/spaCy#10564 (comment) works for me → pip install click==8.0.4

Thanks, I uninstall click and install again with 8.0.4 and works

[michael-wise]

Apologies to add to noise. Reinforcing @drorata's comment that upgrading Typer to 0.4.1 resolved the issue and managed not to break any other dependencies in my gcp + pandas data pipeline.

[github-actions]

Assuming the original issue was solved, it will be automatically closed now. But feel free to add more comments or create new issues.

[RileyMShea]

Bot closed this but it appears to be unresolved.

[LeXofLeviafan]

Here's the definition of the missing function at the time of removal:

def get_terminal_size() -> os.terminal_size:
    """Returns the current size of the terminal as tuple in the form
    ``(width, height)`` in columns and rows.

    .. deprecated:: 8.0
        Will be removed in Click 8.1. Use
        :func:`shutil.get_terminal_size` instead.
    """
    import shutil
    import warnings

    warnings.warn(
        "'click.get_terminal_size()' is deprecated and will be removed"
        " in Click 8.1. Use 'shutil.get_terminal_size()' instead.",
        DeprecationWarning,
        stacklevel=2,
    )
    return shutil.get_terminal_size()

I believe it should be trivial to fix this particular issue (and it wouldn't even break compatibility with click-8.0).

[LeXofLeviafan]

…Waitaminute

According to release notes, this was fixed back in v0.4.1 over a year ago.