Skip to main content

Petit ts

Codecov GitHub license

A Library to easely convert your python types to typescript types.

It's a part of the petite_stack (not released yet, as not mature enough).

Example

from petit_ts import TSTypeStore, Named

store = TSTypeStore()


class Jeb(Enum):
    A = 'R'


# if you want an union to be named and not inlined
UserType = Named(Literal['admin', 'user'])

TestUnion = Named(Union[str, int])

class CreateUserDto(BaseModel):
    username: str
    # will be inlined
    password: Union[str, Jeb]
    # won't be inlined
    role: UserType
    # won't be inlined
    jeb: TestUnion

store.add_type(CreateUserDto)

res = store.get_repr(CreateUserDto)
print(res)
# >>> "CreateUserDto"

# Here you notice that we have the name instead of the body, so that you can use it
# in another function easely

# here we need to do this in order, to get all the required deps into our ts file
not_inlined = store.get_all_not_inlined()
print(not_inlined)
# >>> "type CreateUserDto  = {
# 	username: string;
# 	password: string | Jeb;
# 	role: UserType;
# 	jeb: TestUnion;
# };
# export enum Jeb {
# 	A = "R",
# };
# type UserType = "admin" | "user";
# type TestUnion = string | number /*int*/"

not_inlined = store.get_all_not_inlined(exported_all=True)
print(not_inlined)
# >>> "export type CreateUserDto  = {
# 	username: string;
# 	password: string | Jeb;
# 	role: UserType;
# 	jeb: TestUnion;
# };
# export enum Jeb {
# 	A = "R",
# };
# export type UserType = "admin" | "user";
# export type TestUnion = string | number /*int*/"


with open('res.ts', 'w') as f :
    # write what you need to the file
    final = f'export a = function (a: any): {store.get_repr(CreateUserDto)};'
    final += store.get_all_not_inlined()
    f.write(final)
store = TSTypeStore(export_all=True)
T = TypeVar('T')

@dataclass
class jeb(Generic[T]):
    p: T

impl = Named(List[jeb[int]])

store.get_full_repr(impl) # >> 'export type impl = (jeb<number /*int*/>)[];'
# the jeb type is automatically added to the store and can be retrived with:
# store.get_all_not_inlined()

Supported types:

  • None
  • bool
  • str
  • int
  • float
  • Dict[K, V], Dict, dict
  • List[T], List, list
  • @dataclass, generic @dataclass
  • Optional[T], Named(Optional[T])
  • Union[A, B, ...], Named(Union[A, B, ...])
  • Literal[values], Named(Literal[1, 2, '3']) with values = Union[int, str]
  • Tuple[A, B, ...], Named(Tuple[A, B, ...])

Add support for a custom type

Example for the BaseModel type:

from typing import Tuple, Optional, Dict, Any, get_type_hints
from petit_ts import ClassHandler, TSTypeStore
from pydantic import BaseModel

store = TSTypeStore()

class BaseModelHandler(ClassHandler):
    @staticmethod
    def is_mapping() -> bool:
        return True

    @staticmethod
    def should_handle(cls, store, origin, args) -> bool:
        return issubclass(cls, BaseModel)

    @staticmethod
    def build(cls: BaseModel, store, origin, args) -> Tuple[Optional[str], Dict[str, Any]]:
        name = cls.__name__
        fields = get_type_hints(cls)
        return name, fields


store.add_class_handler(BaseModelHandler)

You have to implement for the ClassHandler:

  • is_mapping
  • should_handle
  • build

If this is a mapping, you should return the fields, a Dict[str, Any] else you should return a string

For the BasicHandler :

  • build
  • should_handle

Support for Named types:

if you need a type to be exported with it's definition name, you can use the Namedfunction as such :

P = Named(Union[str, int])
# will be exported to type P = string | number;

You can name any of :

  • Optional
  • Union
  • Literal
  • Tuple

If you have any problem, don't hesitate to open an issue on github !

Support for type spoofing:

As you'll see with pydantic.BaseModel, NamedUnion is not supported by default because of the way the Union is defined in the typing lib.

In order to support this, petit_ts provides the patch_get_origin_for_Union, it will make other libraries believe NamedUnion is Union. So you have to call patch_get_origin_for_Union() before importing pydantic.

Next steps :

  • Handle multiple type of collection
  • Handle abstract types
  • Choose between interface and type

Metadata

Release files for petit-ts 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for petit-ts 0.2.2
File Size Uploaded Provenance Actions
petit_ts-0.2.2.tar.gz 9.0 kB Without provenance Details for petit_ts-0.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for petit-ts 0.2.2
File Interpreter ABI Platform Actions
petit_ts-0.2.2-py2.py3-none-any.whl Python 3, Python 2 none any Details for petit_ts-0.2.2-py2.py3-none-any.whl

Total release size: 18.7 kB

Release files / petit_ts-0.2.2.tar.gz

Download URL petit_ts-0.2.2.tar.gz
Size 9.0 kB
Tags Source
SHA-256 checksum
How to use checksums
7e103eb505e73b21b45a357e3c5be24a09ea823fefac2f1787a67f3b22025a66
BLAKE2b-256 checksum
How to use checksums
bfa330f26db66334022e105306f2036a6d4c5d106cc84c5c6501662950644f44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.6

Release files / petit_ts-0.2.2-py2.py3-none-any.whl

Download URL petit_ts-0.2.2-py2.py3-none-any.whl
Size 9.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ff6bd3145eaa46fed45ef9d2b6e7977b6fa259a1317a7abb5bdc55d3d1b00778
BLAKE2b-256 checksum
How to use checksums
12487effe3c46bec0fe68b586ccec2740fb55bdb1ac64161145fda2ca3bddd5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.6

Security for petit-ts 0.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page