ПостТианголо (создатель FastAPI) предложил новый PEP 727, который позволяет стандартизировать механизм документирования пара…

Тианголо (создатель FastAPI) предложил новый PEP 727, который позволяет стандартизировать механизм документирования параметров. Причина проста - существует много псевдо-стандартов по форматированию параметров в docstring (например свои стандарты есть у numpy, гугла, много их!), но не все редакторы/IDE имеют возможность поддерживать эти "микроязыки". Он предлагает стандартизировать подход, используя существующий мощный инструмент в виде аннотаций типов. Основное предложение - добавление в typing новой функции doc, которая принимает единственный параметр documentation. Ожидается, что эта функция будет использоваться вместе с Annotated. А вот как это будет выглядеть: def create_user( lastname: Annotated[str, doc("The **last name** of the newly created user")], firstname: Annotated[str | None, doc("The user's **first name**")] = 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 Тианголо заранее позаботился и о старых версиях - он не стал выдумывать новый синтаксис, так же предлагается добавить doc() в пакет typing_extensions, который используют старые версии питона для исключения проблем с совместимостью. Выглядит интересно, но важно понимать - автор пытается создать ещё один стандарт. Поддержит ли его комьюнити и уйдет ли PEP в работу? Остается только гадать. #pep