34

I have recently started using PEP 484 and PEP 586 to make my code clearer and more accessible. So far everything was ok, but when I wanted to use Literal from the package typing it appears it couldn't be imported. What is the most surprising is that PyCharm isn't complaining at all for importing it or using it.

The code I want to use in the end is looking like that :

SomeVar = TypeVar("SomeVar", Literal['choice1'], Literal['choice2'], someType)

It would be used in the cases where you can have a string to describe what you want or an already made solution e.g :

def someFunc(my_var: SomeVar = 'choice1'):
    result = []
    if my_var == 'choice1':
        result.append(...)
    else:
        result = my_var
    return result

I use an Anaconda environment with Python 3.7.7.

jonrsharpe
  • 115,751
  • 26
  • 228
  • 437
Kim Vallée
  • 365
  • 1
  • 4
  • 7

2 Answers2

39

Using Literal in Python 3.8 and later

from typing import Literal

Using Literal in all Python versions (1)

Literal was added to typing.py in 3.8, but you can use Literal in older versions anyway.

First install typing_extensions (pip install typing_extensions) and then

from typing_extensions import Literal

This approach is supposed to work also in Python 3.8 and later.

Using Literal in all Python versions (2)

For completeness, I'm also adding the try-except approach to import Literal:

try:
    from typing import Literal
except ImportError:
    from typing_extensions import Literal

This should also work for all Python versions, given that typing_extensions is installed if you're using Python 3.7 or older.

KenHBS
  • 6,756
  • 6
  • 37
  • 52
28

As stated in the docs, typing.Literal is only available from Python 3.8 and up.

jmd_dk
  • 12,125
  • 9
  • 63
  • 94
  • 3
    Thanks ! What alternative do you advise then ? – Kim Vallée Apr 14 '20 at 11:27
  • Anaconda still does not ship with Python 3.8, but you can update it to 3.8 once installed. See e.g. [this Stack Overflow question](https://stackoverflow.com/questions/58568175/upgrade-to-python-3-8-using-conda) – jmd_dk Apr 14 '20 at 11:30
  • Alternatively (if you don't want to update your Python version), you can use the `Literal` type from the [typing-extensions](https://pypi.org/project/typing-extensions/) package. – Dan Oneață Jan 18 '21 at 08:06