yacs-stubgen

Add typing support for your YACS config by generating stub file.

Install

Install from PyPI:

pip install yacs-stubgen

pip install git+https://github.com/JamzumSum/yacs-stubgen.git

Usage

Auto-Generate

Add typing support for your yacs config by appending just three lines:

from yacs.config import CfgNode as CN

_C.MODEL.DEVICE = 'cuda'
...
# your config items above

# this line can be moved to the import header
from yacs_stubgen import build_pyi
# this alias ensure you can import `AutoConfig` and use something like `isinstance`
AutoConfig = CN
# _C is the CfgNode object, "_C" should be its varname correctly
# AutoConfig is an alias of CfgNode, "AutoConfig" should be its varname correctly
build_pyi(_C, __file__, cls_name='AutoConfig', var_name='_C')

After any run/import of this file, a stub file (*.pyi) will be generated. Then you will get typing and auto-complete support if your IDE supports stub files.

Each time you change your config, you have to run/import this file again to apply the changes.

Build Script

We have provided a script as an entrypoint. Simply run yacstub <file/dir> and it will generate stub file if one module contains a CfgNode object in global scope.

> yacstub ./conf    # specify a directory
INFO: Generated conf/default.pyi
> yacstub ./conf/default.py # specify a file
INFO: Generated conf/default.pyi

Similarly, each time you change the config, you have to re-run the script to apply the changes.

How it works

License

• MIT
• yacs is under Apache-2.0