harnice 0.3.0__py3-none-any.whl

harnice/lists/instances_list.py

@@ -0,0 +1,280 @@
+import csv
+import os
+import inspect
+from threading import Lock
+from harnice import fileio, state
+
+COLUMNS = [
+    "net", #documentation needed
+    "instance_name", #documentation needed
+    "print_name", #documentation needed
+    "bom_line_number", #documentation needed
+    "mfg", #documentation needed
+    "mpn",  # unique part identifier (manufacturer + part number concatenated)
+    "item_type",  # connector, backshell, whatever
+    "parent_instance",  # general purpose reference
+    "location_type",  # each instance is either better represented by one or ther other
+    "segment_group",  # the group of segments that this instance is part of
+    "segment_order",  # the sequential id of this item in its segment group
+    "connector_group",  # a group of co-located parts (connectors, backshells, nodes)
+    "channel_group", #documentation needed
+    "circuit_id",  # which signal this component is electrically connected to
+    "circuit_port_number",  # the sequential id of this item in its signal chain
+    "node_at_end_a",  # derived from formboard definition
+    "node_at_end_b",  # derived from formboard definition
+    "parent_csys_instance_name",  # the other instance upon which this instance's location is based
+    "parent_csys_outputcsys_name",  # the specific output coordinate system of the parent that this instance's location is based
+    "translate_x",  # derived from parent_csys and parent_csys_name
+    "translate_y",  # derived from parent_csys and parent_csys_name
+    "rotate_csys",  # derived from parent_csys and parent_csys_name
+    "absolute_rotation",  # manual add, not nominally used unless it's a flagnote, segment, or node
+    "csys_children",  # imported csys children from library attributes file
+    "cable_group", #documentation needed
+    "cable_container", #documentation needed
+    "cable_identifier", #documentation needed
+    "length",  # derived from formboard definition, the length of a segment
+    "diameter",  # apparent diameter of a segment <---------- change to print_diameter
+    "appearance",  # see harnice.utils.appearance for details
+    "note_type",  # build_note, rev_note, etc
+    "note_number",  # if there is a counter involved (rev, bom, build_note, etc)
+    "note_parent",  # the instance the note applies to. typically don't use this in the instances list, just note_utils
+    "note_text",  # the content of the note
+    "note_affected_instances",  # list of instances that are affected by the note
+    "lib_repo", #documentation needed
+    "lib_subpath", #documentation needed
+    "lib_desc", #documentation needed
+    "lib_latest_rev", #documentation needed
+    "lib_rev_used_here", #documentation needed
+    "lib_status", #documentation needed
+    "lib_releaseticket", #documentation needed
+    "lib_datestarted", #documentation needed
+    "lib_datemodified", #documentation needed
+    "lib_datereleased", #documentation needed
+    "lib_drawnby", #documentation needed
+    "lib_checkedby", #documentation needed
+    "project_editable_lib_modified", #documentation needed
+    "lib_build_notes", #documentation needed
+    "lib_tools", #documentation needed
+    "this_instance_mating_device_refdes",  # if connector, refdes of the device it plugs into
+    "this_instance_mating_device_connector",  # if connector, name of the connector it plugs into
+    "this_instance_mating_device_connector_mpn",  # if connector, mpn of the connector it plugs into
+    "this_net_from_device_refdes", #documentation needed
+    "this_net_from_device_channel_id", #documentation needed
+    "this_net_from_device_connector_name", #documentation needed
+    "this_net_to_device_refdes", #documentation needed
+    "this_net_to_device_channel_id", #documentation needed
+    "this_net_to_device_connector_name", #documentation needed
+    "this_channel_from_device_refdes",  # if channel, refdes of the device on one side of the channel
+    "this_channel_from_device_channel_id", #documentation needed
+    "this_channel_to_device_refdes",  # if channel, refdes of the device on the other side of the channel
+    "this_channel_to_device_channel_id", #documentation needed
+    "this_channel_from_channel_type", #documentation needed
+    "this_channel_to_channel_type", #documentation needed
+    "signal_of_channel_type", #documentation needed
+    "debug", #documentation needed
+    "debug_cutoff", #documentation needed
+]
+
+
+def new_instance(instance_name, instance_data, ignore_duplicates=False):
+    """
+    New Instance
+
+instances_list.new_instance(
+    instance_name,
+    instance_data,
+    ignore_duplicates=False
+)
+
+Add a new instance to your instances list.
+
+    instance_name is a string and must be unique within the list.
+    instance_data is a dictionary of columns (above). You may or may not include instance_name in this dict, though if you do and it doesn't match the argument, the code will fail.
+    Setting ignore_duplicates to True will cause the line to pass silently if you try to add an instance with an instance_name that already exists. By default, False, if you do this, the code will raise an error if you try to add a duplicate instance_name.
+
+    Args:
+        instance_name: string, must be unique within the list
+        instance_data: dictionary of columns (above)
+        ignore_duplicates: boolean, default False
+
+    Returns:
+        -1 if the instance was added successfully, otherwise raises an error
+    """
+    if instance_name in ["", None]:
+        raise ValueError(
+            "Argument 'instance_name' is blank and reqired to idenitify a unique instance"
+        )
+
+    if (
+        "instance_name" in instance_data
+        and instance_data["instance_name"] != instance_name
+    ):
+        raise ValueError(
+            f"Inconsistent instance_name: argument='{instance_name}' vs data['instance_name']='{instance_data['instance_name']}'"
+        )
+
+    if any(
+        row.get("instance_name") == instance_name
+        for row in fileio.read_tsv("instances list")
+    ):
+        if not ignore_duplicates:
+            raise ValueError(
+                f"An instance with the name '{instance_name}' already exists"
+            )
+        else:
+            return -1
+
+    if instance_data.get("net") is None:
+        try:
+            instance_data["net"] = state.net
+        except AttributeError:  # no net has been set
+            pass
+
+    # Add debug call chain
+    instance_data["debug"] = _get_call_chain_str()
+    instance_data["debug_cutoff"] = " "
+
+    # add argumet to data added
+    instance_data["instance_name"] = instance_name
+
+    with open(fileio.path("instances list"), "a", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=COLUMNS, delimiter="\t")
+        writer.writerow({key: instance_data.get(key, "") for key in COLUMNS})
+
+
+_instances_lock = Lock()
+
+
+def modify(instance_name, instance_data):
+    with _instances_lock:
+        path = fileio.path("instances list")
+
+        # --- Read once ---
+        with open(path, newline="", encoding="utf-8") as f:
+            reader = csv.DictReader(f, delimiter="\t")
+            rows = list(reader)
+            fieldnames = reader.fieldnames or []
+
+        # --- Add debug info before updating ---
+        instance_data["debug"] = _get_call_chain_str()
+        instance_data["debug_cutoff"] = " "
+
+        # Ensure any new keys are part of the header
+        for key in instance_data:
+            if key not in fieldnames:
+                fieldnames.append(key)
+
+        # --- Modify in-place ---
+        found = False
+        for row in rows:
+            if row.get("instance_name") == instance_name:
+                row.update(instance_data)
+                found = True
+                break
+
+        if not found:
+            raise ValueError(f"Instance '{instance_name}' not found")
+
+        # --- Write atomically ---
+        tmp = path + ".tmp"
+        with open(tmp, "w", newline="", encoding="utf-8") as f:
+            writer = csv.DictWriter(f, fieldnames=fieldnames, delimiter="\t")
+            writer.writeheader()
+            writer.writerows(rows)
+            f.flush()
+            os.fsync(f.fileno())
+
+        os.replace(tmp, path)
+
+
+def remove_instance(instance_to_delete):
+    instances_list = fileio.read_tsv("instances list")
+    new_list = []
+    for instance in instances_list:
+        if instance.get("instance_name") == instance_to_delete.get("instance_name"):
+            continue
+        new_list.append(instance)
+
+    with open(fileio.path("instances list"), "w", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=COLUMNS, delimiter="\t")
+        writer.writeheader()
+        writer.writerows(new_list)
+
+
+def new():
+    with open(fileio.path("instances list"), "w", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=COLUMNS, delimiter="\t")
+        writer.writeheader()
+        writer.writerows([])
+
+
+def assign_bom_line_numbers():
+    bom = []
+    for instance in fileio.read_tsv("instances list"):
+        if instance.get("bom_line_number") == "True":
+            if instance.get("mpn") == "":
+                raise ValueError(
+                    f"You've chosen to add {instance.get('instance_name')} to the bom, but haven't specified an MPN"
+                )
+            if instance.get("mpn") not in bom:
+                bom.append(instance.get("mpn"))
+
+    bom_line_number = 1
+    for bom_item in bom:
+        for instance in fileio.read_tsv("instances list"):
+            if instance.get("mpn") == bom_item:
+                modify(
+                    instance.get("instance_name"), {"bom_line_number": bom_line_number}
+                )
+        bom_line_number += 1
+
+
+def attribute_of(target_instance, attribute):
+    for instance in fileio.read_tsv("instances list"):
+        if instance.get("instance_name") == target_instance:
+            return instance.get(attribute)
+
+
+def instance_in_connector_group_with_item_type(connector_group, item_type):
+    if connector_group in ["", None]:
+        raise ValueError("Connector group is blank")
+    if item_type in ["", None]:
+        raise ValueError("Suffix is blank")
+    match = 0
+    output = None
+    for instance in fileio.read_tsv("instances list"):
+        if instance.get("connector_group") == connector_group:
+            if instance.get("item_type") == item_type:
+                match = match + 1
+                output = instance
+    if match == 0:
+        return 0
+    if match > 1:
+        raise ValueError(
+            f"Multiple instances found in connector_group '{connector_group}' with item type '{item_type}'."
+        )
+    return output
+
+
+def _get_call_chain_str():
+    """
+    Returns the call chain as a readable string:
+    filename:line in function -> filename:line in function ...
+    """
+    stack = inspect.stack()
+    chain_parts = []
+    for frame_info in reversed(stack[1:]):  # skip this function itself
+        filename = os.path.basename(frame_info.filename)
+        lineno = frame_info.lineno
+        function = frame_info.function
+        chain_parts.append(f"{filename}:{lineno} in {function}()")
+    return " -> ".join(chain_parts)
+
+
+def list_of_uniques(attribute):
+    output = []
+    for instance in fileio.read_tsv("instances list"):
+        if instance.get(attribute) not in output:
+            if instance.get(attribute) not in [None, ""]:
+                output.append(instance.get(attribute))
+    return output

