# Class: `PyoliteRemoteKernel`

[@jupyterlite/pyolite-kernel](../modules/jupyterlite_pyolite_kernel.md).PyoliteRemoteKernel

An interface for pyolite workers.

## Implements

- [`IPyoliteWorkerKernel`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md)

## Constructors

### `constructor`

> **`new PyoliteRemoteKernel`**()

#### Defined in

[packages/pyolite-kernel/src/worker.ts:11](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L11)

## Properties

### `_driveFS`

> `Protected` **`_driveFS`**: `null` \| `DriveFS` = `null`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:473](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L473)

### `_driveName`

> `Protected` **`_driveName`**: `string` = `''`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:467](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L467)

### `_initialized`

> `Protected` **`_initialized`**: `Promise`<`void`\>

A promise that resolves when all initiaization is complete.

#### Defined in

[packages/pyolite-kernel/src/worker.ts:459](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L459)

### `_initializer`

> `Private` **`_initializer`**: `null` \| { `reject`: () => `void` ; `resolve`: () =>
> `void` } = `null`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:460](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L460)

### `_interpreter`

> `Protected` **`_interpreter`**: `any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:469](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L469)

### `_kernel`

> `Protected` **`_kernel`**: `any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:468](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L468)

### `_localPath`

> `Protected` **`_localPath`**: `string` = `''`

TODO: real typing

#### Defined in

[packages/pyolite-kernel/src/worker.ts:466](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L466)

### `_options`

> `Protected` **`_options`**: `null` \|
> [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md)
> = `null`

Initialization options.

#### Defined in

[packages/pyolite-kernel/src/worker.ts:455](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L455)

### `_pyodide`

> `Protected` **`_pyodide`**: `PyodideInterface`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:464](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L464)

### `_resolveInputReply`

> `Protected` **`_resolveInputReply`**: `any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:472](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L472)

### `_stderr_stream`

> `Protected` **`_stderr_stream`**: `any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:471](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L471)

### `_stdout_stream`

> `Protected` **`_stdout_stream`**: `any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:470](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L470)

## Methods

### `commClose`

> **`commClose`**(`content`, `parent`): `Promise`<`any`\>

Respond to the commClose.

#### Parameters

| Name      | Type  | Description                               |
| :-------- | :---- | :---------------------------------------- |
| `content` | `any` | The incoming message with the comm close. |
| `parent`  | `any` | -                                         |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[commClose](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#commclose)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:374](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L374)

### `commInfo`

> **`commInfo`**(`content`, `parent`): `Promise`<`any`\>

Respond to the commInfoRequest.

#### Parameters

| Name      | Type  | Description                                     |
| :-------- | :---- | :---------------------------------------------- |
| `content` | `any` | The incoming message with the comm target name. |
| `parent`  | `any` | -                                               |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[commInfo](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#comminfo)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:332](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L332)

### `commMsg`

> **`commMsg`**(`content`, `parent`): `Promise`<`any`\>

Respond to the commMsg.

#### Parameters

| Name      | Type  | Description                             |
| :-------- | :---- | :-------------------------------------- |
| `content` | `any` | The incoming message with the comm msg. |
| `parent`  | `any` | -                                       |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[commMsg](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#commmsg)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:360](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L360)

### `commOpen`

> **`commOpen`**(`content`, `parent`): `Promise`<`any`\>

Respond to the commOpen.

#### Parameters

| Name      | Type  | Description                              |
| :-------- | :---- | :--------------------------------------- |
| `content` | `any` | The incoming message with the comm open. |
| `parent`  | `any` | -                                        |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[commOpen](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#commopen)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:346](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L346)

### `complete`

> **`complete`**(`content`, `parent`): `Promise`<`any`\>

Complete the code submitted by a user.

#### Parameters

| Name      | Type  | Description                                     |
| :-------- | :---- | :---------------------------------------------- |
| `content` | `any` | The incoming message with the code to complete. |
| `parent`  | `any` | -                                               |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[complete](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#complete)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:286](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L286)

### `execute`

> **`execute`**(`content`, `parent`): `Promise`<`any`\>

Execute code with the interpreter.

#### Parameters

| Name      | Type  | Description                                    |
| :-------- | :---- | :--------------------------------------------- |
| `content` | `any` | The incoming message with the code to execute. |
| `parent`  | `any` | -                                              |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[execute](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#execute)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:175](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L175)

### `formatResult`

> **`formatResult`**(`res`): `any`

Format the response from the Pyodide evaluation.

#### Parameters

| Name  | Type  | Description                                   |
| :---- | :---- | :-------------------------------------------- |
| `res` | `any` | The result object from the Pyodide evaluation |

#### Returns

`any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:152](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L152)

### `getpass`

> **`getpass`**(`prompt`): `Promise`<`any`\>

#### Parameters

| Name     | Type     |
| :------- | :------- |
| `prompt` | `string` |

#### Returns

`Promise`<`any`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:412](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L412)

### `initFilesystem`

> `Protected` **`initFilesystem`**(`options`): `Promise`<`void`\>

Setup custom Emscripten FileSystem

#### Parameters

| Name      | Type                                                                                    |
| :-------- | :-------------------------------------------------------------------------------------- |
| `options` | [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md) |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:108](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L108)

