Share via

CosmosList Class

  • Reference
Inheritance
builtins.list
CosmosList
Generic
CosmosList

Constructor

CosmosList(original_list: Iterable[Dict[str, Any]] | None, /, *, response_headers: CaseInsensitiveDict)

Positional-Only Parameters

Name Description
original_list
Required

Keyword-Only Parameters

Name Description
response_headers
Required

Methods

append

Append object to the end of the list.
clear

Remove all items from list.
copy

Return a shallow copy of the list.
count

Return number of occurrences of value.
extend

Extend list by appending elements from the iterable.
get_response_headers

Returns a copy of the response headers associated to this response
index

Return first index of value.

Raises ValueError if the value is not present.
insert

Insert object before index.
pop

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.
remove

Remove first occurrence of value.

Raises ValueError if the value is not present.
reverse

Reverse IN PLACE.
sort

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

append

Append object to the end of the list.

append(object, /)

Positional-Only Parameters

Name Description
object
Required

clear

Remove all items from list.

clear()

Positional-Only Parameters

Name Description
object
Required

copy

Return a shallow copy of the list.

copy()

Positional-Only Parameters

Name Description
object
Required

count

Return number of occurrences of value.

count(value, /)

Positional-Only Parameters

Name Description
value
Required

extend

Extend list by appending elements from the iterable.

extend(iterable, /)

Positional-Only Parameters

Name Description
iterable
Required

get_response_headers

Returns a copy of the response headers associated to this response

get_response_headers() -> CaseInsensitiveDict

Positional-Only Parameters

Name Description
object
Required

Returns

Type Description
<xref:azure.core.CaseInsensitiveDict>

Dict of response headers

index

Return first index of value.

Raises ValueError if the value is not present.

index(value, start=0, stop=9223372036854775807, /)

Positional-Only Parameters

Name Description
value
Required
start
Default value: 0
stop
Default value: 9223372036854775807

insert

Insert object before index.

insert(index, object, /)

Positional-Only Parameters

Name Description
index
Required
object
Required

pop

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

pop(index=-1, /)

Positional-Only Parameters

Name Description
index
Default value: -1

remove

Remove first occurrence of value.

Raises ValueError if the value is not present.

remove(value, /)

Positional-Only Parameters

Name Description
value
Required

reverse

Reverse IN PLACE.

reverse()

Positional-Only Parameters

Name Description
object
Required

sort

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

sort(*, key=None, reverse=False)

Positional-Only Parameters

Name Description
object
Required

Keyword-Only Parameters

Name Description
key
Required
reverse
Required