Skip to main content

An elegant and automatic solution for generating/outputting Typescript interfaces from your Marshmallow Schemas.

Project description

typemallow

An elegant and automatic solution for generating/outputting Typescript interfaces from your Marshmallow Schemas

I created this Package out of necessity for one of my own projects. Rather than keeping it to myself, I thought it would be helpful for other developers and my own future projects if I uploaded it.

Usage:

Using typemallow is simple.

First, install the package pip install typemallow

Next, for your Marshmallow schemas that you wish to generate Typescript interfaces for, simply import ts_interface and generate_ts from the typemallow module, and prepend the @ts_interface() class decorator to your Marshmallow schema class.

All that is required to generate your Typescript interfaces is to call the generate_ts() function, and provide a filepath as a parameter to output the result.

main.py

from typemallow import ts_interface, generate_ts


@ts_interface()
class Foo(Schema):
    some_field = fields.Str()
    another_field = fields.Date()


generate_ts('./output.ts')

output.ts

export interface Foo {
    some_field: string;
    another_field: date;
}

typemallow even supports Nested Schema fields!

main.py

from typemallow import ts_interface, generate_ts

@ts_interface()
class Foo(Schema):
    some_field = fields.Str()
    another_field = fields.Date()

@ts_interface()
class Bar(Schema):
    foo = fields.Nested(Foo)
    foos = fields.Nested(Foo, many=True)
    bar_field = fields.Str()

output.ts

export interface Foo {
    some_field: string;
    another_field: date;
}

export interface Bar {
    foo: Foo;
    foos: Foo[];
    bar_field: string;
}

Extended Usage:

The @ts_interface() decorator function accepts an optional parameter, context, which defaults to... well... 'default'.

"Why is this the case?"

When a Marshmallow Schema is identified with with @ts_interface decorator, it is added to a list in a dictionary of schemas, with the dictionary key being the value provided to the context parameter. If you were to provide different contexts for each schema, additional keys will be created if they do not exist, or the schema will simply be appended to the list at the existing key.

This comes in handy, as the generate_ts() function also accepts an optional context parameter, which will filter only schemas in the dictionary at the specific key.

This is useful if you wish to output different contexts to different files, e.g.

main.py

...
from typemallow import ts_interface, generate_ts

@ts_interface(context='internal')
class Foo(Schema):
    foo = fields.Str()


@ts_interface(context='internal')
class Bar(Schema):
    bar = fields.Str()
 

@ts_interface(context='external')
class FooBar(Schema):
    foo_bar = fields.Str()


''' 
we're telling typemallow that we only want to generate interfaces from Schemas with 
an 'internal' context to './internal.ts' 
'''
generate_ts('./internal.ts', context='internal')

''' 
only generate interfaces from Schemas with an 'external' context to './external.ts' 
'''
generate_ts('./external.ts', context='external')

internal.ts

export interface Foo {
    foo: string;
}

export interface Bar {
    bar: string;
}

external.ts

export interface FooBar {
    foo_bar: string;
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for typemallow, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size typemallow-0.0.4.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page