harnice/lists/library_history.py

@@ -0,0 +1,40 @@
+import csv
+from harnice import fileio
+
+COLUMNS = [
+    "instance_name", #documentation needed
+    "mpn", #documentation needed
+    "item_type", #documentation needed
+    "lib_repo", #documentation needed
+    "lib_subpath", #documentation needed
+    "lib_desc", #documentation needed
+    "lib_latest_rev", #documentation needed
+    "lib_rev_used_here", #documentation needed
+    "lib_status", #documentation needed
+    "lib_releaseticket", #documentation needed
+    "lib_datestarted", #documentation needed
+    "lib_datemodified", #documentation needed
+    "lib_datereleased", #documentation needed
+    "lib_drawnby", #documentation needed
+    "lib_checkedby", #documentation needed
+    "project_editable_lib_modified", #documentation needed
+]
+
+
+def new():
+    with open(fileio.path("library history"), "w", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=COLUMNS, delimiter="\t")
+        writer.writeheader()
+        writer.writerows([])
+
+
+def append(instance_name, instance_data):
+    instance_data["instance_name"] = instance_name
+    for row in fileio.read_tsv("library history"):
+        if row.get("instance name") == instance_name:
+            raise ValueError(
+                f"You're trying to import something with instance_name '{instance_name}' but it has already been imported."
+            )
+    with open(fileio.path("library history"), "a", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=COLUMNS, delimiter="\t")
+        writer.writerow({key: instance_data.get(key, "") for key in COLUMNS})

