WikiWe

Using Python package in Typescript

1 min read

Using Python in TypeScript with PyBridge

PyBridge is a powerful TypeScript library that enables seamless integration between Python and Node.js applications, particularly useful for leveraging Python’s capabilities within TypeScript projects[1].

Key Features

  • Full TypeScript type support including generics[1]
  • Generator function support for streaming with RxJS[1]
  • Automatic data serialization between Node.js and Python[1]
  • Support for both Python modules and scripts[1]

Implementation Guide

Installation

npm install pybridge
npm install --save-dev @deepkit/type-compiler

Basic Setup

import {PyBridge} from 'pybridge';
 
const bridge = new PyBridge({
  python: 'python3',
  cwd: __dirname
});
 
interface API {
  word_sizes(words: string[]): number[];
}
 
const api = bridge.controller<API>('script.py');

Python Implementation

from typing import List
 
def word_sizes(words: List[str]) -> List[int]:
    return [len(word) for word in words]

Best Practices

Type Safety The function signatures in TypeScript must accurately mirror the Python functions to ensure proper type checking and data exchange[1]. This enables:

  • Compile-time error detection
  • Proper data serialization
  • Runtime type validation

Controller Organization For better code organization, create a dedicated controller class[2]:

class PythonController {
  script = this.python.controller<API>('script.py');
  
  constructor(protected python: PyBridge) {}
}

References

Citations: [1] https://marcjschmidt.de/pybridge [2] https://github.com/marcj/pybridge [3] https://dev.to/bimaadi/writing-python-code-like-typescript-1le [4] https://www.reddit.com/r/typescript/comments/tdbin0/how_to_create_a_python_api_for_a_project_based_on/ [5] https://www.reddit.com/r/typescript/comments/vujfhr/how_to_use_python_and_typescript_very_close/ [6] https://towardsdatascience.com/packaging-your-typescript-client-into-a-python-backend-b087e50c5c1a?gi=18e721b9528e

Graph View