Method get_at

couchbase/datastructures.py:211–243

Retrieves the item at a specific index in the list. Args: index (int): The index to retrieve. Returns: Any: The value of the element at the specified index. Raises: :class:`~couchbase.exceptions.InvalidArgumentException`: If the index is

(self, index: int)

                    raise InvalidArgumentException(message=f'Index: {index} is out of range.') from None

    def get_at(self, index: int) -> Any:
        """Retrieves the item at a specific index in the list.

        Args:
            index (int): The index to retrieve.

        Returns:
            Any: The value of the element at the specified index.

        Raises:
            :class:`~couchbase.exceptions.InvalidArgumentException`: If the index is out of range.

        """
        op_type = DatastructureOperationType.ListGetAt
        with ObservableRequestHandler(op_type, self._impl.observability_instruments) as ds_obs_handler:
            ds_obs_handler.create_kv_span(self._impl._request_builder._collection_dtls.get_details_as_dict())
            kv_op_type = KeyValueOperationType.LookupIn
            with ObservableRequestHandler(kv_op_type, self._impl.observability_instruments) as obs_handler:
                try:
                    op = subdoc_get(f'[{index}]')
                    req, transcoder = self._impl.request_builder.build_lookup_in_request(self._key,
                                                                                         (op,),
                                                                                         obs_handler,
                                                                                         parent_span=ds_obs_handler.wrapped_span)  # noqa: E501
                    sdres: LookupInResult = self._execute_op(self._impl.lookup_in,
                                                             req,
                                                             obs_handler,
                                                             ds_obs_handler.wrapped_span,
                                                             create_type=True,
                                                             transcoder=transcoder)
                    return sdres.value[0].get('value', None)
                except PathNotFoundException:
                    raise InvalidArgumentException(message=f'Index: {index} is out of range.') from None

    def remove_at(self, index: int) -> None:
        """Removes an item at a specific index from the list.