harnice/lists/manifest.py

@@ -0,0 +1,93 @@
+import os
+import csv
+from harnice import fileio
+
+COLUMNS = [
+    "net", #documentation needed
+    "harness_pn", #documentation needed
+]
+
+
+def new():
+    """
+    Synchronize the system harness manifest with the system connector list:
+      - Remove nets that no longer exist in the connector list
+      - Add nets that appear in the connector list but not yet in the manifest
+      - Preserve all other column data for nets that still exist
+    """
+    # Load connector list and extract unique nets
+    connector_nets = {
+        row.get("net", "").strip()
+        for row in fileio.read_tsv("system connector list")
+        if row.get("net")
+    }
+
+    manifest_path = fileio.path("harness manifest")
+
+    # Load existing manifest if present
+    existing_manifest = []
+    manifest_nets = set()
+    try:
+        existing_manifest = fileio.read_tsv("harness manifest")
+        manifest_nets = {
+            row.get("net", "").strip() for row in existing_manifest if row.get("net")
+        }
+    except FileNotFoundError:
+        existing_manifest = []
+        manifest_nets = set()
+
+    # Determine differences
+    nets_to_add = connector_nets - manifest_nets
+    nets_to_keep = manifest_nets & connector_nets
+
+    # Preserve existing info for kept nets
+    updated_manifest = [
+        row for row in existing_manifest if row.get("net") in nets_to_keep
+    ]
+
+    # Add new rows for new nets
+    for net in sorted(nets_to_add):
+        updated_manifest.append({"net": net})
+
+    # Sort by net name for consistency
+    updated_manifest = sorted(updated_manifest, key=lambda r: r.get("net", ""))
+
+    # Write updated manifest
+    with open(manifest_path, "w", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=COLUMNS, delimiter="\t")
+        writer.writeheader()
+        for row in updated_manifest:
+            full_row = {col: row.get(col, "") for col in COLUMNS}
+            writer.writerow(full_row)
+
+
+def update_upstream(path_to_system_rev, system_pn_rev, manifest_nets, harness_pn):
+    manifest_path = os.path.join(
+        path_to_system_rev,
+        "lists",
+        f"{system_pn_rev[0]}-{system_pn_rev[1]}-harness_manifest.tsv",
+    )
+
+    # Read existing manifest
+    with open(manifest_path, newline="", encoding="utf-8") as f:
+        reader = csv.DictReader(f, delimiter="\t")
+        manifest = list(reader)
+        fieldnames = reader.fieldnames
+
+    # --- Pass 1: update matching nets ---
+    for net in manifest_nets:
+        for row in manifest:
+            if row.get("net") == net:
+                row["harness_pn"] = harness_pn
+                break
+
+    # --- Pass 2: remove outdated links ---
+    for row in manifest:
+        if row.get("harness_pn") == harness_pn and row.get("net") not in manifest_nets:
+            row["harness_pn"] = ""
+
+    # Write back updated manifest
+    with open(manifest_path, "w", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=fieldnames, delimiter="\t")
+        writer.writeheader()
+        writer.writerows(manifest)

