thrift-pyi 0.1.0b1

This is simple `.pyi` stubs generator from thrift interfaces

This is simple .pyi stubs generator from thrift interfaces. Motivation for this project was to have autocomplete and type checking for dynamically loaded thrift interfaces

Installation

pip install thriftpyi

Quickstart

Sample usage:

$ thriftpyi example/interfaces --output example/app/interfaces

Additionally to generated stubs you might want to create __init__.py that will load thrift interfaces, for example:

from pathlib import Path
from types import ModuleType
from typing import Dict

import thriftpy2

_interfaces_path = Path("example/interfaces")
_interfaces: Dict[str, ModuleType] = {}


def __getattr__(name):
    try:
        return _interfaces[name]
    except KeyError:
        interface = thriftpy2.load(str(_interfaces_path.joinpath(f"{name}.thrift")))
        _interfaces[name] = interface
        return interface

To see more detailed example of usage refer to example app

Caveats

Python and thrift are very different at argument handling. For example in thrift the following will be correct declaration:

struct TodoItem {
    1: required i32 id
    3: optional i32 type = 1
    2: required string text
}

In python attributes without a default cannot follow attributes with one. Nevertheless, library doesn’t enforce any checks with that case and will generate .pyi as is:

from dataclasses import dataclass

@dataclass
class TodoItem:
    id: int
    type: int = 1
    text: str

Development

To run the all tests run:

tox