Interface PyodideInterface

globals

loadedPackages

pyodide_py

version

checkInterrupt

• checkInterrupt(): void

  Checks if an interrupt has been requested via the interrupt buffer.

  Returns void

isPyProxy

• isPyProxy(value: any): boolean

  Returns true if the given value is a PyProxy object.

  Parameters

  • value: any

  Returns boolean

loadPackage

• loadPackage(packages: string | string[]): Promise<void>

  Loads one or more Python packages into the Pyodide runtime.

  Parameters

  • packages: string | string[]

  Returns Promise<void>

loadPackagesFromImports

• loadPackagesFromImports(code: string): Promise<void>

  Automatically loads packages required by the given Python code.

  Parameters

  • code: string

  Returns Promise<void>

registerJsModule

• registerJsModule(name: string, module: any): void

  Registers a JavaScript module so it can be imported from Python.

  Parameters

  • name: string
  • module: any

  Returns void

runPython

• runPython(code: string, options?: { globals?: any; locals?: any }): any

  Runs Python code synchronously and returns the result.

  Parameters

  • code: string
  • Optionaloptions: { globals?: any; locals?: any }

  Returns any

runPythonAsync

• runPythonAsync(
      code: string,
      options?: { globals?: any; locals?: any },
  ): Promise<any>

  Runs Python code asynchronously and returns the result.

  Parameters

  • code: string
  • Optionaloptions: { globals?: any; locals?: any }

  Returns Promise<any>

setInterruptBuffer

• setInterruptBuffer(buffer: Uint8Array): void

  Sets the shared interrupt buffer for cooperative interruption.

  Parameters

  • buffer: Uint8Array

  Returns void

toPy

• toPy(obj: any): any

  Converts a JavaScript object to a Python object.

  Parameters

  • obj: any

  Returns any

unregisterJsModule

• unregisterJsModule(name: string): void

  Unregisters a previously registered JavaScript module.

  Parameters

  • name: string

  Returns void