Abstract

This PEP introduces a syntax for adding arbitrary metadata annotations to Python functions [1].

Rationale

Because Python’s 2.x series lacks a standard way of annotating a function’s parameters and return values, a variety of tools and libraries have appeared to fill this gap. Some utilise the decorators introduced in PEP 318, while others parse a function’s docstring, looking for annotations there.

This PEP aims to provide a single, standard way of specifying this information, reducing the confusion caused by the wide variation in mechanism and syntax that has existed until this point.

Fundamentals of Function Annotations

Before launching into a discussion of the precise ins and outs of Python 3.0’s function annotations, let’s first talk broadly about what annotations are and are not:

1. Function annotations, both for parameters and return values, are completely optional.
2. Function annotations are nothing more than a way of associating arbitrary Python expressions with various parts of a function at compile-time.

   By itself, Python does not attach any particular meaning or significance to annotations. Left to its own, Python simply makes these expressions available as described in Accessing Function Annotations below.

   The only way that annotations take on meaning is when they are interpreted by third-party libraries. These annotation consumers can do anything they want with a function’s annotations. For example, one library might use string-based annotations to provide improved help messages, like so:

   def compile(source: "something compilable",
               filename: "where the compilable thing comes from",
               mode: "is this a single statement or a suite?"):
       ...
   

   Another library might be used to provide typechecking for Python functions and methods. This library could use annotations to indicate the function’s expected input and return types, possibly something like:

   def haul(item: Haulable, *vargs: PackAnimal) -> Distance:
       ...
   

   However, neither the strings in the first example nor the type information in the second example have any meaning on their own; meaning comes from third-party libraries alone.

3. Following from point 2, this PEP makes no attempt to introduce any kind of standard semantics, even for the built-in types. This work will be left to third-party libraries.

Syntax

def foo(a: expression, b: expression = 5):
    ...

def foo(*args: expression, **kwargs: expression):
    ...

def foo((x1, y1: expression),
        (x2: expression, y2: expression)=(None, None)):
    ...

def sum() -> expression:
    ...

decorator: '@' dotted_name [ '(' [arglist] ')' ] NEWLINE
decorators: decorator+
funcdef: [decorators] 'def' NAME parameters ['->' test] ':' suite
parameters: '(' [typedargslist] ')'
typedargslist: ((tfpdef ['=' test] ',')*
                ('*' [tname] (',' tname ['=' test])* [',' '**' tname]
                 | '**' tname)
                | tfpdef ['=' test] (',' tfpdef ['=' test])* [','])
tname: NAME [':' test]
tfpdef: tname | '(' tfplist ')'
tfplist: tfpdef (',' tfpdef)* [',']

Accessing Function Annotations

Once compiled, a function’s annotations are available via the function’s __annotations__ attribute. This attribute is a mutable dictionary, mapping parameter names to an object representing the evaluated annotation expression

There is a special key in the __annotations__ mapping, "return". This key is present only if an annotation was supplied for the function’s return value.

For example, the following annotation:

def foo(a: 'x', b: 5 + 6, c: list) -> max(2, 9):
    ...

would result in an __annotations__ mapping of

{'a': 'x',
 'b': 11,
 'c': list,
 'return': 9}

The return key was chosen because it cannot conflict with the name of a parameter; any attempt to use return as a parameter name would result in a SyntaxError.

__annotations__ is an empty, mutable dictionary if there are no annotations on the function or if the functions was created from a lambda expression.

Use Cases

In the course of discussing annotations, a number of use-cases have been raised. Some of these are presented here, grouped by what kind of information they convey. Also included are examples of existing products and packages that could make use of annotations.

• Providing typing information
  • Type checking ([3], [4])
  • Let IDEs show what types a function expects and returns ([16])
  • Function overloading / generic functions ([21])
  • Foreign-language bridges ([17], [18])
  • Adaptation ([20], [19])
  • Predicate logic functions
  • Database query mapping
  • RPC parameter marshaling ([22])
• Other information
  • Documentation for parameters and return values ([23])

Standard Library

Relation to Other PEPs

Implementation

A reference implementation has been checked into the py3k (formerly “p3yk”) branch as revision 53170 [10].

Rejected Proposals

• The BDFL rejected the author’s idea for a special syntax for adding annotations to generators as being “too ugly” [2].
• Though discussed early on ([5], [6]), including special objects in the stdlib for annotating generator functions and higher-order functions was ultimately rejected as being more appropriate for third-party libraries; including them in the standard library raised too many thorny issues.
• Despite considerable discussion about a standard type parameterisation syntax, it was decided that this should also be left to third-party libraries. ([7], [8], [9]).
• Despite yet more discussion, it was decided not to standardize a mechanism for annotation interoperability. Standardizing interoperability conventions at this point would be premature. We would rather let these conventions develop organically, based on real-world usage and necessity, than try to force all users into some contrived scheme. ([13], [14], [15]).

References and Footnotes

[1]

Unless specifically stated, “function” is generally used as a synonym for “callable” throughout this document.

[2]

https://mail.python.org/pipermail/python-3000/2006-May/002103.html

[3]

http://web.archive.org/web/20070730120117/http://oakwinter.com/code/typecheck/

[4]

http://web.archive.org/web/20070603221429/http://maxrepo.info/

[5]

https://mail.python.org/pipermail/python-3000/2006-May/002091.html

[6]

https://mail.python.org/pipermail/python-3000/2006-May/001972.html

[7]

https://mail.python.org/pipermail/python-3000/2006-May/002105.html

[8]

https://mail.python.org/pipermail/python-3000/2006-May/002209.html

[9]

https://mail.python.org/pipermail/python-3000/2006-June/002438.html

[10]

http://svn.python.org/view?rev=53170&view=rev

[11]

http://docs.python.org/reference/compound_stmts.html#function-definitions

[12]

https://mail.python.org/pipermail/python-3000/2006-May/001613.html

[13]

https://mail.python.org/pipermail/python-3000/2006-August/002895.html

[14]

https://mail.python.org/pipermail/python-ideas/2007-January/000032.html

[15]

https://mail.python.org/pipermail/python-list/2006-December/420645.html

[16]

http://www.python.org/idle/doc/idle2.html#Tips

[17]

http://www.jython.org/Project/index.html

[18]

http://www.codeplex.com/Wiki/View.aspx?ProjectName=IronPython

[19]

http://peak.telecommunity.com/PyProtocols.html

[20]

http://www.artima.com/weblogs/viewpost.jsp?thread=155123

[21]

http://www-128.ibm.com/developerworks/library/l-cppeak2/

[22]

http://rpyc.wikispaces.com/

[23]

http://docs.python.org/library/pydoc.html

Copyright

This document has been placed in the public domain.