pyodide 0.20.0 → 0.21.0-alpha.1

package/pyproxy.gen.ts

@@ -1,1507 +0,0 @@
-// This file is generated by applying the C preprocessor to core/pyproxy.ts
-// It uses the macros defined in core/pyproxy.c
-// Do not edit it directly!
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-/**
- * Every public Python entrypoint goes through this file! The main entrypoint is
- * the callPyObject method, but of course one can also execute arbitrary code
- * via the various __dundermethods__ associated to classes.
- *
- * Any time we call into wasm, the call should be wrapped in a try catch block.
- * This way if a JavaScript error emerges from the wasm, we can escalate it to a
- * fatal error.
- *
- * This is file is preprocessed with -imacros "pyproxy.c". As a result of this,
- * any macros available in pyproxy.c are available here. We only need the flags
- * macros HAS_LENGTH, etc.
- *
- * See Makefile recipe for src/js/pyproxy.gen.ts
- */
-import { Module, API, Hiwire } from "./module.js";
-/**
- * Is the argument a :any:`PyProxy`?
- * @param jsobj Object to test.
- * @returns Is ``jsobj`` a :any:`PyProxy`?
- */
-export function isPyProxy(jsobj: any): jsobj is PyProxy {
-  return !!jsobj && jsobj.$$ !== undefined && jsobj.$$.type === "PyProxy";
-}
-API.isPyProxy = isPyProxy;
-declare var FinalizationRegistry: any;
-declare var globalThis: any;
-if (globalThis.FinalizationRegistry) {
-  Module.finalizationRegistry = new FinalizationRegistry(
-    ([ptr, cache]: [ptr: number, cache: PyProxyCache]) => {
-      cache.leaked = (!!1);
-      pyproxy_decref_cache(cache);
-      try {
-        Module._Py_DecRef(ptr);
-      } catch (e) {
-        // I'm not really sure what happens if an error occurs inside of a
-        // finalizer...
-        API.fatal_error(e);
-      }
-    }
-  );
-  // For some unclear reason this code screws up selenium FirefoxDriver. Works
-  // fine in chrome and when I test it in browser. It seems to be sensitive to
-  // changes that don't make a difference to the semantics.
-  // TODO: after 0.18.0, fix selenium issues with this code.
-  // Module.bufferFinalizationRegistry = new FinalizationRegistry((ptr) => {
-  //   try {
-  //     Module._PyBuffer_Release(ptr);
-  //     Module._PyMem_Free(ptr);
-  //   } catch (e) {
-  //     API.fatal_error(e);
-  //   }
-  // });
-} else {
-  Module.finalizationRegistry = { register() {}, unregister() {} };
-  // Module.bufferFinalizationRegistry = finalizationRegistry;
-}
-let pyproxy_alloc_map = new Map();
-Module.pyproxy_alloc_map = pyproxy_alloc_map;
-let trace_pyproxy_alloc: (proxy: any) => void;
-let trace_pyproxy_dealloc: (proxy: any) => void;
-Module.enable_pyproxy_allocation_tracing = function () {
-  trace_pyproxy_alloc = function (proxy: any) {
-    pyproxy_alloc_map.set(proxy, Error().stack);
-  };
-  trace_pyproxy_dealloc = function (proxy: any) {
-    pyproxy_alloc_map.delete(proxy);
-  };
-};
-Module.disable_pyproxy_allocation_tracing = function () {
-  trace_pyproxy_alloc = function (proxy: any) {};
-  trace_pyproxy_dealloc = function (proxy: any) {};
-};
-Module.disable_pyproxy_allocation_tracing();
-type PyProxyCache = { cacheId: number; refcnt: number; leaked?: boolean };
-/**
- * Create a new PyProxy wrapping ptrobj which is a PyObject*.
- *
- * The argument cache is only needed to implement the PyProxy.copy API, it
- * allows the copy of the PyProxy to share its attribute cache with the original
- * version. In all other cases, pyproxy_new should be called with one argument.
- *
- * In the case that the Python object is callable, PyProxyClass inherits from
- * Function so that PyProxy objects can be callable. In that case we MUST expose
- * certain properties inherited from Function, but we do our best to remove as
- * many as possible.
- * @private
- */
-Module.pyproxy_new = function (ptrobj: number, cache?: PyProxyCache) {
-  let flags = Module._pyproxy_getflags(ptrobj);
-  let cls = Module.getPyProxyClass(flags);
-  // Reflect.construct calls the constructor of Module.PyProxyClass but sets
-  // the prototype as cls.prototype. This gives us a way to dynamically create
-  // subclasses of PyProxyClass (as long as we don't need to use the "new
-  // cls(ptrobj)" syntax).
-  let target;
-  if (flags & (1 << 8)) {
-    // To make a callable proxy, we must call the Function constructor.
-    // In this case we are effectively subclassing Function.
-    target = Reflect.construct(Function, [], cls);
-    // Remove undesirable properties added by Function constructor. Note: we
-    // can't remove "arguments" or "caller" because they are not configurable
-    // and not writable
-    delete target.length;
-    delete target.name;
-    // prototype isn't configurable so we can't delete it but it's writable.
-    target.prototype = undefined;
-  } else {
-    target = Object.create(cls.prototype);
-  }
-  if (!cache) {
-    // The cache needs to be accessed primarily from the C function
-    // _pyproxy_getattr so we make a hiwire id.
-    let cacheId = Hiwire.new_value(new Map());
-    cache = { cacheId, refcnt: 0 };
-  }
-  cache.refcnt++;
-  Object.defineProperty(target, "$$", {
-    value: { ptr: ptrobj, type: "PyProxy", cache },
-  });
-  Module._Py_IncRef(ptrobj);
-  let proxy = new Proxy(target, PyProxyHandlers);
-  trace_pyproxy_alloc(proxy);
-  Module.finalizationRegistry.register(proxy, [ptrobj, cache], proxy);
-  return proxy;
-};
-function _getPtr(jsobj: any) {
-  let ptr: number = jsobj.$$.ptr;
-  if (ptr === 0) {
-    throw new Error(jsobj.$$.destroyed_msg);
-  }
-  return ptr;
-}
-let pyproxyClassMap = new Map();
-/**
- * Retrieve the appropriate mixins based on the features requested in flags.
- * Used by pyproxy_new. The "flags" variable is produced by the C function
- * pyproxy_getflags. Multiple PyProxies with the same set of feature flags
- * will share the same prototype, so the memory footprint of each individual
- * PyProxy is minimal.
- * @private
- */
-Module.getPyProxyClass = function (flags: number) {
-  const FLAG_TYPE_PAIRS: [number, any][] = [
-    [(1 << 0), PyProxyLengthMethods],
-    [(1 << 1), PyProxyGetItemMethods],
-    [(1 << 2), PyProxySetItemMethods],
-    [(1 << 3), PyProxyContainsMethods],
-    [(1 << 4), PyProxyIterableMethods],
-    [(1 << 5), PyProxyIteratorMethods],
-    [(1 << 6), PyProxyAwaitableMethods],
-    [(1 << 7), PyProxyBufferMethods],
-    [(1 << 8), PyProxyCallableMethods],
-  ];
-  let result = pyproxyClassMap.get(flags);
-  if (result) {
-    return result;
-  }
-  let descriptors: any = {};
-  for (let [feature_flag, methods] of FLAG_TYPE_PAIRS) {
-    if (flags & feature_flag) {
-      Object.assign(
-        descriptors,
-        Object.getOwnPropertyDescriptors(methods.prototype)
-      );
-    }
-  }
-  // Use base constructor (just throws an error if construction is attempted).
-  descriptors.constructor = Object.getOwnPropertyDescriptor(
-    PyProxyClass.prototype,
-    "constructor"
-  );
-  Object.assign(
-    descriptors,
-    Object.getOwnPropertyDescriptors({ $$flags: flags })
-  );
-  let new_proto = Object.create(PyProxyClass.prototype, descriptors);
-  function NewPyProxyClass() {}
-  NewPyProxyClass.prototype = new_proto;
-  pyproxyClassMap.set(flags, NewPyProxyClass);
-  return NewPyProxyClass;
-};
-// Static methods
-Module.PyProxy_getPtr = _getPtr;
-const pyproxy_cache_destroyed_msg =
-  "This borrowed attribute proxy was automatically destroyed in the " +
-  "process of destroying the proxy it was borrowed from. Try using the 'copy' method.";
-function pyproxy_decref_cache(cache: PyProxyCache) {
-  if (!cache) {
-    return;
-  }
-  cache.refcnt--;
-  if (cache.refcnt === 0) {
-    let cache_map = Hiwire.pop_value(cache.cacheId);
-    for (let proxy_id of cache_map.values()) {
-      const cache_entry = Hiwire.pop_value(proxy_id);
-      if (!cache.leaked) {
-        Module.pyproxy_destroy(cache_entry, pyproxy_cache_destroyed_msg);
-      }
-    }
-  }
-}
-Module.pyproxy_destroy = function (proxy: PyProxy, destroyed_msg: string) {
-  if (proxy.$$.ptr === 0) {
-    return;
-  }
-  let ptrobj = _getPtr(proxy);
-  Module.finalizationRegistry.unregister(proxy);
-  destroyed_msg = destroyed_msg || "Object has already been destroyed";
-  let proxy_type = proxy.type;
-  let proxy_repr;
-  try {
-    proxy_repr = proxy.toString();
-  } catch (e) {
-    if (e.pyodide_fatal_error) {
-      throw e;
-    }
-  }
-  // Maybe the destructor will call JavaScript code that will somehow try
-  // to use this proxy. Mark it deleted before decrementing reference count
-  // just in case!
-  proxy.$$.ptr = 0;
-  destroyed_msg += "\n" + `The object was of type "${proxy_type}" and `;
-  if (proxy_repr) {
-    destroyed_msg += `had repr "${proxy_repr}"`;
-  } else {
-    destroyed_msg += "an error was raised when trying to generate its repr";
-  }
-  proxy.$$.destroyed_msg = destroyed_msg;
-  pyproxy_decref_cache(proxy.$$.cache);
-  try {
-    Module._Py_DecRef(ptrobj);
-    trace_pyproxy_dealloc(proxy);
-  } catch (e) {
-    API.fatal_error(e);
-  }
-};
-// Now a lot of boilerplate to wrap the abstract Object protocol wrappers
-// defined in pyproxy.c in JavaScript functions.
-Module.callPyObjectKwargs = function (ptrobj: number, ...jsargs: any) {
-  // We don't do any checking for kwargs, checks are in PyProxy.callKwargs
-  // which only is used when the keyword arguments come from the user.
-  let kwargs = jsargs.pop();
-  let num_pos_args = jsargs.length;
-  let kwargs_names = Object.keys(kwargs);
-  let kwargs_values = Object.values(kwargs);
-  let num_kwargs = kwargs_names.length;
-  jsargs.push(...kwargs_values);
-  let idargs = Hiwire.new_value(jsargs);
-  let idkwnames = Hiwire.new_value(kwargs_names);
-  let idresult;
-  try {
-    idresult = Module.__pyproxy_apply(
-      ptrobj,
-      idargs,
-      num_pos_args,
-      idkwnames,
-      num_kwargs
-    );
-  } catch (e) {
-    API.fatal_error(e);
-  } finally {
-    Hiwire.decref(idargs);
-    Hiwire.decref(idkwnames);
-  }
-  if (idresult === 0) {
-    Module._pythonexc2js();
-  }
-  let result = Hiwire.pop_value(idresult);
-  // Automatically schedule coroutines
-  if (result && result.type === "coroutine" && result._ensure_future) {
-    result._ensure_future();
-  }
-  return result;
-};
-Module.callPyObject = function (ptrobj: number, ...jsargs: any) {
-  return Module.callPyObjectKwargs(ptrobj, ...jsargs, {});
-};
-export type PyProxy = PyProxyClass & { [x: string]: any };
-export class PyProxyClass {
-  $$: { ptr: number; cache: PyProxyCache; destroyed_msg?: string };
-  $$flags: number;
-  /** @private */
-  constructor() {
-    throw new TypeError("PyProxy is not a constructor");
-  }
-  get [Symbol.toStringTag]() {
-    return "PyProxy";
-  }
-  /**
-   * 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 {
-    let ptrobj = _getPtr(this);
-    return Hiwire.pop_value(Module.__pyproxy_type(ptrobj));
-  }
-  toString(): string {
-    let ptrobj = _getPtr(this);
-    let jsref_repr;
-    try {
-      jsref_repr = Module.__pyproxy_repr(ptrobj);
-    } catch (e) {
-      API.fatal_error(e);
-    }
-    if (jsref_repr === 0) {
-      Module._pythonexc2js();
-    }
-    return Hiwire.pop_value(jsref_repr);
-  }
-  /**
-   * Destroy the ``PyProxy``. This will release the memory. Any further attempt
-   * to use the object will raise an error.
-   *
-   * In a browser supporting `FinalizationRegistry
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry>`_
-   * Pyodide will automatically destroy the ``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 destroyed_msg The error message to print if use is attempted after
-   *        destroying. Defaults to "Object has already been destroyed".
-   */
-  destroy(destroyed_msg?: string) {
-    Module.pyproxy_destroy(this, destroyed_msg);
-  }
-  /**
-   * Make a new PyProxy pointing to the same Python object.
-   * Useful if the PyProxy is destroyed somewhere else.
-   */
-  copy(): PyProxy {
-    let ptrobj = _getPtr(this);
-    return Module.pyproxy_new(ptrobj, this.$$.cache);
-  }
-  /**
-   * Converts the ``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
-   * <type-translations-pyproxy-to-js>` for more info.
-   * @param options
-   * @return The JavaScript object resulting from the conversion.
-   */
-  toJs({
-    depth = -1,
-    pyproxies = undefined,
-    create_pyproxies = (!!1),
-    dict_converter = undefined,
-    default_converter = undefined,
-  }: {
-    /** How many layers deep to perform the conversion. Defaults to infinite */
-    depth?: number;
-    /**
-     * If provided, ``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, ``toJs`` will throw a ``ConversionError`` rather than
-     * producing a ``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,
-     * ``Object.fromEntries`` would convert the dict to an object, ``Array.from``
-     * converts it to an array of entries, and ``(it) => new Map(it)`` converts
-     * it to a ``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 :any:`pyodide.to_js`.
-     */
-    default_converter?: (
-      obj: PyProxy,
-      convert: (obj: PyProxy) => any,
-      cacheConversion: (obj: PyProxy, result: any) => void
-    ) => any;
-  } = {}): any {
-    let ptrobj = _getPtr(this);
-    let idresult;
-    let proxies_id;
-    let dict_converter_id = 0;
-    let default_converter_id = 0;
-    if (!create_pyproxies) {
-      proxies_id = 0;
-    } else if (pyproxies) {
-      proxies_id = Hiwire.new_value(pyproxies);
-    } else {
-      proxies_id = Hiwire.new_value([]);
-    }
-    if (dict_converter) {
-      dict_converter_id = Hiwire.new_value(dict_converter);
-    }
-    if (default_converter) {
-      default_converter_id = Hiwire.new_value(default_converter);
-    }
-    try {
-      idresult = Module._python2js_custom(
-        ptrobj,
-        depth,
-        proxies_id,
-        dict_converter_id,
-        default_converter_id
-      );
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(proxies_id);
-      Hiwire.decref(dict_converter_id);
-      Hiwire.decref(default_converter_id);
-    }
-    if (idresult === 0) {
-      Module._pythonexc2js();
-    }
-    return Hiwire.pop_value(idresult);
-  }
-  /**
-   * Check whether the :any:`PyProxy.length` getter is available on this PyProxy. A
-   * Typescript type guard.
-   */
-  supportsLength(): this is PyProxyWithLength {
-    return !!(this.$$flags & (1 << 0));
-  }
-  /**
-   * Check whether the :any:`PyProxy.get` method is available on this PyProxy. A
-   * Typescript type guard.
-   */
-  supportsGet(): this is PyProxyWithGet {
-    return !!(this.$$flags & (1 << 1));
-  }
-  /**
-   * Check whether the :any:`PyProxy.set` method is available on this PyProxy. A
-   * Typescript type guard.
-   */
-  supportsSet(): this is PyProxyWithSet {
-    return !!(this.$$flags & (1 << 2));
-  }
-  /**
-   * Check whether the :any:`PyProxy.has` method is available on this PyProxy. A
-   * Typescript type guard.
-   */
-  supportsHas(): this is PyProxyWithHas {
-    return !!(this.$$flags & (1 << 3));
-  }
-  /**
-   * Check whether the PyProxy is iterable. A Typescript type guard for
-   * :any:`PyProxy.[iterator]`.
-   */
-  isIterable(): this is PyProxyIterable {
-    return !!(this.$$flags & ((1 << 4) | (1 << 5)));
-  }
-  /**
-   * Check whether the PyProxy is iterable. A Typescript type guard for
-   * :any:`PyProxy.next`.
-   */
-  isIterator(): this is PyProxyIterator {
-    return !!(this.$$flags & (1 << 5));
-  }
-  /**
-   * Check whether the PyProxy is awaitable. A Typescript type guard, if this
-   * function returns true Typescript considers the PyProxy to be a ``Promise``.
-   */
-  isAwaitable(): this is PyProxyAwaitable {
-    return !!(this.$$flags & (1 << 6));
-  }
-  /**
-   * Check whether the PyProxy is a buffer. A Typescript type guard for
-   * :any:`PyProxy.getBuffer`.
-   */
-  isBuffer(): this is PyProxyBuffer {
-    return !!(this.$$flags & (1 << 7));
-  }
-  /**
-   * Check whether the PyProxy is a Callable. A Typescript type guard, if this
-   * returns true then Typescript considers the Proxy to be callable of
-   * signature ``(args... : any[]) => PyProxy | number | bigint | string |
-   * boolean | undefined``.
-   */
-  isCallable(): this is PyProxyCallable {
-    return !!(this.$$flags & (1 << 8));
-  }
-}
-export type PyProxyWithLength = PyProxy & PyProxyLengthMethods;
-// Controlled by HAS_LENGTH, appears for any object with __len__ or sq_length
-// or mp_length methods
-export class PyProxyLengthMethods {
-  /**
-   * The length of the object.
-   *
-   * Present only if the proxied Python object has a ``__len__`` method.
-   */
-  get length(): number {
-    let ptrobj = _getPtr(this);
-    let length;
-    try {
-      length = Module._PyObject_Size(ptrobj);
-    } catch (e) {
-      API.fatal_error(e);
-    }
-    if (length === -1) {
-      Module._pythonexc2js();
-    }
-    return length;
-  }
-}
-export type PyProxyWithGet = PyProxy & PyProxyGetItemMethods;
-// Controlled by HAS_GET, appears for any class with __getitem__,
-// mp_subscript, or sq_item methods
-export class PyProxyGetItemMethods {
-  /**
-   * This translates to the Python code ``obj[key]``.
-   *
-   * Present only if the proxied Python object has a ``__getitem__`` method.
-   *
-   * @param key The key to look up.
-   * @returns The corresponding value.
-   */
-  get(key: any): any {
-    let ptrobj = _getPtr(this);
-    let idkey = Hiwire.new_value(key);
-    let idresult;
-    try {
-      idresult = Module.__pyproxy_getitem(ptrobj, idkey);
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(idkey);
-    }
-    if (idresult === 0) {
-      if (Module._PyErr_Occurred()) {
-        Module._pythonexc2js();
-      } else {
-        return undefined;
-      }
-    }
-    return Hiwire.pop_value(idresult);
-  }
-}
-export type PyProxyWithSet = PyProxy & PyProxySetItemMethods;
-// Controlled by HAS_SET, appears for any class with __setitem__, __delitem__,
-// mp_ass_subscript,  or sq_ass_item.
-export class PyProxySetItemMethods {
-  /**
-   * This translates to the Python code ``obj[key] = value``.
-   *
-   * Present only if the proxied Python object has a ``__setitem__`` method.
-   *
-   * @param key The key to set.
-   * @param value The value to set it to.
-   */
-  set(key: any, value: any) {
-    let ptrobj = _getPtr(this);
-    let idkey = Hiwire.new_value(key);
-    let idval = Hiwire.new_value(value);
-    let errcode;
-    try {
-      errcode = Module.__pyproxy_setitem(ptrobj, idkey, idval);
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(idkey);
-      Hiwire.decref(idval);
-    }
-    if (errcode === -1) {
-      Module._pythonexc2js();
-    }
-  }
-  /**
-   * This translates to the Python code ``del obj[key]``.
-   *
-   * Present only if the proxied Python object has a ``__delitem__`` method.
-   *
-   * @param key The key to delete.
-   */
-  delete(key: any) {
-    let ptrobj = _getPtr(this);
-    let idkey = Hiwire.new_value(key);
-    let errcode;
-    try {
-      errcode = Module.__pyproxy_delitem(ptrobj, idkey);
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(idkey);
-    }
-    if (errcode === -1) {
-      Module._pythonexc2js();
-    }
-  }
-}
-export type PyProxyWithHas = PyProxy & PyProxyContainsMethods;
-// Controlled by HAS_CONTAINS flag, appears for any class with __contains__ or
-// sq_contains
-export class PyProxyContainsMethods {
-  /**
-   * This translates to the Python code ``key in obj``.
-   *
-   * Present only if the proxied Python object has a ``__contains__`` method.
-   *
-   * @param key The key to check for.
-   * @returns Is ``key`` present?
-   */
-  has(key: any): boolean {
-    let ptrobj = _getPtr(this);
-    let idkey = Hiwire.new_value(key);
-    let result;
-    try {
-      result = Module.__pyproxy_contains(ptrobj, idkey);
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(idkey);
-    }
-    if (result === -1) {
-      Module._pythonexc2js();
-    }
-    return result === 1;
-  }
-}
-/**
- * A helper for [Symbol.iterator].
- *
- * Because "it is possible for a generator to be garbage collected without
- * ever running its finally block", we take extra care to try to ensure that
- * we don't leak the iterator. We register it with the finalizationRegistry,
- * but if the finally block is executed, we decref the pointer and unregister.
- *
- * In order to do this, we create the generator with this inner method,
- * register the finalizer, and then return it.
- *
- * Quote from:
- * https://hacks.mozilla.org/2015/07/es6-in-depth-generators-continued/
- *
- * @private
- */
-function* iter_helper(iterptr: number, token: {}): Generator<any> {
-  try {
-    let item;
-    while ((item = Module.__pyproxy_iter_next(iterptr))) {
-      yield Hiwire.pop_value(item);
-    }
-  } catch (e) {
-    API.fatal_error(e);
-  } finally {
-    Module.finalizationRegistry.unregister(token);
-    Module._Py_DecRef(iterptr);
-  }
-  if (Module._PyErr_Occurred()) {
-    Module._pythonexc2js();
-  }
-}
-export type PyProxyIterable = PyProxy & PyProxyIterableMethods;
-// Controlled by IS_ITERABLE, appears for any object with __iter__ or tp_iter,
-// unless they are iterators. See: https://docs.python.org/3/c-api/iter.html
-// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-// This avoids allocating a PyProxy wrapper for the temporary iterator.
-export class PyProxyIterableMethods {
-  /**
-   * This translates to the Python code ``iter(obj)``. Return an iterator
-   * associated to the proxy. See the documentation for `Symbol.iterator
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator>`_.
-   *
-   * Present only if the proxied Python object is iterable (i.e., has an
-   * ``__iter__`` method).
-   *
-   * This will be used implicitly by ``for(let x of proxy){}``.
-   */
-  [Symbol.iterator](): Iterator<any, any, any> {
-    let ptrobj = _getPtr(this);
-    let token = {};
-    let iterptr;
-    try {
-      iterptr = Module._PyObject_GetIter(ptrobj);
-    } catch (e) {
-      API.fatal_error(e);
-    }
-    if (iterptr === 0) {
-      Module._pythonexc2js();
-    }
-    let result = iter_helper(iterptr, token);
-    Module.finalizationRegistry.register(result, [iterptr, undefined], token);
-    return result;
-  }
-}
-export type PyProxyIterator = PyProxy & PyProxyIteratorMethods;
-// Controlled by IS_ITERATOR, appears for any object with a __next__ or
-// tp_iternext method.
-export class PyProxyIteratorMethods {
-  /** @private */
-  [Symbol.iterator]() {
-    return this;
-  }
-  /**
-   * This translates to the Python code ``next(obj)``. Returns the next value of
-   * the generator. See the documentation for `Generator.prototype.next
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator/next>`_.
-   * The argument will be sent to the Python generator.
-   *
-   * This will be used implicitly by ``for(let x of proxy){}``.
-   *
-   * Present only if the proxied Python object is a generator or iterator (i.e.,
-   * has a ``send`` or ``__next__`` method).
-   *
-   * @param any 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 ``StopIteration(result_value)``
-   * exception, ``next`` returns ``{done : true, value : result_value}``.
-   */
-  next(arg: any = undefined): IteratorResult<any, any> {
-    // Note: arg is optional, if arg is not supplied, it will be undefined
-    // which gets converted to "Py_None". This is as intended.
-    let idarg = Hiwire.new_value(arg);
-    let status;
-    let done;
-    let stackTop = Module.stackSave();
-    let res_ptr = Module.stackAlloc(4);
-    try {
-      status = Module.__pyproxyGen_Send(_getPtr(this), idarg, res_ptr);
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(idarg);
-    }
-    let HEAPU32 = Module.HEAPU32;
-    let idresult = HEAPU32[(res_ptr >> 2) + 0];
-    Module.stackRestore(stackTop);
-    if (status === -1) {
-      Module._pythonexc2js();
-    }
-    let value = Hiwire.pop_value(idresult);
-    done = status === 0;
-    return { done, value };
-  }
-}
-// Another layer of boilerplate. The PyProxyHandlers have some annoying logic
-// to deal with straining out the spurious "Function" properties "prototype",
-// "arguments", and "length", to deal with correctly satisfying the Proxy
-// invariants, and to deal with the mro
-function python_hasattr(jsobj: PyProxyClass, jskey: any) {
-  let ptrobj = _getPtr(jsobj);
-  let idkey = Hiwire.new_value(jskey);
-  let result;
-  try {
-    result = Module.__pyproxy_hasattr(ptrobj, idkey);
-  } catch (e) {
-    API.fatal_error(e);
-  } finally {
-    Hiwire.decref(idkey);
-  }
-  if (result === -1) {
-    Module._pythonexc2js();
-  }
-  return result !== 0;
-}
-// Returns a JsRef in order to allow us to differentiate between "not found"
-// (in which case we return 0) and "found 'None'" (in which case we return
-// Js_undefined).
-function python_getattr(jsobj: PyProxyClass, jskey: any) {
-  let ptrobj = _getPtr(jsobj);
-  let idkey = Hiwire.new_value(jskey);
-  let idresult;
-  let cacheId = jsobj.$$.cache.cacheId;
-  try {
-    idresult = Module.__pyproxy_getattr(ptrobj, idkey, cacheId);
-  } catch (e) {
-    API.fatal_error(e);
-  } finally {
-    Hiwire.decref(idkey);
-  }
-  if (idresult === 0) {
-    if (Module._PyErr_Occurred()) {
-      Module._pythonexc2js();
-    }
-  }
-  return idresult;
-}
-function python_setattr(jsobj: PyProxyClass, jskey: any, jsval: any) {
-  let ptrobj = _getPtr(jsobj);
-  let idkey = Hiwire.new_value(jskey);
-  let idval = Hiwire.new_value(jsval);
-  let errcode;
-  try {
-    errcode = Module.__pyproxy_setattr(ptrobj, idkey, idval);
-  } catch (e) {
-    API.fatal_error(e);
-  } finally {
-    Hiwire.decref(idkey);
-    Hiwire.decref(idval);
-  }
-  if (errcode === -1) {
-    Module._pythonexc2js();
-  }
-}
-function python_delattr(jsobj: PyProxyClass, jskey: any) {
-  let ptrobj = _getPtr(jsobj);
-  let idkey = Hiwire.new_value(jskey);
-  let errcode;
-  try {
-    errcode = Module.__pyproxy_delattr(ptrobj, idkey);
-  } catch (e) {
-    API.fatal_error(e);
-  } finally {
-    Hiwire.decref(idkey);
-  }
-  if (errcode === -1) {
-    Module._pythonexc2js();
-  }
-}
-// See explanation of which methods should be defined here and what they do
-// here:
-// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
-let PyProxyHandlers = {
-  isExtensible() {
-    return (!!1);
-  },
-  has(jsobj: PyProxyClass, jskey: any) {
-    // Note: must report "prototype" in proxy when we are callable.
-    // (We can return the wrong value from "get" handler though.)
-    let objHasKey = Reflect.has(jsobj, jskey);
-    if (objHasKey) {
-      return (!!1);
-    }
-    // python_hasattr will crash if given a Symbol.
-    if (typeof jskey === "symbol") {
-      return (!!0);
-    }
-    if (jskey.startsWith("$")) {
-      jskey = jskey.slice(1);
-    }
-    return python_hasattr(jsobj, jskey);
-  },
-  get(jsobj: PyProxyClass, jskey: any) {
-    // Preference order:
-    // 1. stuff from JavaScript
-    // 2. the result of Python getattr
-    // python_getattr will crash if given a Symbol.
-    if (jskey in jsobj || typeof jskey === "symbol") {
-      return Reflect.get(jsobj, jskey);
-    }
-    // If keys start with $ remove the $. User can use initial $ to
-    // unambiguously ask for a key on the Python object.
-    if (jskey.startsWith("$")) {
-      jskey = jskey.slice(1);
-    }
-    // 2. The result of getattr
-    let idresult = python_getattr(jsobj, jskey);
-    if (idresult !== 0) {
-      return Hiwire.pop_value(idresult);
-    }
-  },
-  set(jsobj: PyProxyClass, jskey: any, jsval: any) {
-    let descr = Object.getOwnPropertyDescriptor(jsobj, jskey);
-    if (descr && !descr.writable) {
-      throw new TypeError(`Cannot set read only field '${jskey}'`);
-    }
-    // python_setattr will crash if given a Symbol.
-    if (typeof jskey === "symbol") {
-      return Reflect.set(jsobj, jskey, jsval);
-    }
-    if (jskey.startsWith("$")) {
-      jskey = jskey.slice(1);
-    }
-    python_setattr(jsobj, jskey, jsval);
-    return (!!1);
-  },
-  deleteProperty(jsobj: PyProxyClass, jskey: any): boolean {
-    let descr = Object.getOwnPropertyDescriptor(jsobj, jskey);
-    if (descr && !descr.writable) {
-      throw new TypeError(`Cannot delete read only field '${jskey}'`);
-    }
-    if (typeof jskey === "symbol") {
-      return Reflect.deleteProperty(jsobj, jskey);
-    }
-    if (jskey.startsWith("$")) {
-      jskey = jskey.slice(1);
-    }
-    python_delattr(jsobj, jskey);
-    // Must return "false" if "jskey" is a nonconfigurable own property.
-    // Otherwise JavaScript will throw a TypeError.
-    return !descr || !!descr.configurable;
-  },
-  ownKeys(jsobj: PyProxyClass) {
-    let ptrobj = _getPtr(jsobj);
-    let idresult;
-    try {
-      idresult = Module.__pyproxy_ownKeys(ptrobj);
-    } catch (e) {
-      API.fatal_error(e);
-    }
-    if (idresult === 0) {
-      Module._pythonexc2js();
-    }
-    let result = Hiwire.pop_value(idresult);
-    result.push(...Reflect.ownKeys(jsobj));
-    return result;
-  },
-  apply(jsobj: PyProxyClass & Function, jsthis: any, jsargs: any) {
-    return jsobj.apply(jsthis, jsargs);
-  },
-};
-export type PyProxyAwaitable = PyProxy & Promise<any>;
-/**
- * The Promise / JavaScript awaitable API.
- * @private
- */
-export class PyProxyAwaitableMethods {
-  $$: any;
-  /**
-   * This wraps __pyproxy_ensure_future and makes a function that converts a
-   * Python awaitable to a promise, scheduling the awaitable on the Python
-   * event loop if necessary.
-   * @private
-   */
-  _ensure_future(): Promise<any> {
-    if (this.$$.promise) {
-      return this.$$.promise;
-    }
-    let ptrobj = _getPtr(this);
-    let resolveHandle;
-    let rejectHandle;
-    let promise = new Promise((resolve, reject) => {
-      resolveHandle = resolve;
-      rejectHandle = reject;
-    });
-    let resolve_handle_id = Hiwire.new_value(resolveHandle);
-    let reject_handle_id = Hiwire.new_value(rejectHandle);
-    let errcode;
-    try {
-      errcode = Module.__pyproxy_ensure_future(
-        ptrobj,
-        resolve_handle_id,
-        reject_handle_id
-      );
-    } catch (e) {
-      API.fatal_error(e);
-    } finally {
-      Hiwire.decref(reject_handle_id);
-      Hiwire.decref(resolve_handle_id);
-    }
-    if (errcode === -1) {
-      Module._pythonexc2js();
-    }
-    this.$$.promise = promise;
-    // @ts-ignore
-    this.destroy();
-    return promise;
-  }
-  /**
-   * Runs ``asyncio.ensure_future(awaitable)``, executes
-   * ``onFulfilled(result)`` when the ``Future`` resolves successfully,
-   * executes ``onRejected(error)`` when the ``Future`` fails. Will be used
-   * implicitly by ``await obj``.
-   *
-   * See the documentation for
-   * `Promise.then
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then>`_
-   *
-   * Present only if the proxied Python object is `awaitable
-   * <https://docs.python.org/3/library/asyncio-task.html?highlight=awaitable#awaitables>`_.
-   *
-   * @param onFulfilled A handler called with the result as an
-   * argument if the awaitable succeeds.
-   * @param onRejected A handler called with the error as an
-   * argument if the awaitable fails.
-   * @returns The resulting Promise.
-   */
-  then(
-    onFulfilled: (value: any) => any,
-    onRejected: (reason: any) => any
-  ): Promise<any> {
-    let promise = this._ensure_future();
-    return promise.then(onFulfilled, onRejected);
-  }
-  /**
-   * Runs ``asyncio.ensure_future(awaitable)`` and executes
-   * ``onRejected(error)`` if the future fails.
-   *
-   * See the documentation for
-   * `Promise.catch
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch>`_.
-   *
-   * Present only if the proxied Python object is `awaitable
-   * <https://docs.python.org/3/library/asyncio-task.html?highlight=awaitable#awaitables>`_.
-   *
-   * @param onRejected A handler called with the error as an
-   * argument if the awaitable fails.
-   * @returns The resulting Promise.
-   */
-  catch(onRejected: (reason: any) => any) {
-    let promise = this._ensure_future();
-    return promise.catch(onRejected);
-  }
-  /**
-   * Runs ``asyncio.ensure_future(awaitable)`` and executes
-   * ``onFinally(error)`` when the future resolves.
-   *
-   * See the documentation for
-   * `Promise.finally
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/finally>`_.
-   *
-   * Present only if the proxied Python object is `awaitable
-   * <https://docs.python.org/3/library/asyncio-task.html?highlight=awaitable#awaitables>`_.
-   *
-   *
-   * @param onFinally A handler that is called with zero arguments
-   * when the awaitable resolves.
-   * @returns A Promise that resolves or rejects with the same
-   * result as the original Promise, but only after executing the
-   * ``onFinally`` handler.
-   */
-  finally(onFinally: () => void) {
-    let promise = this._ensure_future();
-    return promise.finally(onFinally);
-  }
-}
-export type PyProxyCallable = PyProxy &
-  PyProxyCallableMethods &
-  ((...args: any[]) => any);
-export class PyProxyCallableMethods {
-  apply(jsthis: PyProxyClass, jsargs: any) {
-    return Module.callPyObject(_getPtr(this), ...jsargs);
-  }
-  call(jsthis: PyProxyClass, ...jsargs: any) {
-    return Module.callPyObject(_getPtr(this), ...jsargs);
-  }
-  /**
-   * Call the function with key word arguments.
-   * The last argument must be an object with the keyword arguments.
-   */
-  callKwargs(...jsargs: any) {
-    if (jsargs.length === 0) {
-      throw new TypeError(
-        "callKwargs requires at least one argument (the key word argument object)"
-      );
-    }
-    let kwargs = jsargs[jsargs.length - 1];
-    if (
-      kwargs.constructor !== undefined &&
-      kwargs.constructor.name !== "Object"
-    ) {
-      throw new TypeError("kwargs argument is not an object");
-    }
-    return Module.callPyObjectKwargs(_getPtr(this), ...jsargs);
-  }
-}
-// @ts-ignore
-PyProxyCallableMethods.prototype.prototype = Function.prototype;
-// @ts-ignore
-let type_to_array_map: Map<string, any> = new Map([
-  ["i8", Int8Array],
-  ["u8", Uint8Array],
-  ["u8clamped", Uint8ClampedArray],
-  ["i16", Int16Array],
-  ["u16", Uint16Array],
-  ["i32", Int32Array],
-  ["u32", Uint32Array],
-  ["i32", Int32Array],
-  ["u32", Uint32Array],
-  // if these aren't available, will be globalThis.BigInt64Array will be
-  // undefined rather than raising a ReferenceError.
-  ["i64", globalThis.BigInt64Array],
-  ["u64", globalThis.BigUint64Array],
-  ["f32", Float32Array],
-  ["f64", Float64Array],
-  ["dataview", DataView],
-]);
-export type PyProxyBuffer = PyProxy & PyProxyBufferMethods;
-export class PyProxyBufferMethods {
-  /**
-   * Get a view of the buffer data which is usable from JavaScript. No copy is
-   * ever performed.
-   *
-   * Present only if the proxied Python object supports the `Python Buffer
-   * Protocol <https://docs.python.org/3/c-api/buffer.html>`_.
-   *
-   * 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 :any:`toJs` api or copy the
-   * buffer to one that doesn't use suboffets (using e.g.,
-   * `numpy.ascontiguousarray
-   * <https://numpy.org/doc/stable/reference/generated/numpy.ascontiguousarray.html>`_).
-   *
-   * 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
-   * ``toJs``. `DataViews
-   * <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView>`_
-   * have 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 :any:`PyBuffer.data <pyodide.PyBuffer.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 ``getBuffer`` will try to determine the appropriate
-   * output type based on the buffer `format string
-   * <https://docs.python.org/3/library/struct.html#format-strings>`_.
-   * @returns :any:`PyBuffer <pyodide.PyBuffer>`
-   */
-  getBuffer(type?: string): PyBuffer {
-    let ArrayType = undefined;
-    if (type) {
-      ArrayType = type_to_array_map.get(type);
-      if (ArrayType === undefined) {
-        throw new Error(`Unknown type ${type}`);
-      }
-    }
-    let HEAPU32 = Module.HEAPU32;
-    let orig_stack_ptr = Module.stackSave();
-    let buffer_struct_ptr = Module.stackAlloc(
-      HEAPU32[(Module._buffer_struct_size >> 2) + 0]
-    );
-    let this_ptr = _getPtr(this);
-    let errcode;
-    try {
-      errcode = Module.__pyproxy_get_buffer(buffer_struct_ptr, this_ptr);
-    } catch (e) {
-      API.fatal_error(e);
-    }
-    if (errcode === -1) {
-      Module._pythonexc2js();
-    }
-    // This has to match the fields in buffer_struct
-    let startByteOffset = HEAPU32[(buffer_struct_ptr >> 2) + 0];
-    let minByteOffset = HEAPU32[(buffer_struct_ptr >> 2) + 1];
-    let maxByteOffset = HEAPU32[(buffer_struct_ptr >> 2) + 2];
-    let readonly = !!HEAPU32[(buffer_struct_ptr >> 2) + 3];
-    let format_ptr = HEAPU32[(buffer_struct_ptr >> 2) + 4];
-    let itemsize = HEAPU32[(buffer_struct_ptr >> 2) + 5];
-    let shape = Hiwire.pop_value(HEAPU32[(buffer_struct_ptr >> 2) + 6]);
-    let strides = Hiwire.pop_value(HEAPU32[(buffer_struct_ptr >> 2) + 7]);
-    let view_ptr = HEAPU32[(buffer_struct_ptr >> 2) + 8];
-    let c_contiguous = !!HEAPU32[(buffer_struct_ptr >> 2) + 9];
-    let f_contiguous = !!HEAPU32[(buffer_struct_ptr >> 2) + 10];
-    let format = Module.UTF8ToString(format_ptr);
-    Module.stackRestore(orig_stack_ptr);
-    let success = (!!0);
-    try {
-      let bigEndian = (!!0);
-      if (ArrayType === undefined) {
-        [ArrayType, bigEndian] = Module.processBufferFormatString(
-          format,
-          " In this case, you can pass an explicit type argument."
-        );
-      }
-      let alignment = parseInt(ArrayType.name.replace(/[^0-9]/g, "")) / 8 || 1;
-      if (bigEndian && alignment > 1) {
-        throw new Error(
-          "Javascript has no native support for big endian buffers. " +
-            "In this case, you can pass an explicit type argument. " +
-            "For instance, `getBuffer('dataview')` will return a `DataView`" +
-            "which has native support for reading big endian data. " +
-            "Alternatively, toJs will automatically convert the buffer " +
-            "to little endian."
-        );
-      }
-      let numBytes = maxByteOffset - minByteOffset;
-      if (
-        numBytes !== 0 &&
-        (startByteOffset % alignment !== 0 ||
-          minByteOffset % alignment !== 0 ||
-          maxByteOffset % alignment !== 0)
-      ) {
-        throw new Error(
-          `Buffer does not have valid alignment for a ${ArrayType.name}`
-        );
-      }
-      let numEntries = numBytes / alignment;
-      let offset = (startByteOffset - minByteOffset) / alignment;
-      let data;
-      if (numBytes === 0) {
-        data = new ArrayType();
-      } else {
-        data = new ArrayType(HEAPU32.buffer, minByteOffset, numEntries);
-      }
-      for (let i of strides.keys()) {
-        strides[i] /= alignment;
-      }
-      success = (!!1);
-      let result = Object.create(
-        PyBuffer.prototype,
-        Object.getOwnPropertyDescriptors({
-          offset,
-          readonly,
-          format,
-          itemsize,
-          ndim: shape.length,
-          nbytes: numBytes,
-          shape,
-          strides,
-          data,
-          c_contiguous,
-          f_contiguous,
-          _view_ptr: view_ptr,
-          _released: (!!0),
-        })
-      );
-      // Module.bufferFinalizationRegistry.register(result, view_ptr, result);
-      return result;
-    } finally {
-      if (!success) {
-        try {
-          Module._PyBuffer_Release(view_ptr);
-          Module._PyMem_Free(view_ptr);
-        } catch (e) {
-          API.fatal_error(e);
-        }
-      }
-    }
-  }
-}
-export type TypedArray =
-  | Int8Array
-  | Uint8Array
-  | Int16Array
-  | Uint16Array
-  | Int32Array
-  | Uint32Array
-  | Uint8ClampedArray
-  | Float32Array
-  | Float64Array;
-export type PyProxyDict = PyProxyWithGet & PyProxyWithSet & PyProxyWithHas;
-/**
- * A class to allow access to a Python data buffers from JavaScript. These are
- * produced by :any:`PyProxy.getBuffer` and cannot be constructed directly.
- * When you are done, release it with the :any:`release <PyBuffer.release>`
- * method.  See
- * `Python buffer protocol documentation
- * <https://docs.python.org/3/c-api/buffer.html>`_ 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:: Contiguity
- *    :class: warning
- *
- *    If the buffer is not contiguous, the ``data`` TypedArray will contain
- *    data that is not part of the buffer. Modifying this data may lead to
- *    undefined behavior.
- *
- * .. admonition:: Readonly buffers
- *    :class: warning
- *
- *    If ``buffer.readonly`` is ``true``, you should not modify the buffer.
- *    Modifying a readonly buffer may lead to undefined behavior.
- *
- * .. 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
- *        );
- */
-export class PyBuffer {
-  /**
-   * 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 readonly, you should not modify it. There is no way
-   * for us to enforce this, but it may cause very weird behavior.
-   */
-  readonly: boolean;
-  /**
-   * The format string for the buffer. See `the Python documentation on
-   * format strings
-   * <https://docs.python.org/3/library/struct.html#format-strings>`_.
-   */
-  format: string;
-  /**
-   * How large is each entry (in bytes)?
-   */
-  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.
-   */
-  ndim: number;
-  /**
-   * The total number of bytes the buffer takes up. This is equal to
-   * ``buff.data.byteLength``.
-   */
-  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]``.
-   */
-  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.
-   */
-  strides: number[];
-  /**
-   * The actual data. A typed array of an appropriate size backed by a
-   * segment of the WASM memory.
-   *
-   * The ``type`` argument of :any:`PyProxy.getBuffer`
-   * determines which sort of ``TypedArray`` this is. By default
-   * :any:`PyProxy.getBuffer` will look at the format string to determine the most
-   * appropriate option.
-   */
-  data: TypedArray;
-  /**
-   * Is it C contiguous?
-   */
-  c_contiguous: boolean;
-  /**
-   * Is it Fortran contiguous?
-   */
-  f_contiguous: boolean;
-  /**
-   * @private
-   */
-  _released: boolean;
-  /**
-   * @private
-   */
-  _view_ptr: number;
-  /**
-   * @private
-   */
-  constructor() {
-    throw new TypeError("PyBuffer is not a constructor");
-  }
-  /**
-   * Release the buffer. This allows the memory to be reclaimed.
-   */
-  release() {
-    if (this._released) {
-      return;
-    }
-    // Module.bufferFinalizationRegistry.unregister(this);
-    try {
-      Module._PyBuffer_Release(this._view_ptr);
-      Module._PyMem_Free(this._view_ptr);
-    } catch (e) {
-      API.fatal_error(e);
-    }
-    this._released = (!!1);
-    // @ts-ignore
-    this.data = null;
-  }
-}