Simplifying Integration of TypeScript Interfaces in Python with ts2python

In today’s interconnected world, seamlessly integrating different technologies is key to building robust and efficient systems. When working with JSON data, having well-defined structures on both the TypeScript and Python sides is crucial for achieving IDE support, static type checking, and even runtime type validation. If you’re a Python developer looking to simplify the integration of TypeScript interfaces in your projects, look no further than ts2python.

What is ts2python?

ts2python is an open-source tool that allows you to transpile TypeScript interface definitions into Python data structure definitions. It primarily supports transpiling to Python TypedDicts, but with some postprocessing, it can also be adjusted to other popular models for records or data structures in Python, such as pydantic classes.

Key Features and Benefits

• Tier 1 and Tier 2 Support: ts2python aims to support translation of TypeScript interfaces on two different tiers. Tier 1 focuses on transpilation of passive data structures, while Tier 2 tackles the translation of active data structures, function definitions, and method definitions.

• Well-Documented APIs: The project offers comprehensive documentation that covers Tier 1 support, installation instructions, usage examples, and more. You can easily integrate ts2python into your existing Python projects and leverage its powerful features.

• Runtime Type Validation: ts2python includes support for runtime type validation, allowing you to check the validity of JSON data at runtime. This is especially useful when processing data from an external source, like JSON data from an RPC call.

• Continuous Development and Support: ts2python is actively maintained and supported by its creator, Eckhart Arnold. The project is regularly updated, ensuring compatibility with the latest versions of Python and TypeScript.

How to Get Started

Getting started with ts2python is straightforward. You can install it using pip from the command line:

bash
$ pip install ts2python

ts2python requires the parsing-expression-grammar-framework DHParser, which will be automatically installed as a dependency. Make sure you have at least Python version 3.8, although backward compatibility with Python 3.6 is supported if the typing extensions have been installed.

Once installed, you can generate Python TypedDict classes from your TypeScript interface definitions using the ts2python command:

bash
$ ts2python interfaces.ts

The resulting .py file will contain the generated TypedDict classes, ready to be imported and used in your Python code.

Validation and Type Checking

ts2python goes beyond simple transpilation and offers runtime type validation capabilities. You can use the TypedDict base class and the type_check decorator provided by ts2python to validate the types of your data structures. This adds an extra layer of safety when dealing with JSON data, ensuring that it conforms to the expected structure.

“`python
from ts2python.json_validation import TypedDict, type_check

class Position(TypedDict, total=True):
line: int
character: int

… More TypedDict definitions …

@type_check
def middle_line(rng: Range) -> Position:
# … Function implementation …

data = {‘start’: {‘line’: 1, ‘character’: 1},
‘end’: {‘line’: 8, ‘character’: 17}}
assert middle_line(data) == {‘line’: 4, ‘character’: 0}

malformed_data = {‘start’: 1, ‘end’: 8}
middle_line(malformed_data) # Raises a TypeError due to type mismatch
“`

Further Resources

For comprehensive documentation, including detailed explanations, installation instructions, usage examples, and more, visit the official ts2python documentation at ts2python.readthedocs.io.

The ts2python repository on GitHub (github.com/jecki/ts2python) contains unit tests, doctests, and a demonstration of how TypeScript interfaces are transpiled to Python code. You can explore these resources to further understand the capabilities and reliability of ts2python.

Conclusion

With ts2python, integrating TypeScript interfaces with Python becomes a breeze. Enjoy IDE support, static type checking, and runtime type validation by transpiling TypeScript interface definitions into Python data structure definitions. Seamlessly process JSON data and ensure its validity with ts2python’s robust validation features. Explore the comprehensive documentation and available tests to make the most of ts2python in your projects today.

Have any questions or want to learn more? Feel free to ask or explore the ts2python documentation and GitHub repository.