Store ordered items, including duplicates, without adding, removing or replacing them after creation. A nested list or dictionary can still change. In conditions, an empty tuple is false and a non-empty tuple is true.
tuple(iterable=(), /)
(value1, value2, ...)offset = (0, 1)
x = offset[0]
y = offset[1]
if 1 in offset:
text("offset ready")Create an empty tuple or copy items from a source you can loop through into a tuple. Nested collections remain shared with the source.
tuple()
tuple(iterable, /)| Name | Description |
|---|---|
iterableIterable | Optional source you can loop through, such as a string, list or generator. Depends on overload · Positional only Default: () |
coords = (120, 340)
copy = tuple(coords)Create a tuple with comma-separated items. Use (value,) for one item; (value) alone is not a tuple.
(value1, value2, ...)| Name | Description |
|---|---|
valueAny? | Each item written inside tuple parentheses. Required · Positional or named No default |
offset = (0, 1)
click(Point(500, 900), offset=offset)Count how many items are in the tuple.
len(tuple, /)Int — Number of tuple items.offset = (0, 1)
count = len(offset) # returns 2Read one tuple item by position: 0 is first, -1 is last, and other negative indexes count from the end.
tuple[index]Any? — The item at that position. Raises IndexError when the position is outside the tuple.pair = (10, 20)
x = pair[0] # returns 10
y = pair[-1] # returns 20Return a new tuple from start up to, but not including, end. Negative indexes count from the end. Omitted bounds select the whole tuple in the step direction; nested collections remain shared.
tuple[start:end[:step]]values = (0, 1, 2, 3, 4)
middle = values[1:4] # returns (1, 2, 3)
reverse = values[::-1] # returns (4, 3, 2, 1, 0)Assign tuple items to variables from left to right. The number of variables must match the number of items or an error is raised. Groups of variables can be nested; *rest is not supported.
x, y = tupleNone — No direct return value. Targets receive tuple items left to right.label, (x, y) = ("target", (500, 900))Return the first matching position within the selected bounds, or raise ValueError if the value is absent.
tuple.index(value, start=0, stop=len(tuple), /)| Name | Description |
|---|---|
valueAny? | Value that must exist in the tuple. Required · Positional only No default |
startInt | First position to search, starting at 0. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: 0 |
stopInt | Stop searching before this position. Negative values count from the end; out-of-range bounds are limited to the available range. Optional · Positional only Default: len(tuple) |
Int — First matching item index.pair = ("farm", "pvp")
index = pair.index("pvp")Count matching tuple items.
tuple.count(value, /)| Name | Description |
|---|---|
valueAny? | Value to count. Required · Positional only No default |
Int — Number of matches.pair = ("farm", "farm", "pvp")
count = pair.count("farm")Iterate tuple items from left to right.
for item in tuple:None — No direct return value.offset = (0, 1)
for item in offset:
text(str(item))