Method remove_at

couchbase/datastructures.py:245–271

Removes an item at a specific index from the list. Args: index (int): The index to remove. Raises: :class:`~couchbase.exceptions.InvalidArgumentException`: If the index is out of range.

(self, index: int)

                    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.

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

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

        """
        op_type = DatastructureOperationType.ListRemoveAt
        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.MutateIn
            with ObservableRequestHandler(kv_op_type, self._impl.observability_instruments) as obs_handler:
                try:
                    op = remove(f'[{index}]')
                    req = self._impl.request_builder.build_mutate_in_request(self._key,
                                                                             (op,),
                                                                             obs_handler,
                                                                             parent_span=ds_obs_handler.wrapped_span)
                    self._execute_op(self._impl.mutate_in,
                                     req,
                                     obs_handler,
                                     ds_obs_handler.wrapped_span)
                except PathNotFoundException:
                    raise InvalidArgumentException(message=f'Index: {index} is out of range.') from None

    def size(self) -> int:
        """Returns the number of items in the list.