The PyCharm team would like to propose a way for specifying and sharing API 
definitions of third-party libraries.

As there is not enough information in API definition code of Python libraries, 
developers of static analysis tools collect extended API data themselves and 
store it in their own formats. The absence of a common extended API information 
format makes it hard for developers and users of tools to collect and share 
data.

Our proposal is to create a common database of static API definitions with type 
hints as a collection of Python files called skeletons. Static analysis tools 
already understand Python code, so it should be easy to start extracting API 
definitions from these Python skeleton files. Regular function and class 
definitions can be extended with additional information, e.g. for providing 
types of function parameters and return values. Please read the details in the 
python-skeletons repository on GitHub: 
https://github.com/JetBrains/python-skeletons

Your comments and suggestions are welcome. We would like to collaborate on this 
initiative.

-- 
Andrey Vlasovskikh
Senior Software Developer
JetBrains
http://www.jetbrains.com/
"Develop with pleasure!"
_______________________________________________
code-quality mailing list
code-quality@python.org
https://mail.python.org/mailman/listinfo/code-quality

Reply via email to