Skip to content

feat: add the metadata interface to the reporter class #6

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Jul 29, 2025
Merged

feat: add the metadata interface to the reporter class #6

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
31e538c
Add the metadata interface to the reporter class
LKress Mar 16, 2025
cb00971
Remove MetadataRecordInterface
LKress Apr 25, 2025
592243d
Update reporter.py
johanneskoester Apr 28, 2025
0370982
refactor: Check that report metadate is a single level dict
LKress Jul 11, 2025
e487225
Format with black
LKress Jul 11, 2025
214535a
Break too long line in reporter.py
LKress Jul 11, 2025
cc9580b
Merge branch 'snakemake:main' into feat/issue-5
LKress Jul 20, 2025
09e170a
Remove metadata dictionary validation
LKress Jul 23, 2025
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
7 changes: 7 additions & 0 deletions snakemake_interface_report_plugins/interfaces.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ def is_other(self) -> bool: ...
def id(self) -> str: ...


class MetadataRecordInterface(ABC):

@property
@abstractmethod
def parse_yte(self) -> dict: ...


class RuleRecordInterface(ABC):
@property
@abstractmethod
Expand Down
3 changes: 3 additions & 0 deletions snakemake_interface_report_plugins/reporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
ConfigFileRecordInterface,
JobRecordInterface,
RuleRecordInterface,
MetadataRecordInterface,
)
from snakemake_interface_report_plugins.settings import ReportSettingsBase
from snakemake_interface_report_plugins.interfaces import DAGReportInterface
Expand All @@ -27,6 +28,7 @@ def __init__(
jobs: List[JobRecordInterface],
settings: ReportSettingsBase,
workflow_description: str,
metadata: MetadataRecordInterface,
dag: DAGReportInterface,
):
self.rules = rules
Expand All @@ -35,6 +37,7 @@ def __init__(
self.configfiles = configfiles
self.settings = settings
self.workflow_description = workflow_description
self.metadata = metadata
self.dag = dag

self.__post_init__()
Expand Down