Stubmaker
Stubmaker is an easy-to-use tool for generating python stubs.
Requirements
- Stubmaker is to be run under Python 3.7.4+
- No side effects during module imports
- Must contain
__all__(this restriction will be removed in upcomming releases)
How to install
pip install stubmaker
stubmaker --help
Usage example
Imagine you have a package with the following structure:
package
-> __init__.py
Contents of __init__.py:
__all__ = ['sleep_for']
from time import sleep
def some_decorator(func):
return func
@some_decorator
def sleep_for(amount: float) -> None:
sleep(amount)
There is a script that calls sleep_for method but passes wrong arguments:
from package import sleep_for
sleep_for(123, 123)
Due to dynamic nature of decorators static analysers (such as mypy) may not raise an error while checking the script:
>> mypy __main__.py
Success: no issues found in 1 source file
Stubs exist to help you! Stubmaker will provide stubs for your package so that its users can find the error using mypy:
>> stubmaker --module-root package --src-root <path to package>/package --output-dir <path to package>/package
>> mypy __main__.py
__main__.py:3: error: Too many arguments for "sleep_for"
Found 1 error in 1 file (checked 1 source file)
License
© YANDEX LLC, 2020-2021. Licensed under the Apache License, Version 2.0. See LICENSE file for more details.
6 Jun 8, 2022
1 Dec 24, 2021
1 Dec 27, 2021
37 Nov 2, 2022
2 Mar 3, 2022
3 Aug 6, 2022
12 Jan 2, 2023
14 Oct 14, 2022
6 Dec 12, 2022
13 Nov 25, 2022
14 Aug 02, 2022
7 Nov 25, 2022
3 Feb 03, 2022
5 Sep 16, 2022
2 Oct 19, 2021
1 Dec 12, 2021
7 Aug 27, 2021
2 Oct 29, 2021
2 Sep 03, 2022
39 Dec 23, 2022
0 Sep 05, 2021
16 Jan 07, 2023
12 Sep 01, 2022
2.6k Jan 09, 2023
6 Nov 09, 2021
25 Nov 28, 2022
4 Oct 11, 2022