bridge.pipelines.policies.gh2bt package

bridge.pipelines.policies.gh2bt package#

Public Interface#

This section documents user-facing interface of the bridge.pipelines.policies.gh2bt package (as defined in its __init__.py file).

Functions#

reconcile_gh_over_bt(*, gh_norm, bt_norm, ...)

Apply a generic GitHub-over-bio.tools reconciliation policy.

Generic reconciliation policies for GitHub to bio.tools mapping.

bridge.pipelines.policies.gh2bt.reconcile_gh_over_bt(*, gh_norm, bt_norm, bt_value, build_bt_from_gh, log_label, equality_fn=None)[source]#

Apply a generic GitHub-over-bio.tools reconciliation policy.

This function operates on normalized representations of GitHub and bio.tools values (gh_norm and bt_norm), while returning and constructing concrete bio.tools values (bt_value and the output).

Policy: 1. If gh_norm is None, GitHub is treated as silent and the existing

bio.tools value (bt_value) is preserved. An “unchanged” log entry is emitted.

  1. If gh_norm is not None and bt_norm is None, GitHub is treated as the only source. A new bio.tools value is constructed via build_bt_from_gh(gh_norm) and an “added” log entry is emitted.

  2. If both gh_norm and bt_norm are not None and they compare equal (gh_norm == bt_norm), the existing bio.tools value (bt_value) is preserved and an exact-match log entry is emitted.

  3. If both gh_norm and bt_norm are not None and differ, the GitHub value is treated as authoritative. A new bio.tools value is constructed via build_bt_from_gh(gh_norm) and a conflict log entry is emitted.

Parameters:

  • gh_norm (GHN | None) – Normalized representation of the GitHub value (e.g., canonicalized URL, lowercased language set, enum, etc.), or None if GitHub provides no usable value.

  • bt_norm (BTN | None) – Normalized representation of the existing bio.tools value, or None if no value is recorded.

  • bt_value (BT | None) – The current bio.tools value to be preserved when GitHub is silent or when the normalized values match.

  • build_bt_from_gh (Callable[[GHN], BT]) – Callable that constructs a concrete bio.tools value from the normalized GitHub representation.

  • log_label (str) – Short label used in log messages to identify the reconciled field (e.g., "license", "languages", "homepage").

  • equality_fn (Callable[[GHN, BTN], bool] | None, optional) – Optional callable to determine equality between normalized GitHub and bio.tools values. If None, the default equality operator (==) is used. This parameter is useful when the normalized representations require custom comparison logic (e.g., set equality for lists).

Returns:

The reconciled bio.tools value according to the policy, or None if both sources effectively provide no usable value.

Return type:

BT | None

Submodules#

reconcile_gh_over_bt

Apply a generic GitHub-over-bio.tools reconciliation policy.

Dependencies diagram#

Each architecture diagram below visualizes the internal dependency structure of the bridge.pipelines.policies.gh2bt package. It shows how modules and subpackages within the package depend on each other, based on direct Python imports.

  • Packages are shown as purple rectangles

  • Modules are shown as pink rectangles

  • Arrows (A → B) indicate that A directly imports B

Each subpackage’s diagram focuses only on its own internal structure, it does not include imports to or from higher-level packages (those appear in the parent package’s diagram).

bridge package dependencies
Contents