Summary

Here’s a short summary of the features of this proposal in contrast to current conventions:

• Editingwould be already fully supported by default by any editor (current or future) supporting Python syntax, including syntax errors, syntax highlighting, etc.
• Renderingwould be relatively straightforward to implement by static tools (tools that don’t need runtime execution), as the information can be extracted from the AST they normally already create.
• Deduplication of information: the name of a parameter would be defined in a single place, not duplicated inside of a docstring.
• Elimination of the possibility of having inconsistencies when removing a parameter or class variable and forgetting to remove its documentation.
• Minimization of the probability of adding a new parameter or class variable and forgetting to add its documentation.
• Elimination of the possibility of having inconsistencies between the name of a parameter in the signature and the name in the docstring when it is renamed.
• Access to the documentation string for each symbol at runtime, including existing (older) Python versions.
• A more formalized way to document other symbols, like type aliases, that could useAnnotated.
• No microsyntax to learn for newcomers, it’s just Python syntax.
• Parameter documentation inheritance for functions captured byParamSpec.

Examples

Class attributes may be documented:

fromtypingimportAnnotated,Doc

classUser:
name:Annotated[str,Doc("The user's name")]
age:Annotated[int,Doc("The user's age")]

...

As can function or method parameters and return values:

fromtypingimportAnnotated,Doc

defcreate_user(
name:Annotated[str,Doc("The user's name")],
age:Annotated[int,Doc("The user's age")],
cursor:DatabaseConnection|None=None,
)->Annotated[User,Doc("The created user after saving in the database")]:
"""Create a new user in the system.

It needs the database connection to be already initialized.
"""
pass

Java

Java functions and their parameters are documented with Javadoc, a special format for comments put on top of the function definition. This would be similar to Python current docstring microsyntax conventions (but only one).

For example:

/**
* Returns an Image object that can then be painted on the screen.
* The url argument must specify an absolute <a href= "#{@link}" >{@link URL}</a>. The name
* argument is a specifier that is relative to the url argument.
* <p>
* This method always returns immediately, whether or not the
* image exists. When this applet attempts to draw the image on
* the screen, the data will be loaded. The graphics primitives
* that draw the image will incrementally paint on the screen.
*
* @param url an absolute URL giving the base location of the image
* @param name the location of the image, relative to the url argument
* @return the image at the specified URL
* @see Image
*/
publicImagegetImage(URLurl,Stringname){
try{
returngetImage(newURL(url,name));
}catch(MalformedURLExceptione){
returnnull;
}
}

JavaScript

Both JavaScript and TypeScript use a similar system to Javadoc.

JavaScript usesJSDoc.

For example:

/**
* Represents a book.
* @constructor
* @param {string} title - The title of the book.
* @param {string} author - The author of the book.
*/
functionBook(title,author){
}

TypeScript

TypeScript has its own JSDoc reference with some variations.

For example:

// Parameters may be declared in a variety of syntactic forms
/**
* @param {string} p1 - A string param.
* @param {string=} p2 - An optional param (Google Closure syntax)
* @param {string} [p3] - Another optional param (JSDoc syntax).
* @param {string} [p4= "test" ] - An optional param with a default value
* @returns {string} This is the result
*/
functionstringsStringStrings(p1,p2,p3,p4){
// TODO
}

Rust

Rust uses another similar variation of a microsyntax in Doc comments.

But it doesn’t have a particular well defined microsyntax structure to denote what documentation refers to what symbol/parameter other than what can be inferred from the pure Markdown.

For example:

#![crate_name ="doc"]

/// A human being is represented here
pubstructPerson{
/// A person must have a name, no matter how much Juliet may hate it
name:String,
}

implPerson{
/// Returns a person with the name given them
///
/// # Arguments
///
/// * `name` - A string slice that holds the name of the person
///
/// # Examples
///
/// ```
/// // You can have rust code between fences inside the comments
/// // If you pass --test to `rustdoc`, it will even test it for you!
/// use doc::Person;
/// let person = Person::new( "name" );
/// ```
pubfnnew(name:&str)->Person{
Person{
name:name.to_string(),
}
}

/// Gives a friendly hello!
///
/// Says "Hello, [name](Person::name)" to the `Person` it is called on.
pubfnhello(&self){
println!("Hello, {}!",self.name);
}
}

