# JSPyBridge
[](http://npmjs.com/package/pythonia)
[](https://pypi.org/project/javascript/)
[](https://github.com/extremeheat/JSPyBridge/actions/workflows/)
[](https://gitpod.io/#https://github.com/extremeheat/jspybridge)
Interoperate Node.js and Python. You can run Python from Node.js, *or* run Node.js from Python. **Work in progress.**
Requires Node.js 18 and Python 3.8 or newer.
## Key Features
* Ability to call async and sync functions and get object properties with a native feel
* Built-in garbage collection
* Bidirectional callbacks with arbitrary arguments
* Iteration and exception handling support
* Object inspection allows you to easily `console.log` or `print()` any foreign objects
* (Bridge to call Python from JS) Python class extension and inheritance. [See pytorch and tensorflow examples](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/pytorch-train.js).
* (Bridge to call JS from Python) Native decorator-based event emitter support
* (Bridge to call JS from Python) First-class Jupyter Notebook/Google Colab support. See some Google Colab uses below.
## Basic usage example
See some examples [here](https://github.com/extremeheat/JSPyBridge/tree/master/examples). See [documentation](https://github.com/extremeheat/JSPyBridge#documentation) below and in [here](https://github.com/extremeheat/JSPyBridge/tree/master/docs).
### Access JavaScript from Python
```sh
pip3 install javascript
```
```py
from javascript import require, globalThis
chalk, fs = require("chalk"), require("fs")
print("Hello", chalk.red("world!"), "it's", globalThis.Date().toLocaleString())
fs.writeFileSync("HelloWorld.txt", "hi!")
```
### Access Python from JavaScript
Make sure to have the dependencies installed before hand!
```sh
npm i pythonia
```
```js
import { python } from 'pythonia'
// Import tkinter
const tk = await python('tkinter')
// All Python API access must be prefixed with await
const root = await tk.Tk()
// A function call with a $ suffix will treat the last argument as a kwarg dict
const a = await tk.Label$(root, { text: 'Hello World' })
await a.pack()
await root.mainloop()
python.exit() // Make sure to exit Python in the end to allow node to exit. You can also use process.exit.
```
### Examples
[](https://gitpod.io/#https://github.com/extremeheat/jspybridge)
Check out some cool examples below! Try them on Gitpod! Click the Open in Gitpod link above, and then open the examples folder.
[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/pytorch-train.js)
[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/matplotlib.js)
[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/tensorflow.js)
[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/python/mineflayer.py)
<!-- <img src="https://matplotlib.org/stable/_static/logo2_compressed.svg" alt="matplotlib" width="120" height="70">
-->
### Bridge feature comparison
Unlike other bridges, you may notice you're not just writing Python code in JavaScript, or vice-versa. You can operate on objects
on the other side of the bridge as if the objects existed on your side. This is achieved through real interop support: you can call
callbacks, and do loss-less function calls with any arguments you like (with the exception of floating points percision of course).
| | python(ia) bridge | javascript bridge | [npm:python-bridge](https://www.npmjs.com/package/python-bridge) |
|---|---|---|---|
| Garbage collection | ✔ | ✔ | ❌ |
| Class extension support | ✔ | Not built-in (rare use case), can be manually done with custom proxy | ❌ |
| Passthrough stdin | ❌ (Standard input is not piped to bridge processes. Instead, listen to standard input then expose an API on the other side of the bridge recieve the data.) | ❌ | ✔ |
| Passthrough stdout, stderr | ✔ | ✔ | ✔ |
| Long-running sync calls | ✔ | ✔ | ✔ |
| Long-running async calls | ❌ (need to manually create new thread) | ✔ (AsyncTask) | ❌ (need to manually create new thread) |
| Callbacks | ✔ | ✔ | ❌ |
| Call classes | ✔ | ✔ | |
| Iterators | ✔ | ✔ | ❌ |
| Inline eval | ✔ | ✔ | |
| Dependency Management | ❌ | ✔ | ❌ |
| Local File Imports | ✔ | ✔ | ❌ |
| Error Management | ✔ | ✔ | ✔ |
| Object inspection | ✔ | ✔ | ❌ |
## Who's using it
* [PrismarineJS/mineflayer](https://github.com/PrismarineJS/mineflayer) -- [](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb)
# Documentation
## From Python
You can import the bridge module with
```py
from javascript import require
```
This will import the require function which you can use just like in Node.js. This is a slightly
modified require function which does dependency management for you. The first paramater is the name
or location of the file to import. Internally, this calls the ES6 dynamic `import()` function. Which
supports both CommonJS and ES6 modules.
If you are passing a module name (does not start with / or include a .) such as 'chalk', it will search
for the dependency in the internal node_module folder and if not found, install it automatically.
This install will only happen once, it won't impact startup afterwards.
The second paramater to the built-in require function is the version of the package you want, for
example `require('chalk', '^3')` to get a version greater than major version 3. Just like you would
if you were using `npm install`. It's reccomended to only use the major version as the name and version
will be internally treated as a unique package, for example 'chalk--^3'. If you leave this empty,
we will install `latest` version instead, or use the version that may already be installed globally.
### Usage
* All function calls to JavaScript are thread synchronous
* ES6 classes can be constructed without new
* ES5 classes can be constructed with the .new psuedo method
* Use `@On` decorator when binding event listeners. Use `off()` to disable it.
* All callbacks run on a dedicated callback thread. DO NOT BLOCK in a callback or all other events will be blocked. Instead:
* Use the @AsyncTask decorator when you need to spawn a new thread for an async JS task.
For more, see [docs/python.md](https://github.com/extremeheat/JSPyBridge/blob/master/docs/python.md).
### Usage
<details>
<summary>👉 Click here to see some code usage examples 👈</summary>
### Basic import
Let's say we have a file in JS like this called `time.js` ...
```js
function whatTimeIsIt() {
return (new Date()).toLocaleString()
}
module.exports = { whatTimeIsIt }
```
Then we can call it from Python !
```py
from javascript import require
time = require('./time.js')
print(time.whatTimeIsIt())
```
### Event emitter
*You must use the provided On, Once, decorator and off function over the normal dot methods.*
emitter.js
```js
const { EventEmitter } = require('events')
class MyEmitter extends EventEmitter {
counter = 0
inc() {
this.emit('increment', ++this.counter)
}
}
module.exports = { MyEmitter }
```
listener.py
```py
from javascript import require, On, off
MyEmitter = require('./emitter.js')
# New class instance
myEmitter = MyEmitter()
# Decorator usage
@On(myEmitter, 'increment')
def handleIncrement(this, counter):
print("Incremented", counter)
# Stop listening. `this` is the this variable in JS.
off(myEmitter, 'increment', handleIncrement)
# Trigger the event handler
myEmitter.inc()
```
### ES5 class
es5.js
```js
function MyClass(num) {
this.getNum = () => num
}
module.exports = { MyClass }
```
es5.py
```py
MyEmitter = require('./es5.js')
myClass = MyClass.new(3)
print(myClass.getNum())
```
### Iteration
items.js
```js
module.exports = { items: [5, 6, 7, 8] }
```
items.py
```py
items = require('./items.js')
for item in items:
print(item)
```
### Callback
callback.js
```js
export function method(cb, salt) {
cb(42 + salt)
}
```
callback.py
```py
method = require('./callback').method
# Example with a lambda, but you can also pass a function ref
method(lambda v: print(v), 2) # Prints 44
```
</details>
## From JavaScript
* All the Python APIs are async. You must await them all.
* Use `python.exit()` or `process.exit()` at the end to quit the Python process.
* This library doesn't manage the packaging.
* Right now you need to install all the deps from pip globally, but later on we may allow loading from pip-envs.
* When you do a normal Python function call, you can supply "positional" arguments, which must
be in the correct order to what the Python function expects.
* Some Python objects accept arbitrary keyword arguments. You can call these functions by using
the special `$` function syntax.
* When you do a function call with a `$` before the parenthesis, such as `await some.pythonCall$()`,
the final argument is evaluated as a kwarg dictionary. You can supply named arguments this way.
* Property access with a $ at the end acts as a error suppression operator.
* Any errors will be ignored and instead undefined will be returned
* See [docs/javascript.md](docs/javascript.md) for more docs, and the examples for more info
### Usage
<details>
<summary>👉 Click here to see some code usage examples 👈</summary>
### Basic import
Let's say we have a file in Python like this called `time.py` ...
```py
import datetime
def what_time_is_it():
return str(datetime.datetime.now())
```
Then we can call it from JavaScript !
```js
import { python } from 'pythonia'
const time = await python('./time.py')
console.log("It's", await time.what_time_is_it())
python.exit()
```
### Iterating
* When iterating a Python object, you *must* use a `for await` loop instead of a normal `for-of` loop.
iter.py
```py
import os
def get_files():
for f in os.listdir():
yield f
```
iter.js
```js
const iter = await python('./iter.py')
const files = await iter.get_files()
for await (const file of files) {
console.log(file)
}
```
</details>
## Extra details
* When doing a function call, any returned foreign objects will be sent to you as a reference. For example, if you're in JavaScript and do a function call to Python that returns an array, you won't get a JS array back, but you will get a reference to the Python array. You can still access the array normally with the [] notation, as long as you use await.
* This behavior makes it very fast to pass objects directly between same-language functions, avoiding costly cross-language data transfers.
* However, this does not apply with callbacks or non-native function input parameters. The bridge will try to serialize what it can, and will give you a foreign reference if it's unable to serialize something. So if you pass a JS object, you'll get a Python dict, but if the dict contains something like a class, you'll get a reference in its place.
* (On the bridge to call JavaScript from Python) If you would like the bridge to turn a foreign reference to something native, you can use `.valueOf()` to transfer an object via JSON serialization, or `.blobValueOf()` to write an object into the communication pipe directly.
- `.valueOf()` can be used on any JSON-serializable object, but may be very slow for big data.
- `.blobValueOf()` can be used on any pipe-writeable object implementing the `length` property (e.g. `Buffer`). It can be massively faster by circumventing the JSON+UTF8 encode/decode layer, which is inept for large byte arrays.
* You can use custom Node.js/Python binary paths by setting the `NODE_BIN` or `PYTHON_BIN` enviornment variables before importing the library. Otherwise, the `node` and `python3` or `python` binaries will be called relative to your PATH enviornment variable.
* The inter-process communication can be inspected by setting the `DEBUG` env var to `jspybridge`.
#### Limitations
* The `ffid` keyword is reserved. You cannot use it in variable names, object keys or values as this is used to internlly track objects.
* On the bridge to call JavaScript from Python, due to the limiatations of Python and cross-platform IPC, we currently communicate over standard error which means that specific output in JS standard error can interfere with the bridge (as of this writing, the prefices `{"r"` and `blob!` are reserved). A similar issue exists on Windows with Python. You are however very unlikely to have issues with this.
* Function calls will timeout after 100000 ms and throw a `BridgeException` error. That default value can be overridden by defining the new value of `REQ_TIMEOUT` in an environment variable, and setting it to 0 will disable timeout checks.
Raw data
{
"_id": null,
"home_page": "https://github.com/shuyabin/JSPyBridge",
"name": "websocket-javascript",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": null,
"keywords": "node, javascript, bridge, development",
"author": "shuyabin",
"author_email": "extreme@protonmail.ch",
"download_url": "https://files.pythonhosted.org/packages/e3/75/98d7dfaf09a4c09d17d21a6daff69b746c6ea87472bb1e0191a94e3642c8/websocket_javascript-1!1.2.1.tar.gz",
"platform": null,
"description": "# JSPyBridge\r\n[](http://npmjs.com/package/pythonia)\r\n[](https://pypi.org/project/javascript/)\r\n[](https://github.com/extremeheat/JSPyBridge/actions/workflows/)\r\n[](https://gitpod.io/#https://github.com/extremeheat/jspybridge)\r\n\r\n\r\nInteroperate Node.js and Python. You can run Python from Node.js, *or* run Node.js from Python. **Work in progress.** \r\n\r\nRequires Node.js 18 and Python 3.8 or newer.\r\n\r\n## Key Features\r\n\r\n* Ability to call async and sync functions and get object properties with a native feel\r\n* Built-in garbage collection\r\n* Bidirectional callbacks with arbitrary arguments\r\n* Iteration and exception handling support\r\n* Object inspection allows you to easily `console.log` or `print()` any foreign objects\r\n* (Bridge to call Python from JS) Python class extension and inheritance. [See pytorch and tensorflow examples](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/pytorch-train.js).\r\n* (Bridge to call JS from Python) Native decorator-based event emitter support\r\n* (Bridge to call JS from Python) First-class Jupyter Notebook/Google Colab support. See some Google Colab uses below.\r\n\r\n\r\n## Basic usage example\r\n\r\nSee some examples [here](https://github.com/extremeheat/JSPyBridge/tree/master/examples). See [documentation](https://github.com/extremeheat/JSPyBridge#documentation) below and in [here](https://github.com/extremeheat/JSPyBridge/tree/master/docs).\r\n\r\n### Access JavaScript from Python\r\n\r\n\r\n```sh\r\npip3 install javascript\r\n```\r\n\r\n\r\n```py\r\nfrom javascript import require, globalThis\r\n\r\nchalk, fs = require(\"chalk\"), require(\"fs\")\r\n\r\nprint(\"Hello\", chalk.red(\"world!\"), \"it's\", globalThis.Date().toLocaleString())\r\nfs.writeFileSync(\"HelloWorld.txt\", \"hi!\")\r\n```\r\n\r\n### Access Python from JavaScript\r\n\r\nMake sure to have the dependencies installed before hand!\r\n\r\n```sh\r\nnpm i pythonia\r\n```\r\n\r\n```js\r\nimport { python } from 'pythonia'\r\n// Import tkinter\r\nconst tk = await python('tkinter')\r\n// All Python API access must be prefixed with await\r\nconst root = await tk.Tk()\r\n// A function call with a $ suffix will treat the last argument as a kwarg dict\r\nconst a = await tk.Label$(root, { text: 'Hello World' })\r\nawait a.pack()\r\nawait root.mainloop()\r\npython.exit() // Make sure to exit Python in the end to allow node to exit. You can also use process.exit.\r\n```\r\n\r\n### Examples\r\n[](https://gitpod.io/#https://github.com/extremeheat/jspybridge)\r\n\r\nCheck out some cool examples below! Try them on Gitpod! Click the Open in Gitpod link above, and then open the examples folder.\r\n\r\n\r\n[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/pytorch-train.js)\r\n[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/matplotlib.js)\r\n[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/javascript/tensorflow.js)\r\n[](https://github.com/extremeheat/JSPyBridge/blob/master/examples/python/mineflayer.py)\r\n<!-- <img src=\"https://matplotlib.org/stable/_static/logo2_compressed.svg\" alt=\"matplotlib\" width=\"120\" height=\"70\">\r\n -->\r\n\r\n\r\n### Bridge feature comparison\r\n\r\nUnlike other bridges, you may notice you're not just writing Python code in JavaScript, or vice-versa. You can operate on objects\r\non the other side of the bridge as if the objects existed on your side. This is achieved through real interop support: you can call\r\ncallbacks, and do loss-less function calls with any arguments you like (with the exception of floating points percision of course).\r\n\r\n| | python(ia) bridge | javascript bridge | [npm:python-bridge](https://www.npmjs.com/package/python-bridge) |\r\n|---|---|---|---|\r\n| Garbage collection | \u2714 | \u2714 | \u274c |\r\n| Class extension support | \u2714 | Not built-in (rare use case), can be manually done with custom proxy | \u274c |\r\n| Passthrough stdin | \u274c (Standard input is not piped to bridge processes. Instead, listen to standard input then expose an API on the other side of the bridge recieve the data.) | \u274c | \u2714 |\r\n| Passthrough stdout, stderr | \u2714 | \u2714 | \u2714 |\r\n| Long-running sync calls | \u2714 | \u2714 | \u2714 |\r\n| Long-running async calls | \u274c (need to manually create new thread) | \u2714 (AsyncTask) | \u274c (need to manually create new thread) |\r\n| Callbacks | \u2714 | \u2714 | \u274c |\r\n| Call classes | \u2714 | \u2714 | |\r\n| Iterators | \u2714 | \u2714 | \u274c |\r\n| Inline eval | \u2714 | \u2714 | |\r\n| Dependency Management | \u274c | \u2714 | \u274c |\r\n| Local File Imports | \u2714 | \u2714 | \u274c |\r\n| Error Management | \u2714 | \u2714 | \u2714 |\r\n| Object inspection | \u2714 | \u2714 | \u274c |\r\n\r\n## Who's using it\r\n* [PrismarineJS/mineflayer](https://github.com/PrismarineJS/mineflayer) -- [](https://colab.research.google.com/github/PrismarineJS/mineflayer/blob/master/docs/mineflayer.ipynb)\r\n\r\n# Documentation\r\n\r\n## From Python\r\n\r\nYou can import the bridge module with \r\n```py\r\nfrom javascript import require\r\n```\r\n\r\nThis will import the require function which you can use just like in Node.js. This is a slightly\r\nmodified require function which does dependency management for you. The first paramater is the name\r\nor location of the file to import. Internally, this calls the ES6 dynamic `import()` function. Which\r\nsupports both CommonJS and ES6 modules.\r\n\r\nIf you are passing a module name (does not start with / or include a .) such as 'chalk', it will search \r\nfor the dependency in the internal node_module folder and if not found, install it automatically. \r\nThis install will only happen once, it won't impact startup afterwards.\r\n\r\nThe second paramater to the built-in require function is the version of the package you want, for\r\nexample `require('chalk', '^3')` to get a version greater than major version 3. Just like you would\r\nif you were using `npm install`. It's reccomended to only use the major version as the name and version\r\nwill be internally treated as a unique package, for example 'chalk--^3'. If you leave this empty, \r\nwe will install `latest` version instead, or use the version that may already be installed globally.\r\n\r\n### Usage\r\n\r\n* All function calls to JavaScript are thread synchronous\r\n* ES6 classes can be constructed without new\r\n* ES5 classes can be constructed with the .new psuedo method\r\n* Use `@On` decorator when binding event listeners. Use `off()` to disable it.\r\n* All callbacks run on a dedicated callback thread. DO NOT BLOCK in a callback or all other events will be blocked. Instead:\r\n* Use the @AsyncTask decorator when you need to spawn a new thread for an async JS task.\r\n\r\nFor more, see [docs/python.md](https://github.com/extremeheat/JSPyBridge/blob/master/docs/python.md).\r\n\r\n### Usage\r\n\r\n<details>\r\n <summary>\ud83d\udc49 Click here to see some code usage examples \ud83d\udc48</summary>\r\n\r\n### Basic import\r\n\r\nLet's say we have a file in JS like this called `time.js` ...\r\n```js\r\nfunction whatTimeIsIt() {\r\n return (new Date()).toLocaleString()\r\n}\r\nmodule.exports = { whatTimeIsIt }\r\n```\r\n\r\nThen we can call it from Python !\r\n```py\r\nfrom javascript import require\r\ntime = require('./time.js')\r\nprint(time.whatTimeIsIt())\r\n```\r\n\r\n### Event emitter\r\n\r\n*You must use the provided On, Once, decorator and off function over the normal dot methods.*\r\n\r\nemitter.js\r\n```js\r\nconst { EventEmitter } = require('events')\r\nclass MyEmitter extends EventEmitter {\r\n counter = 0\r\n inc() {\r\n this.emit('increment', ++this.counter)\r\n }\r\n}\r\nmodule.exports = { MyEmitter }\r\n```\r\n\r\nlistener.py\r\n```py\r\nfrom javascript import require, On, off\r\nMyEmitter = require('./emitter.js')\r\n# New class instance\r\nmyEmitter = MyEmitter()\r\n# Decorator usage\r\n@On(myEmitter, 'increment')\r\ndef handleIncrement(this, counter):\r\n print(\"Incremented\", counter)\r\n # Stop listening. `this` is the this variable in JS.\r\n off(myEmitter, 'increment', handleIncrement)\r\n# Trigger the event handler\r\nmyEmitter.inc()\r\n```\r\n\r\n### ES5 class\r\n\r\nes5.js\r\n```js\r\nfunction MyClass(num) {\r\n this.getNum = () => num\r\n}\r\nmodule.exports = { MyClass }\r\n```\r\n\r\n\r\nes5.py\r\n```py\r\nMyEmitter = require('./es5.js')\r\nmyClass = MyClass.new(3)\r\nprint(myClass.getNum())\r\n```\r\n\r\n### Iteration\r\nitems.js\r\n```js\r\nmodule.exports = { items: [5, 6, 7, 8] }\r\n```\r\n\r\nitems.py\r\n```py\r\nitems = require('./items.js')\r\nfor item in items:\r\n print(item)\r\n```\r\n\r\n### Callback\r\n\r\ncallback.js\r\n```js\r\nexport function method(cb, salt) {\r\n cb(42 + salt)\r\n}\r\n```\r\ncallback.py\r\n```py\r\nmethod = require('./callback').method\r\n# Example with a lambda, but you can also pass a function ref\r\nmethod(lambda v: print(v), 2) # Prints 44\r\n```\r\n\r\n</details>\r\n\r\n## From JavaScript\r\n\r\n* All the Python APIs are async. You must await them all. \r\n* Use `python.exit()` or `process.exit()` at the end to quit the Python process.\r\n* This library doesn't manage the packaging. \r\n * Right now you need to install all the deps from pip globally, but later on we may allow loading from pip-envs.\r\n* When you do a normal Python function call, you can supply \"positional\" arguments, which must \r\n be in the correct order to what the Python function expects.\r\n* Some Python objects accept arbitrary keyword arguments. You can call these functions by using\r\n the special `$` function syntax. \r\n * When you do a function call with a `$` before the parenthesis, such as `await some.pythonCall$()`, \r\n the final argument is evaluated as a kwarg dictionary. You can supply named arguments this way.\r\n* Property access with a $ at the end acts as a error suppression operator. \r\n * Any errors will be ignored and instead undefined will be returned\r\n* See [docs/javascript.md](docs/javascript.md) for more docs, and the examples for more info\r\n\r\n### Usage\r\n\r\n<details>\r\n <summary>\ud83d\udc49 Click here to see some code usage examples \ud83d\udc48</summary>\r\n\r\n### Basic import\r\n\r\nLet's say we have a file in Python like this called `time.py` ...\r\n```py\r\nimport datetime\r\ndef what_time_is_it():\r\n return str(datetime.datetime.now())\r\n```\r\n\r\nThen we can call it from JavaScript !\r\n```js\r\nimport { python } from 'pythonia'\r\nconst time = await python('./time.py')\r\nconsole.log(\"It's\", await time.what_time_is_it())\r\npython.exit()\r\n```\r\n\r\n### Iterating\r\n\r\n* When iterating a Python object, you *must* use a `for await` loop instead of a normal `for-of` loop.\r\n\r\niter.py\r\n```py\r\nimport os\r\ndef get_files():\r\n for f in os.listdir():\r\n yield f\r\n```\r\n\r\niter.js\r\n```js\r\nconst iter = await python('./iter.py')\r\nconst files = await iter.get_files()\r\nfor await (const file of files) {\r\n console.log(file)\r\n}\r\n```\r\n</details>\r\n\r\n## Extra details\r\n\r\n* When doing a function call, any returned foreign objects will be sent to you as a reference. For example, if you're in JavaScript and do a function call to Python that returns an array, you won't get a JS array back, but you will get a reference to the Python array. You can still access the array normally with the [] notation, as long as you use await.\r\n\r\n* This behavior makes it very fast to pass objects directly between same-language functions, avoiding costly cross-language data transfers.\r\n\r\n* However, this does not apply with callbacks or non-native function input parameters. The bridge will try to serialize what it can, and will give you a foreign reference if it's unable to serialize something. So if you pass a JS object, you'll get a Python dict, but if the dict contains something like a class, you'll get a reference in its place.\r\n\r\n* (On the bridge to call JavaScript from Python) If you would like the bridge to turn a foreign reference to something native, you can use `.valueOf()` to transfer an object via JSON serialization, or `.blobValueOf()` to write an object into the communication pipe directly.\r\n - `.valueOf()` can be used on any JSON-serializable object, but may be very slow for big data.\r\n - `.blobValueOf()` can be used on any pipe-writeable object implementing the `length` property (e.g. `Buffer`). It can be massively faster by circumventing the JSON+UTF8 encode/decode layer, which is inept for large byte arrays.\r\n\r\n* You can use custom Node.js/Python binary paths by setting the `NODE_BIN` or `PYTHON_BIN` enviornment variables before importing the library. Otherwise, the `node` and `python3` or `python` binaries will be called relative to your PATH enviornment variable. \r\n\r\n* The inter-process communication can be inspected by setting the `DEBUG` env var to `jspybridge`.\r\n\r\n#### Limitations\r\n\r\n* The `ffid` keyword is reserved. You cannot use it in variable names, object keys or values as this is used to internlly track objects.\r\n\r\n* On the bridge to call JavaScript from Python, due to the limiatations of Python and cross-platform IPC, we currently communicate over standard error which means that specific output in JS standard error can interfere with the bridge (as of this writing, the prefices `{\"r\"` and `blob!` are reserved). A similar issue exists on Windows with Python. You are however very unlikely to have issues with this.\r\n\r\n* Function calls will timeout after 100000 ms and throw a `BridgeException` error. That default value can be overridden by defining the new value of `REQ_TIMEOUT` in an environment variable, and setting it to 0 will disable timeout checks.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Call and interop Node.js APIs with Python",
"version": "1!1.2.1",
"project_urls": {
"Bug Reports": "https://github.com/extremeheat/JSPyBridge/issues",
"Homepage": "https://github.com/shuyabin/JSPyBridge",
"Say Thanks!": "https://github.com/extremeheat/JSPyBridge",
"Source": "https://github.com/extremeheat/JSPyBridge/"
},
"split_keywords": [
"node",
" javascript",
" bridge",
" development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e085e025d8d267a88cf6a199c3028d04c106e7dc29a0584dc5fba6c0c83f874",
"md5": "cac63c6e095c51e436023f2052d88a20",
"sha256": "1fa62016254cc4111428de162421b44efe9ba76ede97fc6d661709e920535aea"
},
"downloads": -1,
"filename": "websocket_javascript-1!1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cac63c6e095c51e436023f2052d88a20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 34479,
"upload_time": "2024-07-04T15:20:40",
"upload_time_iso_8601": "2024-07-04T15:20:40.409768Z",
"url": "https://files.pythonhosted.org/packages/4e/08/5e025d8d267a88cf6a199c3028d04c106e7dc29a0584dc5fba6c0c83f874/websocket_javascript-1!1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e37598d7dfaf09a4c09d17d21a6daff69b746c6ea87472bb1e0191a94e3642c8",
"md5": "e79ce2bd5339f445fda4c92cecae9e38",
"sha256": "1fc77935c18819524ac3b34e6b9d26d17b46230cab62e558fbae9ad87703201a"
},
"downloads": -1,
"filename": "websocket_javascript-1!1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "e79ce2bd5339f445fda4c92cecae9e38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 37751,
"upload_time": "2024-07-04T15:20:42",
"upload_time_iso_8601": "2024-07-04T15:20:42.285388Z",
"url": "https://files.pythonhosted.org/packages/e3/75/98d7dfaf09a4c09d17d21a6daff69b746c6ea87472bb1e0191a94e3642c8/websocket_javascript-1!1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 15:20:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shuyabin",
"github_project": "JSPyBridge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "websocket-javascript"
}
JSON
