Method as_object_map

src/py/_pyodide/_core_docs.py:218–272

Returns a new JsProxy that treats the object as a map. The methods :py:func:`~operator.__getitem__`, :py:func:`~operator.__setitem__`, :py:func:`~operator.__contains__`, :py:meth:`~object.__len__`, etc will perform lookups via ``object[key]`` or similar. Not

(self, *, hereditary: bool = False)

        raise NotImplementedError

    def as_object_map(self, *, hereditary: bool = False) -> "JsMutableMap[str, Any]":
        """Returns a new JsProxy that treats the object as a map.

        The methods :py:func:`~operator.__getitem__`,
        :py:func:`~operator.__setitem__`, :py:func:`~operator.__contains__`,
        :py:meth:`~object.__len__`, etc will perform lookups via ``object[key]``
        or similar.

        Note that ``len(x.as_object_map())`` evaluates in O(n) time (it iterates
        over the object and counts how many :js:func:`~Reflect.ownKeys` it has).
        If you need to compute the length in O(1) time, use a real
        :js:class:`Map` instead.

        .. deprecated:: 0.29.0

            Use :py:meth:`JsProxy.as_py_json` instead.

        Parameters
        ----------
        hereditary:
            If ``True``, any "plain old objects" stored as values in the object
            will be wrapped in `as_object_map` themselves.

        Examples
        --------

        >>> from pyodide.code import run_js # doctest: +RUN_IN_PYODIDE
        >>> o = run_js("({x : {y: 2}})")

        Normally you have to access the properties of ``o`` as attributes:

        >>> o.x.y
        2
        >>> o["x"] # is not subscriptable
        Traceback (most recent call last):
        TypeError: 'pyodide.ffi.JsProxy' object is not subscriptable

        ``as_object_map`` allows us to access the property with ``getitem``:

        >>> o.as_object_map()["x"].y
        2

        The inner object is not subscriptable because ``hereditary`` is ``False``:

        >>> o.as_object_map()["x"]["y"]
        Traceback (most recent call last):
        TypeError: 'pyodide.ffi.JsProxy' object is not subscriptable

        When ``hereditary`` is ``True``, the inner object is also subscriptable:

        >>> o.as_object_map(hereditary=True)["x"]["y"]
        2

        """
        raise NotImplementedError

    def as_py_json(self) -> "JsMutableMap[str, Any] | JsArray[Any]":
        """Returns a new JsProxy that treats a JavaScript object as Python json.