// Generated by dts-bundle-generator v8.1.2 export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array; interface PyProxy { [x: string]: any; } /** * A :js:class:`~pyodide.ffi.PyProxy` is an object that allows idiomatic use of a Python object from * JavaScript. See :ref:`type-translations-pyproxy`. */ declare class PyProxy { /** @private */ $$flags: number; /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; /** * @hideconstructor */ constructor(); /** @hidden */ get [Symbol.toStringTag](): string; /** * The name of the type of the object. * * Usually the value is ``"module.name"`` but for builtins or * interpreter-defined types it is just ``"name"``. As pseudocode this is: * * .. code-block:: python * * ty = type(x) * if ty.__module__ == 'builtins' or ty.__module__ == "__main__": * return ty.__name__ * else: * ty.__module__ + "." + ty.__name__ * */ get type(): string; /** * Returns `str(o)` (unless `pyproxyToStringRepr: true` was passed to * :js:func:`~globalThis.loadPyodide` in which case it will return `repr(o)`) */ toString(): string; /** * Destroy the :js:class:`~pyodide.ffi.PyProxy`. This will release the memory. Any further attempt * to use the object will raise an error. * * In a browser supporting :js:data:`FinalizationRegistry`, Pyodide will * automatically destroy the :js:class:`~pyodide.ffi.PyProxy` when it is garbage collected, however * there is no guarantee that the finalizer will be run in a timely manner so * it is better to destroy the proxy explicitly. * * @param options * @param options.message The error message to print if use is attempted after * destroying. Defaults to "Object has already been destroyed". * */ destroy(options?: { message?: string; destroyRoundtrip?: boolean; }): void; /** * Make a new :js:class:`~pyodide.ffi.PyProxy` pointing to the same Python object. * Useful if the :js:class:`~pyodide.ffi.PyProxy` is destroyed somewhere else. */ copy(): PyProxy; /** * Converts the :js:class:`~pyodide.ffi.PyProxy` into a JavaScript object as best as possible. By * default does a deep conversion, if a shallow conversion is desired, you can * use ``proxy.toJs({depth : 1})``. See :ref:`Explicit Conversion of PyProxy * ` for more info. * @param options * @return The JavaScript object resulting from the conversion. */ toJs({ depth, pyproxies, create_pyproxies, dict_converter, default_converter, }?: { /** How many layers deep to perform the conversion. Defaults to infinite */ depth?: number; /** * If provided, :js:meth:`toJs` will store all PyProxies created in this * list. This allows you to easily destroy all the PyProxies by iterating * the list without having to recurse over the generated structure. The most * common use case is to create a new empty list, pass the list as * ``pyproxies``, and then later iterate over ``pyproxies`` to destroy all of * created proxies. */ pyproxies?: PyProxy[]; /** * If false, :js:meth:`toJs` will throw a * :py:exc:`~pyodide.ffi.ConversionError` rather than producing a * :js:class:`~pyodide.ffi.PyProxy`. */ create_pyproxies?: boolean; /** * A function to be called on an iterable of pairs ``[key, value]``. Convert * this iterable of pairs to the desired output. For instance, * :js:func:`Object.fromEntries` would convert the dict to an object, * :js:func:`Array.from` converts it to an :js:class:`Array` of pairs, and * ``(it) => new Map(it)`` converts it to a :js:class:`Map` (which is the * default behavior). */ dict_converter?: (array: Iterable<[ key: string, value: any ]>) => any; /** * Optional argument to convert objects with no default conversion. See the * documentation of :meth:`~pyodide.ffi.to_js`. */ default_converter?: (obj: PyProxy, convert: (obj: PyProxy) => any, cacheConversion: (obj: PyProxy, result: any) => void) => any; }): any; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object has a :meth:`~object.__len__` * method. */ declare class PyProxyWithLength extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyProxyWithLength extends PyLengthMethods { } declare class PyLengthMethods { /** * The length of the object. */ get length(): number; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object has a * :meth:`~object.__getitem__` method. */ declare class PyProxyWithGet extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyProxyWithGet extends PyGetItemMethods { } declare class PyGetItemMethods { /** * This translates to the Python code ``obj[key]``. * * @param key The key to look up. * @returns The corresponding value. */ get(key: any): any; /** * Returns the object treated as a json adaptor. * * With a JsonAdaptor: * 1. property access / modification / deletion is implemented with * :meth:`~object.__getitem__`, :meth:`~object.__setitem__`, and * :meth:`~object.__delitem__` respectively. * 2. If an attribute is accessed and the result implements * :meth:`~object.__getitem__` then the result will also be a json * adaptor. * * For instance, ``JSON.stringify(proxy.asJsJson())`` acts like an * inverse to Python's :py:func:`json.loads`. */ asJsJson(): PyProxy & {}; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object has a * :meth:`~object.__setitem__` or :meth:`~object.__delitem__` method. */ declare class PyProxyWithSet extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyProxyWithSet extends PySetItemMethods { } declare class PySetItemMethods { /** * This translates to the Python code ``obj[key] = value``. * * @param key The key to set. * @param value The value to set it to. */ set(key: any, value: any): void; /** * This translates to the Python code ``del obj[key]``. * * @param key The key to delete. */ delete(key: any): void; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object has a * :meth:`~object.__contains__` method. */ declare class PyProxyWithHas extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyProxyWithHas extends PyContainsMethods { } declare class PyContainsMethods { /** * This translates to the Python code ``key in obj``. * * @param key The key to check for. * @returns Is ``key`` present? */ has(key: any): boolean; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is :std:term:`iterable` * (i.e., it has an :meth:`~object.__iter__` method). */ declare class PyIterable extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyIterable extends PyIterableMethods { } declare class PyIterableMethods { /** * This translates to the Python code ``iter(obj)``. Return an iterator * associated to the proxy. See the documentation for * :js:data:`Symbol.iterator`. * * This will be used implicitly by ``for(let x of proxy){}``. */ [Symbol.iterator](): Iterator; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is :std:term:`asynchronous * iterable` (i.e., has an :meth:`~object.__aiter__` method). */ declare class PyAsyncIterable extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyAsyncIterable extends PyAsyncIterableMethods { } declare class PyAsyncIterableMethods { /** * This translates to the Python code ``aiter(obj)``. Return an async iterator * associated to the proxy. See the documentation for :js:data:`Symbol.asyncIterator`. * * This will be used implicitly by ``for(await let x of proxy){}``. */ [Symbol.asyncIterator](): AsyncIterator; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is an :term:`iterator` * (i.e., has a :meth:`~generator.send` or :meth:`~iterator.__next__` method). */ declare class PyIterator extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyIterator extends PyIteratorMethods { } declare class PyIteratorMethods { /** @private */ [Symbol.iterator](): this; /** * This translates to the Python code ``next(obj)``. Returns the next value of * the generator. See the documentation for :js:meth:`Generator.next` The * argument will be sent to the Python generator. * * This will be used implicitly by ``for(let x of proxy){}``. * * @param arg The value to send to the generator. The value will be assigned * as a result of a yield expression. * @returns An Object with two properties: ``done`` and ``value``. When the * generator yields ``some_value``, ``next`` returns ``{done : false, value : * some_value}``. When the generator raises a :py:exc:`StopIteration` * exception, ``next`` returns ``{done : true, value : result_value}``. */ next(arg?: any): IteratorResult; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is a :std:term:`generator` * (i.e., it is an instance of :py:class:`~collections.abc.Generator`). */ declare class PyGenerator extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyGenerator extends PyGeneratorMethods { } declare class PyGeneratorMethods { /** * Throws an exception into the Generator. * * See the documentation for :js:meth:`Generator.throw`. * * @param exc Error The error to throw into the generator. Must be an * instanceof ``Error``. * @returns An Object with two properties: ``done`` and ``value``. When the * generator yields ``some_value``, ``return`` returns ``{done : false, value * : some_value}``. When the generator raises a * ``StopIteration(result_value)`` exception, ``return`` returns ``{done : * true, value : result_value}``. */ throw(exc: any): IteratorResult; /** * Throws a :py:exc:`GeneratorExit` into the generator and if the * :py:exc:`GeneratorExit` is not caught returns the argument value ``{done: * true, value: v}``. If the generator catches the :py:exc:`GeneratorExit` and * returns or yields another value the next value of the generator this is * returned in the normal way. If it throws some error other than * :py:exc:`GeneratorExit` or :py:exc:`StopIteration`, that error is propagated. See * the documentation for :js:meth:`Generator.return`. * * @param v The value to return from the generator. * @returns An Object with two properties: ``done`` and ``value``. When the * generator yields ``some_value``, ``return`` returns ``{done : false, value * : some_value}``. When the generator raises a * ``StopIteration(result_value)`` exception, ``return`` returns ``{done : * true, value : result_value}``. */ return(v: any): IteratorResult; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is an * :std:term:`asynchronous iterator` */ declare class PyAsyncIterator extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyAsyncIterator extends PyAsyncIteratorMethods { } declare class PyAsyncIteratorMethods { /** @private */ [Symbol.asyncIterator](): this; /** * This translates to the Python code ``anext(obj)``. Returns the next value * of the asynchronous iterator. The argument will be sent to the Python * iterator (if it's a generator for instance). * * This will be used implicitly by ``for(let x of proxy){}``. * * @param arg The value to send to a generator. The value will be assigned as * a result of a yield expression. * @returns An Object with two properties: ``done`` and ``value``. When the * iterator yields ``some_value``, ``next`` returns ``{done : false, value : * some_value}``. When the giterator is done, ``next`` returns * ``{done : true }``. */ next(arg?: any): Promise>; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is an * :std:term:`asynchronous generator` (i.e., it is an instance of * :py:class:`~collections.abc.AsyncGenerator`) */ declare class PyAsyncGenerator extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyAsyncGenerator extends PyAsyncGeneratorMethods { } declare class PyAsyncGeneratorMethods { /** * Throws an exception into the Generator. * * See the documentation for :js:meth:`AsyncGenerator.throw`. * * @param exc Error The error to throw into the generator. Must be an * instanceof ``Error``. * @returns An Object with two properties: ``done`` and ``value``. When the * generator yields ``some_value``, ``return`` returns ``{done : false, value * : some_value}``. When the generator raises a * ``StopIteration(result_value)`` exception, ``return`` returns ``{done : * true, value : result_value}``. */ throw(exc: any): Promise>; /** * Throws a :py:exc:`GeneratorExit` into the generator and if the * :py:exc:`GeneratorExit` is not caught returns the argument value ``{done: * true, value: v}``. If the generator catches the :py:exc:`GeneratorExit` and * returns or yields another value the next value of the generator this is * returned in the normal way. If it throws some error other than * :py:exc:`GeneratorExit` or :py:exc:`StopAsyncIteration`, that error is * propagated. See the documentation for :js:meth:`AsyncGenerator.throw` * * @param v The value to return from the generator. * @returns An Object with two properties: ``done`` and ``value``. When the * generator yields ``some_value``, ``return`` returns ``{done : false, value * : some_value}``. When the generator raises a :py:exc:`StopAsyncIteration` * exception, ``return`` returns ``{done : true, value : result_value}``. */ return(v: any): Promise>; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is an * :py:class:`~collections.abc.Sequence` (i.e., a :py:class:`list`) */ declare class PySequence extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PySequence extends PySequenceMethods { } declare class PySequenceMethods { /** @hidden */ get [Symbol.isConcatSpreadable](): boolean; /** * See :js:meth:`Array.join`. The :js:meth:`Array.join` method creates and * returns a new string by concatenating all of the elements in the * :py:class:`~collections.abc.Sequence`. * * @param separator A string to separate each pair of adjacent elements of the * Sequence. * * @returns A string with all Sequence elements joined. */ join(separator?: string): string; /** * See :js:meth:`Array.slice`. The :js:meth:`Array.slice` method returns a * shallow copy of a portion of a :py:class:`~collections.abc.Sequence` into a * new array object selected from ``start`` to ``stop`` (`stop` not included) * @param start Zero-based index at which to start extraction. Negative index * counts back from the end of the Sequence. * @param stop Zero-based index at which to end extraction. Negative index * counts back from the end of the Sequence. * @returns A new array containing the extracted elements. */ slice(start?: number, stop?: number): any; /** * See :js:meth:`Array.lastIndexOf`. Returns the last index at which a given * element can be found in the Sequence, or -1 if it is not present. * @param elt Element to locate in the Sequence. * @param fromIndex Zero-based index at which to start searching backwards, * converted to an integer. Negative index counts back from the end of the * Sequence. * @returns The last index of the element in the Sequence; -1 if not found. */ lastIndexOf(elt: any, fromIndex?: number): number; /** * See :js:meth:`Array.indexOf`. Returns the first index at which a given * element can be found in the Sequence, or -1 if it is not present. * @param elt Element to locate in the Sequence. * @param fromIndex Zero-based index at which to start searching, converted to * an integer. Negative index counts back from the end of the Sequence. * @returns The first index of the element in the Sequence; -1 if not found. */ indexOf(elt: any, fromIndex?: number): number; /** * See :js:meth:`Array.forEach`. Executes a provided function once for each * ``Sequence`` element. * @param callbackfn A function to execute for each element in the ``Sequence``. Its * return value is discarded. * @param thisArg A value to use as ``this`` when executing ``callbackFn``. */ forEach(callbackfn: (elt: any) => void, thisArg?: any): void; /** * See :js:meth:`Array.map`. Creates a new array populated with the results of * calling a provided function on every element in the calling ``Sequence``. * @param callbackfn A function to execute for each element in the ``Sequence``. Its * return value is added as a single element in the new array. * @param thisArg A value to use as ``this`` when executing ``callbackFn``. */ map(callbackfn: (elt: any, index: number, array: any) => U, thisArg?: any): U[]; /** * See :js:meth:`Array.filter`. Creates a shallow copy of a portion of a given * ``Sequence``, filtered down to just the elements from the given array that pass * the test implemented by the provided function. * @param predicate A function to execute for each element in the array. It * should return a truthy value to keep the element in the resulting array, * and a falsy value otherwise. * @param thisArg A value to use as ``this`` when executing ``predicate``. */ filter(predicate: (elt: any, index: number, array: any) => boolean, thisArg?: any): any[]; /** * See :js:meth:`Array.some`. Tests whether at least one element in the * ``Sequence`` passes the test implemented by the provided function. * @param predicate A function to execute for each element in the * ``Sequence``. It should return a truthy value to indicate the element * passes the test, and a falsy value otherwise. * @param thisArg A value to use as ``this`` when executing ``predicate``. */ some(predicate: (value: any, index: number, array: any[]) => unknown, thisArg?: any): boolean; /** * See :js:meth:`Array.every`. Tests whether every element in the ``Sequence`` * passes the test implemented by the provided function. * @param predicate A function to execute for each element in the * ``Sequence``. It should return a truthy value to indicate the element * passes the test, and a falsy value otherwise. * @param thisArg A value to use as ``this`` when executing ``predicate``. */ every(predicate: (value: any, index: number, array: any[]) => unknown, thisArg?: any): boolean; /** * See :js:meth:`Array.reduce`. Executes a user-supplied "reducer" callback * function on each element of the Sequence, in order, passing in the return * value from the calculation on the preceding element. The final result of * running the reducer across all elements of the Sequence is a single value. * @param callbackfn A function to execute for each element in the ``Sequence``. Its * return value is discarded. */ reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any) => any, initialValue?: any): any; /** * See :js:meth:`Array.reduceRight`. Applies a function against an accumulator * and each value of the Sequence (from right to left) to reduce it to a * single value. * @param callbackfn A function to execute for each element in the Sequence. * Its return value is discarded. */ reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any) => any, initialValue: any): any; /** * See :js:meth:`Array.at`. Takes an integer value and returns the item at * that index. * @param index Zero-based index of the Sequence element to be returned, * converted to an integer. Negative index counts back from the end of the * Sequence. * @returns The element in the Sequence matching the given index. */ at(index: number): any; /** * The :js:meth:`Array.concat` method is used to merge two or more arrays. * This method does not change the existing arrays, but instead returns a new * array. * @param rest Arrays and/or values to concatenate into a new array. * @returns A new Array instance. */ concat(...rest: ConcatArray[]): any[]; /** * The :js:meth:`Array.includes` method determines whether a Sequence * includes a certain value among its entries, returning true or false as * appropriate. * @param elt * @returns */ includes(elt: any): any; /** * The :js:meth:`Array.entries` method returns a new iterator object that * contains the key/value pairs for each index in the ``Sequence``. * @returns A new iterator object. */ entries(): IterableIterator<[ number, any ]>; /** * The :js:meth:`Array.keys` method returns a new iterator object that * contains the keys for each index in the ``Sequence``. * @returns A new iterator object. */ keys(): IterableIterator; /** * The :js:meth:`Array.values` method returns a new iterator object that * contains the values for each index in the ``Sequence``. * @returns A new iterator object. */ values(): IterableIterator; /** * The :js:meth:`Array.find` method returns the first element in the provided * array that satisfies the provided testing function. * @param predicate A function to execute for each element in the * ``Sequence``. It should return a truthy value to indicate a matching * element has been found, and a falsy value otherwise. * @param thisArg A value to use as ``this`` when executing ``predicate``. * @returns The first element in the ``Sequence`` that satisfies the provided * testing function. */ find(predicate: (value: any, index: number, obj: any[]) => any, thisArg?: any): any; /** * The :js:meth:`Array.findIndex` method returns the index of the first * element in the provided array that satisfies the provided testing function. * @param predicate A function to execute for each element in the * ``Sequence``. It should return a truthy value to indicate a matching * element has been found, and a falsy value otherwise. * @param thisArg A value to use as ``this`` when executing ``predicate``. * @returns The index of the first element in the ``Sequence`` that satisfies * the provided testing function. */ findIndex(predicate: (value: any, index: number, obj: any[]) => any, thisArg?: any): number; toJSON(this: any): unknown[]; /** * Returns the object treated as a json adaptor. * * With a JsonAdaptor: * 1. property access / modification / deletion is implemented with * :meth:`~object.__getitem__`, :meth:`~object.__setitem__`, and * :meth:`~object.__delitem__` respectively. * 2. If an attribute is accessed and the result implements * :meth:`~object.__getitem__` then the result will also be a json * adaptor. * * For instance, ``JSON.stringify(proxy.asJsJson())`` acts like an * inverse to Python's :py:func:`json.loads`. */ asJsJson(): PyProxy & {}; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is an * :py:class:`~collections.abc.MutableSequence` (i.e., a :py:class:`list`) */ declare class PyMutableSequence extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyMutableSequence extends PyMutableSequenceMethods { } declare class PyMutableSequenceMethods { /** * The :js:meth:`Array.reverse` method reverses a :js:class:`PyMutableSequence` in * place. * @returns A reference to the same :js:class:`PyMutableSequence` */ reverse(): PyMutableSequence; /** * The :js:meth:`Array.sort` method sorts the elements of a * :js:class:`PyMutableSequence` in place. * @param compareFn A function that defines the sort order. * @returns A reference to the same :js:class:`PyMutableSequence` */ sort(compareFn?: (a: any, b: any) => number): PyMutableSequence; /** * The :js:meth:`Array.splice` method changes the contents of a * :js:class:`PyMutableSequence` by removing or replacing existing elements and/or * adding new elements in place. * @param start Zero-based index at which to start changing the * :js:class:`PyMutableSequence`. * @param deleteCount An integer indicating the number of elements in the * :js:class:`PyMutableSequence` to remove from ``start``. * @param items The elements to add to the :js:class:`PyMutableSequence`, beginning from * ``start``. * @returns An array containing the deleted elements. */ splice(start: number, deleteCount?: number, ...items: any[]): any[]; /** * The :js:meth:`Array.push` method adds the specified elements to the end of * a :js:class:`PyMutableSequence`. * @param elts The element(s) to add to the end of the :js:class:`PyMutableSequence`. * @returns The new length property of the object upon which the method was * called. */ push(...elts: any[]): any; /** * The :js:meth:`Array.pop` method removes the last element from a * :js:class:`PyMutableSequence`. * @returns The removed element from the :js:class:`PyMutableSequence`; undefined if the * :js:class:`PyMutableSequence` is empty. */ pop(): any; /** * The :js:meth:`Array.shift` method removes the first element from a * :js:class:`PyMutableSequence`. * @returns The removed element from the :js:class:`PyMutableSequence`; undefined if the * :js:class:`PyMutableSequence` is empty. */ shift(): any; /** * The :js:meth:`Array.unshift` method adds the specified elements to the * beginning of a :js:class:`PyMutableSequence`. * @param elts The elements to add to the front of the :js:class:`PyMutableSequence`. * @returns The new length of the :js:class:`PyMutableSequence`. */ unshift(...elts: any[]): any; /** * The :js:meth:`Array.copyWithin` method shallow copies part of a * :js:class:`PyMutableSequence` to another location in the same :js:class:`PyMutableSequence` * without modifying its length. * @param target Zero-based index at which to copy the sequence to. * @param start Zero-based index at which to start copying elements from. * @param end Zero-based index at which to end copying elements from. * @returns The modified :js:class:`PyMutableSequence`. */ copyWithin(target: number, start?: number, end?: number): any; /** * The :js:meth:`Array.fill` method changes all elements in an array to a * static value, from a start index to an end index. * @param value Value to fill the array with. * @param start Zero-based index at which to start filling. Default 0. * @param end Zero-based index at which to end filling. Default * ``list.length``. * @returns */ fill(value: any, start?: number, end?: number): any; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is :ref:`awaitable * ` (i.e., has an :meth:`~object.__await__` method). */ declare class PyAwaitable extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyAwaitable extends Promise { } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is * :std:term:`callable` (i.e., has an :py:meth:`~object.__call__` method). */ declare class PyCallable extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyCallable; } interface PyCallable extends PyCallableMethods { (...args: any[]): any; } declare class PyCallableMethods { /** * The ``apply()`` method calls the specified function with a given this * value, and arguments provided as an array (or an array-like object). Like * :js:meth:`Function.apply`. * * @param thisArg The ``this`` argument. Has no effect unless the * :js:class:`~pyodide.ffi.PyCallable` has :js:meth:`captureThis` set. If * :js:meth:`captureThis` is set, it will be passed as the first argument to * the Python function. * @param jsargs The array of arguments * @returns The result from the function call. */ apply(thisArg: any, jsargs: any): any; /** * Calls the function with a given this value and arguments provided * individually. See :js:meth:`Function.call`. * * @param thisArg The ``this`` argument. Has no effect unless the * :js:class:`~pyodide.ffi.PyCallable` has :js:meth:`captureThis` set. If * :js:meth:`captureThis` is set, it will be passed as the first argument to * the Python function. * @param jsargs The arguments * @returns The result from the function call. */ call(thisArg: any, ...jsargs: any): any; /** * Call the Python function. The first parameter controls various parameters * that change the way the call is performed. * * @param options * @param options.kwargs If true, the last argument is treated as a collection * of keyword arguments. * @param options.promising If true, the call is made with stack switching * enabled. Not needed if the callee is an async * Python function. * @param options.relaxed If true, extra arguments are ignored instead of * raising a :py:exc:`TypeError`. * @param jsargs Arguments to the Python function. * @returns */ callWithOptions({ relaxed, kwargs, promising, }: { relaxed?: boolean; kwargs?: boolean; promising?: boolean; }, ...jsargs: any): any; /** * Call the function with keyword arguments. The last argument must be an * object with the keyword arguments. */ callKwargs(...jsargs: any): any; /** * Call the function in a "relaxed" manner. Any extra arguments will be * ignored. This matches the behavior of JavaScript functions more accurately. * * Any extra arguments will be ignored. This matches the behavior of * JavaScript functions more accurately. Missing arguments are **NOT** filled * with `None`. If too few arguments are passed, this will still raise a * TypeError. * * This uses :py:func:`pyodide.code.relaxed_call`. */ callRelaxed(...jsargs: any): any; /** * Call the function with keyword arguments in a "relaxed" manner. The last * argument must be an object with the keyword arguments. Any extra arguments * will be ignored. This matches the behavior of JavaScript functions more * accurately. * * Missing arguments are **NOT** filled with ``None``. If too few arguments are * passed, this will still raise a :py:exc:`TypeError`. Also, if the same argument is * passed as both a keyword argument and a positional argument, it will raise * an error. * * This uses :py:func:`pyodide.code.relaxed_call`. */ callKwargsRelaxed(...jsargs: any): any; /** * Call the function with stack switching enabled. The last argument must be * an object with the keyword arguments. Functions called this way can use * :py:meth:`~pyodide.ffi.run_sync` to block until an * :py:class:`~collections.abc.Awaitable` is resolved. Only works in runtimes * with JS Promise integration. * * .. admonition:: Experimental * :class: warning * * This feature is not yet stable. * * @experimental */ callPromising(...jsargs: any): Promise; /** * Call the function with stack switching enabled. The last argument must be * an object with the keyword arguments. Functions called this way can use * :py:meth:`~pyodide.ffi.run_sync` to block until an * :py:class:`~collections.abc.Awaitable` is resolved. Only works in runtimes * with JS Promise integration. * * .. admonition:: Experimental * :class: warning * * This feature is not yet stable. * * @experimental */ callPromisingKwargs(...jsargs: any): Promise; /** * The ``bind()`` method creates a new function that, when called, has its * ``this`` keyword set to the provided value, with a given sequence of * arguments preceding any provided when the new function is called. See * :js:meth:`Function.bind`. * * If the :js:class:`~pyodide.ffi.PyCallable` does not have * :js:meth:`captureThis` set, the ``this`` parameter will be discarded. If it * does have :js:meth:`captureThis` set, ``thisArg`` will be set to the first * argument of the Python function. The returned proxy and the original proxy * have the same lifetime so destroying either destroys both. * * @param thisArg The value to be passed as the ``this`` parameter to the * target function ``func`` when the bound function is called. * @param jsargs Extra arguments to prepend to arguments provided to the bound * function when invoking ``func``. * @returns */ bind(thisArg: any, ...jsargs: any): PyProxy; /** * Returns a :js:class:`~pyodide.ffi.PyProxy` that passes ``this`` as the first argument to the * Python function. The returned :js:class:`~pyodide.ffi.PyProxy` has the internal ``captureThis`` * property set. * * It can then be used as a method on a JavaScript object. The returned proxy * and the original proxy have the same lifetime so destroying either destroys * both. * * For example: * * .. code-block:: pyodide * * let obj = { a : 7 }; * pyodide.runPython(` * def f(self): * return self.a * `); * // Without captureThis, it doesn't work to use f as a method for obj: * obj.f = pyodide.globals.get("f"); * obj.f(); // raises "TypeError: f() missing 1 required positional argument: 'self'" * // With captureThis, it works fine: * obj.f = pyodide.globals.get("f").captureThis(); * obj.f(); // returns 7 * * @returns The resulting :js:class:`~pyodide.ffi.PyProxy`. It has the same lifetime as the * original :js:class:`~pyodide.ffi.PyProxy` but passes ``this`` to the wrapped function. * */ captureThis(): PyProxy; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object supports the * Python :external:doc:`c-api/buffer`. * * Examples of buffers include {py:class}`bytes` objects and numpy * {external+numpy:ref}`arrays`. */ declare class PyBuffer extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyBuffer; } interface PyBuffer extends PyBufferMethods { } declare class PyBufferMethods { /** * Get a view of the buffer data which is usable from JavaScript. No copy is * ever performed. * * We do not support suboffsets, if the buffer requires suboffsets we will * throw an error. JavaScript nd array libraries can't handle suboffsets * anyways. In this case, you should use the :js:meth:`~PyProxy.toJs` api or * copy the buffer to one that doesn't use suboffsets (using e.g., * :py:func:`numpy.ascontiguousarray`). * * If the buffer stores big endian data or half floats, this function will * fail without an explicit type argument. For big endian data you can use * :js:meth:`~PyProxy.toJs`. :js:class:`DataView` has support for big endian * data, so you might want to pass ``'dataview'`` as the type argument in that * case. * * @param type The type of the :js:attr:`~pyodide.ffi.PyBufferView.data` field * in the output. Should be one of: ``"i8"``, ``"u8"``, ``"u8clamped"``, * ``"i16"``, ``"u16"``, ``"i32"``, ``"u32"``, ``"i32"``, ``"u32"``, * ``"i64"``, ``"u64"``, ``"f32"``, ``"f64"``, or ``"dataview"``. This argument * is optional, if absent :js:meth:`~pyodide.ffi.PyBuffer.getBuffer` will try * to determine the appropriate output type based on the buffer format string * (see :std:ref:`struct-format-strings`). */ getBuffer(type?: string): PyBufferView; } /** * A :js:class:`~pyodide.ffi.PyProxy` whose proxied Python object is a :py:class:`dict`. */ declare class PyDict extends PyProxy { /** @private */ static [Symbol.hasInstance](obj: any): obj is PyProxy; } interface PyDict extends PyProxyWithGet, PyProxyWithSet, PyProxyWithHas, PyProxyWithLength, PyIterable { } /** * A class to allow access to Python data buffers from JavaScript. These are * produced by :js:meth:`~pyodide.ffi.PyBuffer.getBuffer` and cannot be constructed directly. * When you are done, release it with the :js:func:`~PyBufferView.release` method. * See the Python :external:doc:`c-api/buffer` documentation for more * information. * * To find the element ``x[a_1, ..., a_n]``, you could use the following code: * * .. code-block:: js * * function multiIndexToIndex(pybuff, multiIndex) { * if (multindex.length !== pybuff.ndim) { * throw new Error("Wrong length index"); * } * let idx = pybuff.offset; * for (let i = 0; i < pybuff.ndim; i++) { * if (multiIndex[i] < 0) { * multiIndex[i] = pybuff.shape[i] - multiIndex[i]; * } * if (multiIndex[i] < 0 || multiIndex[i] >= pybuff.shape[i]) { * throw new Error("Index out of range"); * } * idx += multiIndex[i] * pybuff.stride[i]; * } * return idx; * } * console.log("entry is", pybuff.data[multiIndexToIndex(pybuff, [2, 0, -1])]); * * .. admonition:: Converting between TypedArray types * :class: warning * * The following naive code to change the type of a typed array does not * work: * * .. code-block:: js * * // Incorrectly convert a TypedArray. * // Produces a Uint16Array that points to the entire WASM memory! * let myarray = new Uint16Array(buffer.data.buffer); * * Instead, if you want to convert the output TypedArray, you need to say: * * .. code-block:: js * * // Correctly convert a TypedArray. * let myarray = new Uint16Array( * buffer.data.buffer, * buffer.data.byteOffset, * buffer.data.byteLength * ); */ declare class PyBufferView { /** * The offset of the first entry of the array. For instance if our array * is 3d, then you will find ``array[0,0,0]`` at * ``pybuf.data[pybuf.offset]`` */ offset: number; /** * If the data is read only, you should not modify it. There is no way for us * to enforce this, but it may cause very weird behavior. See * :py:attr:`memoryview.readonly`. */ readonly: boolean; /** * The format string for the buffer. See :ref:`struct-format-strings` * and :py:attr:`memoryview.format`. */ format: string; /** * How large is each entry in bytes? See :py:attr:`memoryview.itemsize`. */ itemsize: number; /** * The number of dimensions of the buffer. If ``ndim`` is 0, the buffer * represents a single scalar or struct. Otherwise, it represents an * array. See :py:attr:`memoryview.ndim`. */ ndim: number; /** * The total number of bytes the buffer takes up. This is equal to * :js:attr:`buff.data.byteLength `. See * :py:attr:`memoryview.nbytes`. */ nbytes: number; /** * The shape of the buffer, that is how long it is in each dimension. * The length will be equal to ``ndim``. For instance, a 2x3x4 array * would have shape ``[2, 3, 4]``. See :py:attr:`memoryview.shape`. */ shape: number[]; /** * An array of of length ``ndim`` giving the number of elements to skip * to get to a new element in each dimension. See the example definition * of a ``multiIndexToIndex`` function above. See :py:attr:`memoryview.strides`. */ strides: number[]; /** * The actual data. A typed array of an appropriate size backed by a segment * of the WASM memory. * * The ``type`` argument of :js:meth:`~pyodide.ffi.PyBuffer.getBuffer` determines * which sort of :js:class:`TypedArray` or :js:class:`DataView` to return. By * default :js:meth:`~pyodide.ffi.PyBuffer.getBuffer` will look at the format string * to determine the most appropriate option. Most often the result is a * :js:class:`Uint8Array`. * * .. admonition:: Contiguity * :class: warning * * If the buffer is not contiguous, the :js:attr:`~PyBufferView.readonly` * TypedArray will contain data that is not part of the buffer. Modifying * this data leads to undefined behavior. * * .. admonition:: Read only buffers * :class: warning * * If :js:attr:`buffer.readonly ` is ``true``, you * should not modify the buffer. Modifying a read only buffer leads to * undefined behavior. * */ data: TypedArray; /** * Is it C contiguous? See :py:attr:`memoryview.c_contiguous`. */ c_contiguous: boolean; /** * Is it Fortran contiguous? See :py:attr:`memoryview.f_contiguous`. */ f_contiguous: boolean; /** * @private */ _released: boolean; /** * @private */ _view_ptr: number; /** @private */ constructor(); /** * Release the buffer. This allows the memory to be reclaimed. */ release(): void; } /** * A JavaScript error caused by a Python exception. * * In order to reduce the risk of large memory leaks, the :js:class:`PythonError` * contains no reference to the Python exception that caused it. You can find * the actual Python exception that caused this error as * :py:data:`sys.last_exc`. * * See :ref:`type translations of errors ` for more * information. * * .. admonition:: Avoid leaking stack Frames * :class: warning * * If you make a :js:class:`~pyodide.ffi.PyProxy` of * :py:data:`sys.last_exc`, you should be especially careful to * :js:meth:`~pyodide.ffi.PyProxy.destroy` it when you are done. You may leak a large * amount of memory including the local variables of all the stack frames in * the traceback if you don't. The easiest way is to only handle the * exception in Python. * * @hideconstructor */ declare class PythonError extends Error { /** * The address of the error we are wrapping. We may later compare this * against sys.last_exc. * WARNING: we don't own a reference to this pointer, dereferencing it * may be a use-after-free error! * @private */ __error_address: number; /** * The name of the Python error class, e.g, :py:exc:`RuntimeError` or * :py:exc:`KeyError`. */ type: string; constructor(type: string, message: string, error_address: number); } /** * See :ref:`js-api-pyodide-ffi` * @hidetype */ declare const ffi: { PyProxy: typeof PyProxy; PyProxyWithLength: typeof PyProxyWithLength; PyProxyWithGet: typeof PyProxyWithGet; PyProxyWithSet: typeof PyProxyWithSet; PyProxyWithHas: typeof PyProxyWithHas; PyDict: typeof PyDict; PyIterable: typeof PyIterable; PyAsyncIterable: typeof PyAsyncIterable; PyIterator: typeof PyIterator; PyAsyncIterator: typeof PyAsyncIterator; PyGenerator: typeof PyGenerator; PyAsyncGenerator: typeof PyAsyncGenerator; PyAwaitable: typeof PyAwaitable; PyCallable: typeof PyCallable; PyBuffer: typeof PyBuffer; PyBufferView: typeof PyBufferView; PythonError: typeof PythonError; PySequence: typeof PySequence; PyMutableSequence: typeof PyMutableSequence; }; export type {}; export type {PyAsyncGenerator, PyAsyncIterable, PyAsyncIterator, PyAwaitable, PyBuffer, PyBufferView, PyCallable, PyDict, PyGenerator, PyIterable, PyIterator, PyMutableSequence, PyProxy, PyProxyWithGet, PyProxyWithHas, PyProxyWithLength, PyProxyWithSet, PySequence, PythonError};