What is the type hint for a (any) python module?

by

and types.ModuleType() is a constructor.

That doesn’t matter. types.ModuleType is still a reference to a type, just like str and int are. There is no need for a generic Module[typehint] annotation, so types.ModuleType is exacly what you need to use here.

For example, the official Python typeshed project provides a type hint annotation for sys.modules as:

from types import FrameType, ModuleType, TracebackType

# ...

modules: Dict[str, ModuleType]

Don’t be confused by the name here; types.ModuleType is a reference to the module type. It is not a separate factory function or something. The CamelCase name follows the convention of that module, and you use that reference because the type object is not otherwise available as a built-in. The types module assigns the value of type(sys) to the name.

If PyCharm is having issues with finding the types.ModuleType stubs, then that’s either a problem with PyCharm itself (a bug), or the stubs currently bundled are outdated, or you used an incomplete typeshed set of stubs. See the PyCharm documentation on how to use custom stubs to provide a fresh set.

If that doesn’t work, it may be a bug in PyCharm dealing with the concept of exporting type hints. Typeshed currently defines the ModuleType type hints in a separate module, which are then imported into the types.pyi stubfile using the from module import name as name syntax. PEP 484 states that imported type hints are not part of the stub unless you use the as syntax:

Modules and variables imported into the stub are not considered exported from the stub unless the import uses the import ... as ... form or the equivalent from ... import ... as ... form.

It may be that PyCharm doesn’t yet correctly handle such cases.

More Related Contents:

  1. How do I type hint a method with the type of the enclosing class?
  2. What are variable annotations?
  3. How to specify multiple return types using type-hints
  4. How can I specify the function type in my type hints?
  5. Type hinting a collection of a specified type
  6. What are type hints in Python 3.5?
  7. Using the class as a type hint for arguments in its methods [duplicate]
  8. Type hint for a function that returns only a specific set of values
  9. How to use type hints in python 3.6?
  10. How to specify “nullable” return type with type hints
  11. How can I tell PyCharm what type a parameter is expected to be?
  12. How should I use the Optional type hint?
  13. Type hints when unpacking a tuple?
  14. Exclude type in Python typing annotation
  15. Can you annotate return type when value is instance of cls?
  16. Python type hinting with exceptions
  17. Type hinting / annotation (PEP 484) for numpy.ndarray
  18. Can I omit Optional if I set default to None?
  19. How do I annotate types in a for-loop?
  20. Name not defined in type annotation [duplicate]
  21. Python 3.5 type hinting does not result in an error
  22. Type annotations for Enum attribute
  23. How to annotate function that takes a tuple of variable length? (variadic tuple type annotation)
  24. Recursive Typing in Python 3.5+ [duplicate]
  25. How to type hint a dictionary with values of different types
  26. Python 3.7 anaconda environment – import _ssl DLL load fail error
  27. typing: Dynamically Create Literal Alias from List of Valid Values
  28. Basemap import error in PyCharm — KeyError: ‘PROJ_LIB’
  29. mypy, type hint: Union[float, int] -> is there a Number type?
  30. Type hints in namedtuple

Leave a Comment