Skip to content

[CLIENT-3466] Prevent aerospike_helpers.operations from truncating fixed-integer arguments and raise a warning when this happens #1045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
juliannguyen4 wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

[CLIENT-3466] Prevent aerospike_helpers.operations from truncating fixed-integer arguments and raise a warning when this happens #1045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions aerospike_helpers/operations/list_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ def list_insert(bin_name: str, index, value, policy: Optional[dict] = None, ctx:

Args:
bin_name (str): The name of the bin to be operated on.
index (int): The index at which to insert an item. The value may be positive to use
zero based indexing or negative to index from the end of the list.
index (int): The index at which to insert an item. (64-bit signed integer) The value may be
positive to use zero based indexing or negative to index from the end of the list.
value: The value to be inserted into the list.
policy (dict): An optional dictionary of :ref:`list write options <aerospike_list_policies>`.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -177,8 +177,8 @@ def list_insert_items(bin_name: str, index, values, policy: Optional[dict] = Non

Args:
bin_name (str): The name of the bin to be operated on.
index (int): The index at which to insert the items. The value may be positive to use
zero based indexing or negative to index from the end of the list.
index (int): The index at which to insert the items. (64-bit signed integer) The value may be
positive to use zero based indexing or negative to index from the end of the list.
values (list): The values to be inserted into the list.
policy (dict): An optional dictionary of :ref:`list write options <aerospike_list_policies>`.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -207,7 +207,7 @@ def list_increment(bin_name: str, index, value, policy: Optional[dict] = None, c

Args:
bin_name (str): The name of the bin to be operated on.
index (int): The index of the list item to increment.
index (int): The index of the list item to increment. (64-bit signed integer)
value (int, float) : The value to be added to the list item.
policy (dict): An optional dictionary of :ref:`list write options <aerospike_list_policies>`.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -236,7 +236,7 @@ def list_pop(bin_name: str, index, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin to be operated on.
index (int): The index of the item to be removed.
index (int): The index of the item to be removed. (64-bit signed integer)
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.
Returns:
Expand All @@ -260,7 +260,7 @@ def list_pop_range(bin_name: str, index, count, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin to be operated on.
index (int): The index of the first item to be removed.
index (int): The index of the first item to be removed. (64-bit signed integer)
count (int): A positive number indicating how many items, including the first, to be removed and returned
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.
Expand All @@ -285,7 +285,7 @@ def list_remove(bin_name: str, index, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin containing the item to be removed.
index (int): The index at which to remove the item.
index (int): The index at which to remove the item. (64-bit signed integer)
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.
Returns:
Expand All @@ -309,7 +309,7 @@ def list_remove_range(bin_name: str, index, count, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin containing the items to be removed.
index (int): The index of the first item to remove.
index (int): The index of the first item to remove. (64-bit signed integer)
count (int): A positive number representing the number of items to be removed.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.
Expand Down Expand Up @@ -355,7 +355,7 @@ def list_set(bin_name: str, index, value, policy: Optional[dict] = None, ctx: Op

Args:
bin_name (str): The name of the bin containing the list to be operated on.
index (int): The index of the item to be set.
index (int): The index of the item to be set. (64-bit signed integer)
value: The value to be assigned to the list item.
policy (dict): An optional dictionary of :ref:`list write options <aerospike_list_policies>`.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand All @@ -382,7 +382,7 @@ def list_get(bin_name: str, index, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin containing the list to fetch items from.
index (int): The index of the item to be returned.
index (int): The index of the item to be returned. (64-bit signed integer)
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.

Expand All @@ -405,7 +405,7 @@ def list_get_range(bin_name: str, index, count, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin containing the list to fetch items from.
index (int): The index of the item to be returned.
index (int): The index of the item to be returned. (64-bit signed integer)
count (int): A positive number of items to be returned.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.
Expand All @@ -429,7 +429,7 @@ def list_trim(bin_name: str, index, count, ctx: Optional[list] = None):

Args:
bin_name (str): The name of the bin containing the list to be trimmed.
index (int): The index of the items to be kept.
index (int): The index of the items to be kept. (64-bit signed integer)
count (int): A positive number of items to be kept.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
objects.
Expand Down Expand Up @@ -479,7 +479,7 @@ def list_get_by_index(bin_name: str, index, return_type, ctx: Optional[list] = N

Args:
bin_name (str): The name of the bin containing the list to fetch items from.
index (int): The index of the item to be returned.
index (int): The index of the item to be returned. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -510,7 +510,7 @@ def list_get_by_index_range(bin_name: str, index, return_type, count=None, inver

Args:
bin_name (str): The name of the bin containing the list to fetch items from.
index (int): The index of the first item to be returned.
index (int): The index of the first item to be returned. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values.
count (int): The number of list items to be selected.
Expand Down Expand Up @@ -549,7 +549,7 @@ def list_get_by_rank(bin_name: str, rank, return_type, ctx: Optional[list] = Non

Args:
bin_name (str): The name of the bin containing the list to fetch a value from.
rank (int): The rank of the item to be fetched.
rank (int): The rank of the item to be fetched. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand All @@ -575,7 +575,7 @@ def list_get_by_rank_range(bin_name: str, rank, return_type, count=None, inverte

Args:
bin_name (str): The name of the bin containing the list to fetch items from.
rank (int): The rank of the first items to be returned.
rank (int): The rank of the first items to be returned. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation. This should be one of the
:ref:`list_return_types` values
count (int): A positive number indicating number of items to be returned.
Expand Down Expand Up @@ -730,7 +730,7 @@ def list_remove_by_index(bin_name: str, index, return_type, ctx: Optional[list]

Args:
bin_name (str): The name of the bin containing the list to remove an item from.
index (int): The index of the item to be removed.
index (int): The index of the item to be removed. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -768,7 +768,7 @@ def list_remove_by_index_range(

Args:
bin_name (str): The name of the bin containing the list to remove items from.
index (int): The index of the first item to be removed.
index (int): The index of the first item to be removed. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values.
count (int): The number of items to be removed
Expand Down Expand Up @@ -807,7 +807,7 @@ def list_remove_by_rank(bin_name: str, rank, return_type, ctx: Optional[list] =

Args:
bin_name (str): The name of the bin containing the list to fetch a value from.
rank (int): The rank of the item to be removed.
rank (int): The rank of the item to be removed. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -838,7 +838,7 @@ def list_remove_by_rank_range(bin_name: str, rank, return_type, count=None, inve

Args:
bin_name (str): The name of the bin containing the list to fetch items from.
rank (int): The rank of the first item to removed.
rank (int): The rank of the first item to removed. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
count (int): A positive number indicating number of items to be removed.
Expand Down Expand Up @@ -1040,7 +1040,8 @@ def list_get_by_value_rank_range_relative(
Args:
bin_name (str): The name of the bin containing the list.
value (str): The value of the item in the list for which to search
offset (int): Begin returning items with rank == rank(found_item) + offset
offset (int): Begin returning items with rank == rank(found_item) + offset.
(64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
count (int): If specified, the number of items to return. If None,
Expand Down Expand Up @@ -1118,7 +1119,8 @@ def list_remove_by_value_rank_range_relative(
Args:
bin_name (str): The name of the bin containing the list.
value (str): The value of the item in the list for which to search
offset (int): Begin removing and returning items with rank == rank(found_item) + offset
offset (int): Begin removing and returning items with rank == rank(found_item) + offset.
(64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`list_return_types` values
count (int): If specified, the number of items to remove and return. If None,
Expand Down
28 changes: 16 additions & 12 deletions aerospike_helpers/operations/map_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ def map_remove_by_index(bin_name: str, index, return_type, ctx: Optional[list] =

Args:
bin_name (str): The name of the bin containing the map.
index (int): The index of the entry to remove.
index (int): The index of the entry to remove. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -515,7 +515,7 @@ def map_remove_by_index_range(

Args:
bin_name (str): The name of the bin containing the map.
index_start (int): The index of the first entry to remove.
index_start (int): The index of the first entry to remove. (64-bit signed integer)
remove_amt (int): The number of entries to remove from the map.
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
Expand Down Expand Up @@ -549,7 +549,7 @@ def map_remove_by_rank(bin_name: str, rank, return_type, ctx: Optional[list] = N

Args:
bin_name (str): The name of the bin containing the map.
rank (int): The rank of the entry to remove.
rank (int): The rank of the entry to remove. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -585,7 +585,7 @@ def map_remove_by_rank_range(

Args:
bin_name (str): The name of the bin containing the map.
rank_start (int): The rank of the entry to remove.
rank_start (int): The rank of the entry to remove. (64-bit signed integer)
remove_amt (int): The number of entries to remove.
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
Expand Down Expand Up @@ -823,7 +823,7 @@ def map_get_by_index(bin_name: str, index, return_type, ctx: Optional[list] = No

Args:
bin_name (str): The name of the bin containing the map.
index (int): The index of the entry to return.
index (int): The index of the entry to return. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand Down Expand Up @@ -854,7 +854,7 @@ def map_get_by_index_range(

Args:
bin_name (str): The name of the bin containing the map.
index_start (int): The index of the first entry to return.
index_start (int): The index of the first entry to return. (64-bit signed integer)
get_amt (int): The number of entries to return from the map.
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
Expand Down Expand Up @@ -888,7 +888,7 @@ def map_get_by_rank(bin_name: str, rank, return_type, ctx: Optional[list] = None

Args:
bin_name (str): The name of the bin containing the map.
rank (int): The rank of the entry to return.
rank (int): The rank of the entry to return. (64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
ctx (list): An optional list of nested CDT :class:`cdt_ctx <aerospike_helpers.cdt_ctx>` context operation
Expand All @@ -912,7 +912,7 @@ def map_get_by_rank_range(bin_name: str, rank_start, get_amt, return_type, inver

Args:
bin_name (str): The name of the bin containing the map.
rank_start (int): The start of the rank of the entries to return.
rank_start (int): The start of the rank of the entries to return. (64-bit signed integer)
get_amt (int): The number of entries to return.
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
Expand Down Expand Up @@ -951,7 +951,8 @@ def map_remove_by_value_rank_range_relative(
Args:
bin_name (str): The name of the bin containing the map.
value: The value of the entry in the map for which to search
offset (int): Begin removing and returning items with rank == rank(found_item) + offset
offset (int): Begin removing and returning items with rank == rank(found_item) + offset.
(64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
count (int): If specified, the number of items to remove and return. If None,
Expand Down Expand Up @@ -1024,7 +1025,8 @@ def map_get_by_value_rank_range_relative(
Args:
bin_name (str): The name of the bin containing the map.
value (str): The value of the item in the list for which to search
offset (int): Begin removing and returning items with rank == rank(fount_item) + offset
offset (int): Begin removing and returning items with rank == rank(fount_item) + offset.
(64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
count (int): If specified, the number of items to remove and return. If None,
Expand Down Expand Up @@ -1086,7 +1088,8 @@ def map_remove_by_key_index_range_relative(
Args:
bin_name (str): The name of the bin containing the list.
key (str): The key of the item in the list for which to search
offset (int): Begin removing and returning items with rank == rank(fount_item) + offset
offset (int): Begin removing and returning items with rank == rank(fount_item) + offset.
(64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
count (int): If specified, the number of items to remove and return. If None,
Expand Down Expand Up @@ -1157,7 +1160,8 @@ def map_get_by_key_index_range_relative(
Args:
bin_name (str): The name of the bin containing the list.
value (str): The value of the item in the list for which to search
offset (int): Begin removing and returning items with rank == rank(fount_item) + offset
offset (int): Begin removing and returning items with rank == rank(fount_item) + offset.
(64-bit signed integer)
return_type (int): Value specifying what should be returned from the operation.
This should be one of the :ref:`map_return_types` values.
count (int): If specified, the number of items to remove and return. If None,
Expand Down
Loading
Loading