Skip to content
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.

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

Add a retarget_snrefs() utility function #374

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion odxtools/utils.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,48 @@
# SPDX-License-Identifier: MIT
import dataclasses
import re
from typing import Any, Dict
from typing import TYPE_CHECKING, Any, Dict, Optional

if TYPE_CHECKING:
from .database import Database
from .diaglayers.diaglayer import DiagLayer
from .snrefcontext import SnRefContext


def retarget_snrefs(database: "Database",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing unit test/coverage

diag_layer: "DiagLayer",
context: Optional["SnRefContext"] = None) -> None:
"""Re-resolve the short name references reachable by a
DiagLayer to this DiagLayer

This implies that after the SNREFs have been retargeted, accessing
the resolved objects via a different diagnostic layer might not be
correct. E.g.: If the ECU variants "V1" and "V2" are derived from
the base variant "BV", BV defines a short name reference to a data
object property called "Foo" and V1 and V2 both define a "Foo"
DOP, the reference in the base variant to Foo ought to be resolved
differently depending on whether it is accessed via V1 or
V2. Since odxtools resolves all references ahead of time, a fixed
variant has to be chosen. This method allows to switch the variant
to another one.

"""
from .snrefcontext import SnRefContext

if context is None:
context = SnRefContext()

if context.diag_layer is None:
context.database = database
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why only assign database in the check of diag layer?

context.diag_layer = diag_layer

# retarget the objects "owned" by the layer itself
diag_layer._resolve_snrefs(context)

# retarget all parents of the current layer (if any)
if (parent_refs := getattr(diag_layer, "parent_refs", None)) is not None:
for pr in parent_refs:
retarget_snrefs(database, pr.layer, context)


def dataclass_fields_asdict(obj: Any) -> Dict[str, Any]:
Expand Down
Loading