Merge branch 'main' of https://github.com/ikostan/python

Author: ikostan

solutions/python/tisbury-treasure-hunt/2/tuples.py

@@ -0,0 +1,71 @@
+"""Functions to help Azara and Rui locate pirate treasure."""
+
+
+def get_coordinate(record: tuple) -> str:
+    """
+    Return coordinate value from a tuple containing the treasure name,
+    and treasure coordinate.
+
+    :param record: tuple - with a (treasure, coordinate) pair.
+    :return: str - the extracted map coordinate.
+    """
+    return record[-1]
+
+
+def convert_coordinate(coordinate: str) -> tuple:
+    """
+    Split the given coordinate into tuple containing its individual
+    components.
+
+    :param coordinate: str - a string map coordinate
+    :return: tuple - the string coordinate split into its individual
+             components.
+    """
+    return tuple(char for char in coordinate)
+
+
+def compare_records(azara_record: tuple, rui_record: tuple) -> bool:
+    """
+    Compare two record types and determine if their coordinates match.
+
+    :param azara_record: tuple - a (treasure, coordinate) pair.
+    :param rui_record: tuple - a
+                       (location, tuple(coordinate_1, coordinate_2),
+                        quadrant)
+                       trio.
+    :return: bool - do the coordinates match?
+    """
+    return azara_record[-1] == "".join(rui_record[1])
+
+
+def create_record(azara_record: tuple, rui_record: tuple) -> (tuple, str):
+    """
+    Combine the two record types (if possible) and create a combined record
+    group.
+
+    :param azara_record: tuple - a (treasure, coordinate) pair.
+    :param rui_record: tuple - a (location, coordinate, quadrant) trio.
+    :return: tuple or str - the combined record (if compatible), or the string
+             "not a match" (if incompatible).
+    """
+    if compare_records(azara_record, rui_record):
+        return azara_record + rui_record
+    return "not a match"
+
+
+def clean_up(combined_record_group: tuple) -> str:
+    """
+    Clean up a combined record group into a multi-line string of single
+    records.
+
+    :param combined_record_group: tuple - everything from both participants.
+    :return: str - everything "cleaned", excess coordinates and information
+             are removed.
+
+    The return statement should be a multi-lined string with items separated
+    by newlines. (see HINTS.md for an example).
+    """
+    result: str = ""
+    for line in combined_record_group:
+        result += f"{tuple(item for i, item in enumerate(line) if i != 1)}\n"
+    return result