Method list_remove

couchbase/collection.py:1356–1390

Remove the element at a specific index from a list. .. warning:: This method is deprecated and will be removed in the 4.7.0 version. Use :meth:`.CouchbaseList.remove_at` instead. Args: key (str): The key for the list document. index

(self, key: str, index: int, **kwargs: object)

                return sd_res.value[0].get('value', None)

    def list_remove(self, key: str, index: int, **kwargs: object) -> OperationResult:
        """Remove the element at a specific index from a list.

        .. warning::
            This method is deprecated and will be removed in the 4.7.0 version.  Use :meth:`.CouchbaseList.remove_at`
            instead.

        Args:
            key (str): The key for the list document.
            index (int): The position to remove.
            **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters
                for this operation.

        Returns:
            :class:`~couchbase.result.OperationResult`: An instance of :class:`~couchbase.result.OperationResult`.

        Raises:
            :class:`~couchbase.exceptions.DocumentNotFoundException`: If the key provided does not exist
                on the server.
            IndexError: If the index is out of bounds.

        """
        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:
                op = subdoc_remove(f'[{index}]')
                req = self._impl.request_builder.build_mutate_in_request(key, (op,), obs_handler, **kwargs)
                sd_res = self._execute_deprecated_ds_func(self._impl.mutate_in,
                                                          req,
                                                          obs_handler,
                                                          ds_obs_handler.wrapped_span,
                                                          path_value=index)
                return OperationResult(sd_res.cas, sd_res.mutation_token())

    def list_size(self, key: str, **kwargs: object) -> int:
        """Returns the number of items in the list.