fnmain(){
letjohn=Person::new("John");

john.hello();
}

Go Lang

Go also uses a form ofDoc Comments.

It doesn’t have a well defined microsyntax structure to denote what documentation refers to which symbol/parameter, but parameters can be referenced by name without any special syntax or marker, this also means that ordinary words that could appear in the documentation text should be avoided as parameter names.

packagestrconv

// Quote returns a double-quoted Go string literal representing s.
// The returned string uses Go escape sequences (\t, \n, \xFF, \u0100)
// for control characters and non-printable characters as defined by IsPrint.
funcQuote(sstring)string{
...
}

Standardize Current Docstrings

A possible alternative would be to support and try to push as a standard one of the existing docstring formats. But that would only solve the standardization.

It wouldn’t solve any of the other problems derived from using a microsyntax inside of a docstring instead of pure Python syntax, the same as described above in theRationale - Summary.

Extra Metadata and Decorator

Some ideas before this proposal included having a functiondoc()instead of the single classDocwith several parameters to indicate whether an object is discouraged from use, what exceptions it may raise, etc. To allow also deprecating functions and classes, it was also expected thatdoc()could be used as a decorator. But this functionality is covered bytyping.deprecated()inPEP 702,so it was dropped from this proposal.

A way to declare additional information could still be useful in the future, but taking early feedback on this idea, all that was postponed to future proposals.

This also shifted the focus from an all-encompassing functiondoc() with multiple parameters to a singleDocclass to be used in Annotatedin a way that could be composed with other future proposals.

This design change also allows better interoperability with other proposals liketyping.deprecated(),as in the future it could be considered to allow havingtyping.deprecated()also inAnnotatedto deprecate individual parameters, coexisting withDoc.

String Under Definition

A proposed alternative in the discussion is declaring a string under the definition of a symbol and providing runtime access to those values:

classUser:
name:str
"The user's name"
age:int
"The user's age"

...

This was already proposed and rejected inPEP 224,mainly due to the ambiguity of how is the string connected with the symbol it’s documenting.

Additionally, there would be no way to provide runtime access to this value in previous versions of Python.

Plain String in Annotated

In the discussion, it was also suggested to use a plain string inside of Annotated:

fromtypingimportAnnotated

classUser:
name:Annotated[str,"The user's name"]
age:Annotated[int,"The user's age"]

...

But this would create a predefined meaning for any plain string inside of Annotated,and any tool that was using plain strings in them for any other purpose, which is currently allowed, would now be invalid.

Having an explicittyping.Docmakes it compatible with current valid uses of Annotated.

Another Annotated-Like Type

In the discussion it was suggested to define a new type similar to Annotated,it would take the type and a parameter with the documentation string:

fromtypingimportDoc

classUser:
name:Doc[str,"The user's name"]
age:Doc[int,"The user's age"]

...

This idea was rejected as it would only support that use case and would make it more difficult to combine it withAnnotatedfor other purposes ( e.g. with FastAPI metadata, Pydantic fields, etc.) or adding additional metadata apart from the documentation string (e.g. deprecation).

Transferring Documentation from Type aliases

A previous version of this proposal specified that when type aliases declared with Annotatedwere used, and these type aliases were used in annotations, the documentation string would be transferred to the annotated symbol.

For example:

fromtypingimportAnnotated,Doc,TypeAlias


UserName:TypeAlias=Annotated[str,Doc("The user's name")]


defcreate_user(name:UserName):...

defdelete_user(name:UserName):...

This was rejected after receiving feedback from the maintainer of one of the main components used to provide editor support.

Shorthand with Slices

In the discussion, it was suggested to use a shorthand with slices:

is_approved:Annotated[str:"The status of a PEP."]

