Stubmaker is an easy-to-use tool for generating python stubs.

Last update: Aug 28, 2022

Related tags

General Utilities stubmaker

Overview

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

A utility that makes it easy to work with Python projects containing lots of packages, of which you only want to develop some.

Mixed development source packages on top of stable constraints using pip mxdev [mɪks dɛv] is a utility that makes it easy to work with Python projects

6 Jun 8, 2022

🍰 ConnectMP - An easy and efficient way to share data between Processes in Python.

ConnectMP - Taking Multi-Process Data Sharing to the moon 🚀 Contribute · Community · Documentation 🎫 Introduction : 🍤 ConnectMP is the easiest and

1 Dec 24, 2021

Local backup made easy, with Python and shutil

KTBackup BETA Local backup made easy, with Python and shutil Features One-command backup and restore Minimalistic (only using stdlib) Convenient direc

1 Dec 27, 2021

Easy compression and extraction for any compression or archival format.

Tzar: Tar, Zip, Anything Really Easy compression and extraction for any compression or archival format. Usage/Examples tzar compress large-dir compres

37 Nov 2, 2022

Search, generate & deliver Msfvenom payloads in an quick and easy way

Goal Search, generate & deliver payloads in an quick and easy way Be as simple as possible BUT with all msfvenom payloads. Ever lost time searching th

2 Mar 3, 2022

Application for easy configuration of swap file and swappiness priority in slackware and others linux distributions.

Swap File Program created with the objective of assisting in the configuration of swap file in Distributions such as Slackware. Required packages: pyt

3 Aug 6, 2022

Regression Metrics Calculation Made easy

Regression Metrics Mean Absolute Error Mean Square Error Root Mean Square Error Root Mean Square Logarithmic Error Root Mean Square Logarithmic Error

12 Jan 2, 2023

Helpful functions for use alongside the rich Python library.

🔧 Rich Tools A python package with helpful functions for use alongside with the rich python library. 󠀠󠀠 The current features are: Convert a Pandas

14 Oct 14, 2022

A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use that mirror

Kali Mirror Finder Using Single Python File A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use tha

6 Dec 12, 2022

Comments

Render some magic methods for classes

Render magic methods if the signature of the method differs significantly from the parent method. Also made logic for metaclass rendering more correct.

opened by alexdrydew 0
Aliases support
Added support for objects' module and qualname aliases.

Examples when this feature is required:

pandas.DataFrame.__module__ is pandas.core.frame. It is possible to import DataFrame from pandas.core.frame instead of pandas but undesired

types.ModuleType.__module__ is builtins and types.ModuleType.__qualname__ is module. Attempt to import module from builtins leads to ImportError.

The feature is implemented by passing a python module path as an argument. This module should define DESCRIBED_OBJECTS dictionary at the top level, which is a mapping from python objects to tuples consisting of module name and qualname for the described object.
enhancement
opened by alexdrydew 0

Releases(v0.0.3)

v0.0.3(Jul 5, 2022)
Stub generation for metaclasses support.

Added described_objects option for stub generation which enables support for objects with predefined module name and qualname. This is required for correct stub generation in cases when object has a wrong __module__ (e.g., contextvars.ContextVar has __module__ builtins but in reality must be imported from contextvars) or can't be accessed by qualname directly (e.g., ModuleType which __qualname__ has "module" value).

Source code(tar.gz)
Source code(zip)
v0.0.2(Oct 7, 2021)
TypeVar support

Renamed AST to RepresenationsTree

Better module dependencies resolving

Wrong namespaces in functions arguments default values bug fixed

Source code(tar.gz)
Source code(zip)
v0.0.1(Aug 24, 2021)

First release!
Source code(tar.gz)
Source code(zip)

Owner

Toloka

Data labeling platform for ML

GitHub Repository

✨ Voici un code en Python par moi, et en français qui permet de générer du texte Lorem.

Lorem Gen ❗ Voici un code en Python par moi, et en français qui permet de générer du texte Lorem. Dépendences : pip install lorem_text 💖 Enjoy 🎫 Mon

3 Jun 07, 2021

one_click_kag_server is a program which tries to fully automate the creation of a King Arthur's Gold server.

4 Jan 05, 2022

Extract the download URL from OneDrive or SharePoint share link and push it to aria2

OneDriveShareLinkPushAria2 Extract the download URL from OneDrive or SharePoint share link and push it to aria2 从OneDrive或SharePoint共享链接提取下载URL并将其推送到a

262 Jan 08, 2023

A primitive Python wrapper around the Gromacs tools.

README: GromacsWrapper A primitive Python wrapper around the Gromacs tools. The library is tested with GROMACS 4.6.5, 2018.x, 2019.x, 2020.x, and 2021

140 Dec 28, 2022

This is discord nitro code generator and checker made with python. This will generate nitro codes and checks if the code is valid or not. If code is valid then it will print the code leaving 2 lines and if not then it will print '*'.

Discord Nitro Generator And Checker ⚙️ Rᴜɴ Oɴ Rᴇᴘʟɪᴛ 🛠️ Lᴀɴɢᴜᴀɢᴇs Aɴᴅ Tᴏᴏʟs If you are taking code from this repository without a fork, then atleast

37 Jan 07, 2023

Stubmaker is an easy-to-use tool for generating python stubs.

Related tags

Overview

Stubmaker

Requirements

How to install

Usage example

License

You might also like...

A utility that makes it easy to work with Python projects containing lots of packages, of which you only want to develop some.

🍰 ConnectMP - An easy and efficient way to share data between Processes in Python.

Local backup made easy, with Python and shutil

Easy compression and extraction for any compression or archival format.

Search, generate & deliver Msfvenom payloads in an quick and easy way

Application for easy configuration of swap file and swappiness priority in slackware and others linux distributions.

Regression Metrics Calculation Made easy

Helpful functions for use alongside the rich Python library.

A python package for your Kali Linux distro that find the fastest mirror and configure your apt to use that mirror

Comments

Render some magic methods for classes

Aliases support

Releases(v0.0.3)

v0.0.3(Jul 5, 2022)

v0.0.2(Oct 7, 2021)

v0.0.1(Aug 24, 2021)

Owner

Toloka

✨ Voici un code en Python par moi, et en français qui permet de générer du texte Lorem.

one_click_kag_server is a program which tries to fully automate the creation of a King Arthur's Gold server.

Extract the download URL from OneDrive or SharePoint share link and push it to aria2

A primitive Python wrapper around the Gromacs tools.

This is discord nitro code generator and checker made with python. This will generate nitro codes and checks if the code is valid or not. If code is valid then it will print the code leaving 2 lines and if not then it will print '*'.

🚧Useful shortcuts for simple task on windows

Various importers for cointracker

jsoooooooon derulo - Make sure your 'jason derulo' is featured as the first part of your json data

convert a dict-list object from / to a typed object(class instance with type annotation)

Retrying library for Python

Similar looking domain detection using python fuzzywuzzy

ULID implementation for Python

iOS Snapchat parser for chats and cached files

A python module to validate input.

Script to autocompound 3commas BO:SO based on user provided risk factor

cpp20.py is a Python script to compile C++20 code using modules.

Course-parsing - Parsing Course Info for NIT Kurukshetra

A python module to manipulate XCode projects

A Python library for reading, writing and visualizing the OMEGA Format

python-codicefiscale: a tiny library for encode/decode Italian fiscal code - codifica/decodifica del Codice Fiscale.