import typing
from hazelcast.protocol.codec import (
set_add_all_codec,
set_add_codec,
set_add_listener_codec,
set_clear_codec,
set_compare_and_remove_all_codec,
set_compare_and_retain_all_codec,
set_contains_all_codec,
set_contains_codec,
set_get_all_codec,
set_is_empty_codec,
set_remove_codec,
set_remove_listener_codec,
set_size_codec,
)
from hazelcast.internal.asyncio_proxy.base import (
PartitionSpecificProxy,
ItemEvent,
ItemEventType,
)
from hazelcast.types import ItemType
from hazelcast.serialization.compact import SchemaNotReplicatedError
from hazelcast.util import check_not_none, deserialize_list_in_place
[docs]
class Set(PartitionSpecificProxy, typing.Generic[ItemType]):
"""Concurrent, distributed implementation of Set.
Example:
>>> my_set = await client.get_set("my_set")
>>> print("set.add", await my_set.add("item"))
>>> print("set.size", await my_set.size())
Warning:
Asyncio client set proxy is not thread-safe, do not access it from other threads.
"""
[docs]
async def add(self, item: ItemType) -> bool:
"""Adds the specified item if it is not exists in this set.
Args:
item: The specified item to be added.
Returns:
``True`` if this set is changed after call, ``False`` otherwise.
"""
check_not_none(item, "Value can't be None")
try:
element_data = self._to_data(item)
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.add, item)
request = set_add_codec.encode_request(self.name, element_data)
return await self._invoke(request, set_add_codec.decode_response)
[docs]
async def add_all(self, items: typing.Sequence[ItemType]) -> bool:
"""Adds the elements in the specified collection if they're not exist
in this set.
Args:
items: Collection which includes the items to be added.
Returns:
``True`` if this set is changed after call, ``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
try:
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.add_all, items)
request = set_add_all_codec.encode_request(self.name, data_items)
return await self._invoke(request, set_add_all_codec.decode_response)
[docs]
async def add_listener(
self,
include_value: bool = False,
item_added_func: typing.Callable[[ItemEvent[ItemType]], None] = None,
item_removed_func: typing.Callable[[ItemEvent[ItemType]], None] = None,
) -> str:
"""Adds an item listener for this container.
Listener will be notified for all container add/remove events.
Args:
include_value: Whether received events include the updated item or
not.
item_added_func: Function to be called when an item is added to
this set.
item_removed_func: Function to be called when an item is deleted
from this set.
Returns:
A registration id which is used as a key to remove the listener.
"""
request = set_add_listener_codec.encode_request(self.name, include_value, self._is_smart)
def handle_event_item(item_data, uuid, event_type):
item = self._to_object(item_data) if include_value else None
member = self._context.cluster_service.get_member(uuid)
item_event = ItemEvent(self.name, item, event_type, member)
if event_type == ItemEventType.ADDED:
if item_added_func:
item_added_func(item_event)
else:
if item_removed_func:
item_removed_func(item_event)
return await self._register_listener(
request,
lambda r: set_add_listener_codec.decode_response(r),
lambda reg_id: set_remove_listener_codec.encode_request(self.name, reg_id),
lambda m: set_add_listener_codec.handle(m, handle_event_item),
)
[docs]
async def clear(self) -> None:
"""Clears the set. Set will be empty with this call."""
request = set_clear_codec.encode_request(self.name)
return await self._invoke(request)
[docs]
async def contains(self, item: ItemType) -> bool:
"""Determines whether this set contains the specified item or not.
Args:
item: The specified item to be searched.
Returns:
``True`` if the specified item exists in this set, ``False``
otherwise.
"""
check_not_none(item, "Value can't be None")
try:
item_data = self._to_data(item)
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.contains, item)
request = set_contains_codec.encode_request(self.name, item_data)
return await self._invoke(request, set_contains_codec.decode_response)
[docs]
async def contains_all(self, items: typing.Sequence[ItemType]) -> bool:
"""Determines whether this set contains all items in the specified
collection or not.
Args:
items: The specified collection which includes the items to be
searched.
Returns:
``True`` if all the items in the specified collection exist in
this set, ``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
try:
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.contains_all, items)
request = set_contains_all_codec.encode_request(self.name, data_items)
return await self._invoke(request, set_contains_all_codec.decode_response)
[docs]
async def get_all(self) -> typing.List[ItemType]:
"""Returns all the items in the set.
Returns:
List of the items in this set.
"""
def handler(message):
data_list = set_get_all_codec.decode_response(message)
return deserialize_list_in_place(data_list, self._to_object)
request = set_get_all_codec.encode_request(self.name)
return await self._invoke(request, handler)
[docs]
async def is_empty(self) -> bool:
"""Determines whether this set is empty or not.
Returns:
``True`` if this set is empty, ``False`` otherwise.
"""
request = set_is_empty_codec.encode_request(self.name)
return await self._invoke(request, set_is_empty_codec.decode_response)
[docs]
async def remove(self, item: ItemType) -> bool:
"""Removes the specified element from the set if it exists.
Args:
item: The specified element to be removed.
Returns:
``True`` if the specified element exists in this set, ``False``
otherwise.
"""
check_not_none(item, "Value can't be None")
try:
item_data = self._to_data(item)
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.remove, item)
request = set_remove_codec.encode_request(self.name, item_data)
return await self._invoke(request, set_remove_codec.decode_response)
[docs]
async def remove_all(self, items: typing.Sequence[ItemType]) -> bool:
"""Removes all of the elements of the specified collection from this
set.
Args:
items: The specified collection.
Returns:
``True`` if the call changed this set, ``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
try:
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.remove_all, items)
request = set_compare_and_remove_all_codec.encode_request(self.name, data_items)
return await self._invoke(request, set_compare_and_remove_all_codec.decode_response)
[docs]
async def remove_listener(self, registration_id: str) -> bool:
"""Removes the specified item listener.
Returns silently if the specified listener was not added before.
Args:
registration_id: Id of the listener to be deleted.
Returns:
``True`` if the item listener is removed, ``False`` otherwise.
"""
return await self._deregister_listener(registration_id)
[docs]
async def retain_all(self, items: typing.Sequence[ItemType]) -> bool:
"""Removes the items which are not contained in the specified
collection.
In other words, only the items that are contained in the specified
collection will be retained.
Args:
items: Collection which includes the elements to be retained in
this set.
Returns:
``True`` if this set changed as a result of the call, ``False``
otherwise.
"""
check_not_none(items, "Value can't be None")
try:
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
except SchemaNotReplicatedError as e:
return await self._send_schema_and_retry(e, self.retain_all, items)
request = set_compare_and_retain_all_codec.encode_request(self.name, data_items)
return await self._invoke(request, set_compare_and_retain_all_codec.decode_response)
[docs]
async def size(self) -> int:
"""Returns the number of items in this set.
Returns:
Number of items in this set.
"""
request = set_size_codec.encode_request(self.name)
return await self._invoke(request, set_size_codec.decode_response)
async def create_set_proxy(service_name, name, context):
return Set(service_name, name, context)