### `initGlobals`

> `Protected` **`initGlobals`**(`options`): `Promise`<`void`\>

#### Parameters

| Name      | Type                                                                                    |
| :-------- | :-------------------------------------------------------------------------------------- |
| `options` | [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md) |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:96](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L96)

### `initKernel`

> `Protected` **`initKernel`**(`options`): `Promise`<`void`\>

#### Parameters

| Name      | Type                                                                                    |
| :-------- | :-------------------------------------------------------------------------------------- |
| `options` | [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md) |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:78](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L78)

### `initPackageManager`

> `Protected` **`initPackageManager`**(`options`): `Promise`<`void`\>

#### Parameters

| Name      | Type                                                                                    |
| :-------- | :-------------------------------------------------------------------------------------- |
| `options` | [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md) |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:56](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L56)

### `initRuntime`

> `Protected` **`initRuntime`**(`options`): `Promise`<`void`\>

#### Parameters

| Name      | Type                                                                                    |
| :-------- | :-------------------------------------------------------------------------------------- |
| `options` | [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md) |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:40](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L40)

### `initialize`

> **`initialize`**(`options`): `Promise`<`void`\>

Accept the URLs from the host

#### Parameters

| Name      | Type                                                                                    |
| :-------- | :-------------------------------------------------------------------------------------- |
| `options` | [`IOptions`](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel.IOptions.md) |

#### Returns

`Promise`<`void`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[initialize](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#initialize)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:20](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L20)

### `input`

> **`input`**(`prompt`): `Promise`<`any`\>

#### Parameters

| Name     | Type     |
| :------- | :------- |
| `prompt` | `string` |

#### Returns

`Promise`<`any`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:422](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L422)

### `inputReply`

> **`inputReply`**(`content`, `parent`): `Promise`<`void`\>

Resolve the input request by getting back the reply from the main thread

#### Parameters

| Name      | Type  | Description                         |
| :-------- | :---- | :---------------------------------- |
| `content` | `any` | The incoming message with the reply |
| `parent`  | `any` | -                                   |

#### Returns

`Promise`<`void`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[inputReply](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#inputreply)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:388](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L388)

### `inspect`

> **`inspect`**(`content`, `parent`): `Promise`<`any`\>

Inspect the code submitted by a user.

#### Parameters

| Name                   | Type       | Description                                    |
| :--------------------- | :--------- | :--------------------------------------------- |
| `content`              | `Object`   | The incoming message with the code to inspect. |
| `content.code`         | `string`   | -                                              |
| `content.cursor_pos`   | `number`   | -                                              |
| `content.detail_level` | `0` \| `1` | -                                              |
| `parent`               | `any`      | -                                              |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[inspect](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#inspect)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:299](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L299)

### `isComplete`

> **`isComplete`**(`content`, `parent`): `Promise`<`any`\>

Check code for completeness submitted by a user.

#### Parameters

| Name           | Type     | Description                                  |
| :------------- | :------- | :------------------------------------------- |
| `content`      | `Object` | The incoming message with the code to check. |
| `content.code` | `string` | -                                            |
| `parent`       | `any`    | -                                            |

#### Returns

`Promise`<`any`\>

#### Implementation of

[IPyoliteWorkerKernel](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md).[isComplete](../interfaces/jupyterlite_pyolite_kernel.IPyoliteWorkerKernel-1.md#iscomplete)

#### Defined in

[packages/pyolite-kernel/src/worker.ts:319](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L319)

### `mapToObject`

> **`mapToObject`**(`obj`): `any`

Recursively convert a Map to a JavaScript object

#### Parameters

| Name  | Type  | Description                              |
| :---- | :---- | :--------------------------------------- |
| `obj` | `any` | A Map, Array, or other object to convert |

#### Returns

`any`

#### Defined in

[packages/pyolite-kernel/src/worker.ts:136](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L136)

### `sendComm`

> **`sendComm`**(`type`, `content`, `metadata`, `ident`, `buffers`): `Promise`<`void`\>

Send a comm message to the front-end.

#### Parameters

| Name       | Type     | Description                   |
| :--------- | :------- | :---------------------------- |
| `type`     | `string` | The type of the comm message. |
| `content`  | `any`    | The content.                  |
| `metadata` | `any`    | The metadata.                 |
| `ident`    | `any`    | The ident.                    |
| `buffers`  | `any`    | The binary buffers.           |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:441](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L441)

### `sendInputRequest`

> **`sendInputRequest`**(`prompt`, `password`): `Promise`<`void`\>

Send a input request to the front-end.

#### Parameters

| Name       | Type      | Description                    |
| :--------- | :-------- | :----------------------------- |
| `prompt`   | `string`  | the text to show at the prompt |
| `password` | `boolean` | Is the request for a password? |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:400](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L400)

### `setup`

> **`setup`**(`parent`): `Promise`<`void`\>

Makes sure pyodide is ready before continuing, and cache the parent message.

#### Parameters

| Name     | Type  |
| :------- | :---- |
| `parent` | `any` |

#### Returns

`Promise`<`void`\>

#### Defined in

[packages/pyolite-kernel/src/worker.ts:165](https://github.com/jupyterlite/jupyterlite/blob/7971e0aa/packages/pyolite-kernel/src/worker.ts#L165)