harnice/lists/post_harness_instances_list.py

@@ -0,0 +1,66 @@
+import os
+import csv
+import shutil
+from harnice import fileio
+from harnice.lists import instances_list
+
+
+def rebuild():
+    """
+    Build the 'post harness instances list' by merging instance data from:
+      - Each harness's instances list if the harness_pn is defined and file exists
+      - Otherwise, fall back to the system-level instances list for matching nets
+
+    Writes a clean TSV with INSTANCES_LIST_COLUMNS.
+    """
+
+    post_harness_instances = []
+
+    # --- iterate through manifest rows ---
+    for harness in fileio.read_tsv("harness manifest"):
+        harness_pn = (harness.get("harness_pn") or "").strip()
+        net = (harness.get("net") or "").strip()
+        if not net:
+            continue
+
+        # Case 1: harness_pn missing -> import from system instances
+        if not harness_pn:
+            for system_instance in fileio.read_tsv("instances list"):
+                if system_instance.get("net", "").strip() == net:
+                    post_harness_instances.append(system_instance)
+            continue
+
+        # Case 2: harness_pn provided -> try to load harness instances list
+        harness_instances_list_path = os.path.join(
+            fileio.dirpath("harnesses"),
+            f"{harness_pn}-instances_list.tsv",
+        )
+
+        if os.path.exists(harness_instances_list_path):
+            post_harness_instances.extend(fileio.read_tsv(harness_instances_list_path))
+        else:
+            # Fallback to system-level instances for same net
+            for system_instance in fileio.read_tsv("instances list"):
+                if system_instance.get("net", "").strip() == net:
+                    post_harness_instances.append(system_instance)
+
+    # --- Determine fieldnames dynamically ---
+    fieldnames = set()
+    for instance in post_harness_instances:
+        fieldnames.update(instance.keys())
+
+    # --- Write TSV file ---
+    with open(
+        fileio.path("post harness instances list"), "w", newline="", encoding="utf-8"
+    ) as f:
+        writer = csv.DictWriter(f, fieldnames=instances_list.COLUMNS, delimiter="\t")
+        writer.writeheader()
+        for instance in post_harness_instances:
+            writer.writerow({k: instance.get(k, "") for k in fieldnames})
+
+
+def push(path_to_system_rev, system_pn_rev):
+    path_to_harness_dir_of_system = os.path.join(
+        path_to_system_rev, f"{system_pn_rev[0]}-{system_pn_rev[1]}", "harnesses"
+    )
+    shutil.copy(fileio.path("instances list"), path_to_harness_dir_of_system)