Using the class as a type hint for arguments in its methods [duplicate]

by

Because when it encounters Translate (while compiling the class body), Vector2 hasn’t been defined yet (it is currently compiling, name binding hasn’t been performed); Python naturally complains.

Since this is such a common scenario (type-hinting a class in the body of that class), you should use a forward reference to it by enclosing it in quotes:

class Vector2:    
    # __init__ as defined

    def Translate(self, pos: 'Vector2'):    
        self.x += pos.x
        self.y += pos.y

Python (and any checkers complying to PEP 484) will understand your hint and register it appropriately. Python does recognize this when __annotations__ are accessed through typing.get_type_hints:

from typing import get_type_hints

get_type_hints(Vector2(1,2).Translate)
{'pos': __main__.Vector2}

This has been changed as of Python 3.7; see abarnert’s answer below.

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. Type hint for a function that returns only a specific set of values
  8. How to use type hints in python 3.6?
  9. How to specify “nullable” return type with type hints
  10. How should I use the Optional type hint?
  11. Type hints when unpacking a tuple?
  12. Exclude type in Python typing annotation
  13. Can you annotate return type when value is instance of cls?
  14. Python type hinting with exceptions
  15. Type hinting / annotation (PEP 484) for numpy.ndarray
  16. Can I omit Optional if I set default to None?
  17. Name not defined in type annotation [duplicate]
  18. Python 3.5 type hinting does not result in an error
  19. Type annotations for Enum attribute
  20. How to annotate function that takes a tuple of variable length? (variadic tuple type annotation)
  21. Recursive Typing in Python 3.5+ [duplicate]
  22. Type Hinting for objects of type that’s being defined [duplicate]
  23. What is the type hint for a (any) python module?
  24. Type hints: solve circular dependency [duplicate]
  25. Python type hinting without cyclic imports
  26. Specify length of Sequence or List with Python typing module
  27. A way to subclass NamedTuple for purposes of typechecking
  28. How to annotate types of multiple return values?
  29. Type hints in namedtuple
  30. Which of the 4 ways to call super() in Python 3 to use?

Leave a Comment