Although this is a very clever idea and would remove the need for a newDocclass, runtime executing of current versions of Python don’t allow it.

At runtime,Annotatedrequires at least two arguments, and it requires the first argument to be type, it crashes if it is a slice.

Verbosity

The main argument against this would be the increased verbosity.

If the signature was not viewed independently of the documentation and the body of the function with the docstring was also measured, the total verbosity would be somewhat similar, as what this proposal does is to move some of the contents from the docstring in the body to the signature.

Considering the signature alone, without the body, they could be much longer than they currently are, they could end up being more than one page long. In exchange, the equivalent docstrings that currently are more than one page long would be much shorter.

When comparing the total verbosity, including the signature and the docstring, the main additional verbosity added by this would be from using Annotatedandtyping.Doc.IfAnnotated had more usage, it could make sense to have an improved shorter syntax for it and for the type of metadata it would carry. But that would only make sense once Annotatedis more widely used.

On the other hand, this verbosity would not affect end users as they would not see the internal code usingtyping.Doc.The majority of users would interact with libraries through editors without looking at the internals, and if anything, they would have tooltips from editors supporting this proposal.

The cost of dealing with the additional verbosity would mainly be carried by those library maintainers that use this feature.

This argument could be analogous to the argument against type annotations in general, as they do indeed increase verbosity, in exchange for their features. But again, as with type annotations, this would be optional and only to be used by those that are willing to take the extra verbosity in exchange for the benefits.

Of course, more advanced users might want to look at the source code of the libraries and if the authors of those libraries adopted this, those advanced users would end up having to look at that code with additional signature verbosity instead of docstring verbosity.

Any authors that decide not to adopt it should be free to continue using docstrings with any particular format they decide, no docstrings at all, etc.

Still, there’s a high chance that library authors could receive pressure to adopt this if it became the blessed solution.

Documentation is not Typing

It could also be argued that documentation is not really part of typing, or that it should live in a different module. Or that this information should not be part of the signature but live in another place (like the docstring).

Nevertheless, type annotations in Python could already be considered, by default, additional metadata: they carry additional information about variables, parameters, return types, and by default they don’t have any runtime behavior. And this proposal would add one more type of metadata to them.

It could be argued that this proposal extends the type of information that type annotations carry, the same way asPEP 702extends them to include deprecation information.

Annotatedwas added to the standard library precisely to support adding additional metadata to the annotations, and as the new proposed Docclass is tightly coupled toAnnotated,it makes sense for it to live in the same module. IfAnnotatedwas moved to another module, it would make sense to moveDocwith it.

Multiple Standards

Another argument against this would be that it would create another standard, and that there are already several conventions for docstrings. It could seem better to formalize one of the currently existing standards.

Nevertheless, as stated above, none of those conventions cover the general drawbacks of a doctsring-based approach that this proposal solves naturally.

To see a list of the drawbacks of a docstring-based approach, see the section above in theRationale - Summary.

In the same way, it can be seen that, in many cases, a new standard that takes advantage of new features and solves several problems from previous methods can be worth having. As is the case with the newpyproject.toml, dataclass_transform,the new typing pipe/union (|) operator, and other cases.

Adoption

As this is a new standard proposal, it would only make sense if it had interest from the community.

Fortunately there’s already interest from several mainstream libraries from several developers and teams, including FastAPI, Typer, SQLModel, Asyncer (from the author of this proposal), Pydantic, Strawberry (GraphQL), and others.

There’s also interest and support from documentation tools, like mkdocstrings,which added support even for an earlier version of this proposal.

All the CPython core developers contacted for early feedback (at least 4) have shown interest and support for this proposal.

Editor developers (VS Code and PyCharm) have shown some interest, while showing concerns about the signature verbosity of the proposal, although not about the implementation (which is what would affect them the most). And they have shown they would consider adding support for this if it were to become an official standard. In that case, they would only need to add support for rendering, as support for editing, which is normally non-existing for other standards, is already there, as they already support editing standard Python syntax.