Skip to content

types

Type aliases for common callback and data patterns.

This module provides centralized type definitions for commonly used callback signatures and data structures throughout the snakesee codebase.

Classes

EstimateResult

Bases: TypedDict

Result of a time estimation calculation.

Source code in snakesee/types.py 
131
132
133
134
135
136
137
class EstimateResult(TypedDict):
    """Result of a time estimation calculation."""

    expected: float
    variance: float
    method: str
    confidence: float

EventDict

Bases: TypedDict

Structure of snakesee event records in .snakesee_events.jsonl.

Source code in snakesee/types.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class EventDict(TypedDict, total=False):
    """Structure of snakesee event records in .snakesee_events.jsonl."""

    event_type: str
    timestamp: float
    job_id: int | None
    rule_name: str | None
    wildcards: dict[str, str] | None
    threads: int | None
    resources: dict[str, Any] | None
    input_files: list[str] | None
    output_files: list[str] | None
    duration: float | None
    error_message: str | None
    completed_jobs: int | None
    total_jobs: int | None

JobEventData

Bases: TypedDict

Data structure for job-related events.

Source code in snakesee/types.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class JobEventData(TypedDict, total=False):
    """Data structure for job-related events."""

    event_type: str
    timestamp: float
    job_id: int | None
    rule_name: str | None
    wildcards: dict[str, str] | None
    threads: int | None
    resources: dict[str, Any] | None
    input_files: list[str] | None
    output_files: list[str] | None
    duration: float | None
    error_message: str | None

MetadataDict

Bases: TypedDict

Structure of Snakemake metadata JSON files.

Source code in snakesee/types.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
class MetadataDict(TypedDict, total=False):
    """Structure of Snakemake metadata JSON files."""

    starttime: float
    endtime: float
    rule: str
    input: list[str]
    output: list[str]
    params: dict[str, Any]
    wildcards: dict[str, str]
    resources: dict[str, Any]
    code: str
    version: str
    log: list[str]

ProgressEventData

Bases: TypedDict

Data structure for progress events.

Source code in snakesee/types.py 
71
72
73
74
75
76
77
class ProgressEventData(TypedDict):
    """Data structure for progress events."""

    event_type: str
    timestamp: float
    completed_jobs: int
    total_jobs: int

SnakemakeLogMessage

Bases: TypedDict

Base structure for Snakemake log handler messages.

All fields are optional since different log levels provide different data.

Source code in snakesee/types.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class SnakemakeLogMessage(TypedDict, total=False):
    """Base structure for Snakemake log handler messages.

    All fields are optional since different log levels provide different data.
    """

    level: str
    jobid: int
    name: str
    rule: str
    wildcards: Any  # Can be object with __dict__ or dict
    threads: int
    resources: Any  # Can be object with __dict__ or dict
    input: list[str] | tuple[str, ...]
    output: list[str] | tuple[str, ...]
    done: int
    total: int
    msg: str
    message: str

TimingRecord

Bases: NamedTuple

A single timing measurement with its timestamp.

Attributes:

Name Type Description
duration float

Duration of the operation in seconds.
timestamp float

Unix timestamp when the operation completed.
Source code in snakesee/types.py 
17
18
19
20
21
22
23
24
25
26
class TimingRecord(NamedTuple):
    """A single timing measurement with its timestamp.

    Attributes:
        duration: Duration of the operation in seconds.
        timestamp: Unix timestamp when the operation completed.
    """

    duration: float
    timestamp: float

WorkflowEventData

Bases: TypedDict

Data structure for workflow lifecycle events.

Source code in snakesee/types.py 
80
81
82
83
84
class WorkflowEventData(TypedDict):
    """Data structure for workflow lifecycle events."""

    event_type: str
    timestamp: float