slotomania 0.0.21

Slotomania

Slotomania

A code generator that transforms schemas to Python slot classes and typescript interfaces

Vocabulary

slots

Refer to Python slot classes. They’re just like regular classes with __slots__ defined.

Sloto

A base class defined in slotomania/core.py. Provides two methods: sloto_to_dict() which converts the instance to a dictionary, and __repr__ for debugging purpose.

actions or redux actions

Redux actions or action creators: see https://redux.js.org/basics/actions

Examples

from slotomania.contrib.marshmallow_converter import (
    schemas_to_slots,
)
class Eye(Schema):
    color = fields.String(required=True)


class Head(Schema):
    hair = fields.String(requried=True)


class Body(Schema):
    eyes = fields.List(fields.Nested(Eye()), required=True)
    mouth = fields.Decimal(required=True)
    poo = fields.Float(required=True)
    foot = fields.DateTime(required=True)
    head = fields.Nested(Head(), required=True)

assert format_python_code(schemas_to_slots([
    Eye(),
    Head(),
    Body(),
])) == format_python_code("""
from slotomania.core import Sloto
import datetime
import decimal
import typing

class Eye(Sloto):
    __slots__ = ['color']
    def __init__(
        self,
        color: str,
    ) -> None:

        self.color = color


class Head(Sloto):
    __slots__ = ['hair']
    def __init__(
        self,
        hair: str = None,
    ) -> None:

        self.hair = hair


class Body(Sloto):
    __slots__ = ['eyes', 'foot', 'head', 'mouth', 'poo']
    def __init__(
        self,
        eyes: typing.List[Eye],
        foot: datetime.datetime,
        head: Head,
        mouth: decimal.Decimal,
        poo: float,
    ) -> None:

        self.eyes = eyes
        self.foot = foot
        self.head = head
        self.mouth = mouth
        self.poo = poo
        """
        )

Setup for development

• Run make setup this will create git pre-commit hooks that converts this markdown to reStructured text which is needed for PyPI

• Install packages in dev-requirements.txt

Generate code

Create a python script, say sloto.py to collect your schemas and feed them to Sloto’s converters. The following example is based on a Django project:

import django
import os
from marshmallow import Schema
from myproject.api.schemas import RequestBodySchema
from slotomania.contrib.marshmallow_converter import (
    schemas_to_slots,
    schemas_to_typescript,
    ReduxAction,
)


def main() -> None:
    os.environ.setdefault(
        "DJANGO_SETTINGS_MODULE", "myproject.settings.deploy_settings"
    )
    django.setup()
    # Here, assume Endpoints is a Enum where values are RequestResolver classes
    from myproject.api.views import Endpoints

    python_output_file = 'myproject/slots.py'
    ts_output_file = 'src/sloto/index.ts'

    # This is a quick way to collect Schema's immediate sub classes
    schemas = [
        Klass() for Klass in Schema.__subclasses__()
    ]
    python_code = schemas_to_slots(schemas)
    with open(python_output_file, 'w') as f:
        f.write(python_code)

    ts_code = schemas_to_typescript(
        interface_schemas=schemas,
        redux_actions=[
            ReduxAction(
                name=name,
                schema=endpoint.get_schema(),
                pre_action=endpoint.pre_action,
                callback=endpoint.callback,
            ) for name, endpoint in Endpoints.get_endpoints().items()
        ]
    )
    with open(ts_output_file, 'w') as f:
        f.write(ts_code)


if __name__ == '__main__':
    main()

Running the above script should create 2 files: “myproject/slots.py” and “src/sloto/index.ts”. You will need to create a third file “src/sloto/instructor.tx”