Skip to content

types_

ruff_sync.tui.types_

Data types for the TUI.

ConfigNode

Bases: Protocol

Protocol for TUI Configuration Nodes.

Source code in src/ruff_sync/tui/types_.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@runtime_checkable
class ConfigNode(Protocol):
    """Protocol for TUI Configuration Nodes."""

    @property
    def key(self) -> str:
        """The key or label for this node."""
        ...

    @property
    def path(self) -> str:
        """The full configuration path."""
        ...

    def children(self) -> list[ConfigNode]:
        """Child nodes for tree expansion."""
        ...

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """Returns the documentation target and type."""
        ...

key property 

key

The key or label for this node.

path property 

path

The full configuration path.

children 

children()

Child nodes for tree expansion.

Source code in src/ruff_sync/tui/types_.py 
27
28
29
def children(self) -> list[ConfigNode]:
    """Child nodes for tree expansion."""
    ...

doc_target 

doc_target()

Returns the documentation target and type.

Source code in src/ruff_sync/tui/types_.py 
31
32
33
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """Returns the documentation target and type."""
    ...

DictNode

A node representing a dictionary in the configuration.

Source code in src/ruff_sync/tui/types_.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class DictNode:
    """A node representing a dictionary in the configuration."""

    def __init__(self, key: str, path: str, data: dict[str, Any]) -> None:
        """Initialize the Dictionary Node."""
        self._key = key
        self._path = path
        self.data = data

    @property
    def key(self) -> str:
        """Get the node's key."""
        return self._key

    @property
    def path(self) -> str:
        """Get the node's configuration path."""
        return self._path

    def children(self) -> list[ConfigNode]:
        """Return the dictionary children wrapped as ConfigNodes."""
        return [wrap_data(k, v, f"{self.path}.{k}") for k, v in sorted(self.data.items())]

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """Resolve the primary target string and type for documentation."""
        if self._path == "tool.ruff":
            return ("", "none")
        return (self._path, "config")

data instance-attribute 

data = data

key property 

key

Get the node's key.

path property 

path

Get the node's configuration path.

__init__ 

__init__(key, path, data)

Initialize the Dictionary Node.

Source code in src/ruff_sync/tui/types_.py 
39
40
41
42
43
def __init__(self, key: str, path: str, data: dict[str, Any]) -> None:
    """Initialize the Dictionary Node."""
    self._key = key
    self._path = path
    self.data = data

children 

children()

Return the dictionary children wrapped as ConfigNodes.

Source code in src/ruff_sync/tui/types_.py 
55
56
57
def children(self) -> list[ConfigNode]:
    """Return the dictionary children wrapped as ConfigNodes."""
    return [wrap_data(k, v, f"{self.path}.{k}") for k, v in sorted(self.data.items())]

doc_target 

doc_target()

Resolve the primary target string and type for documentation.

Source code in src/ruff_sync/tui/types_.py 
59
60
61
62
63
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """Resolve the primary target string and type for documentation."""
    if self._path == "tool.ruff":
        return ("", "none")
    return (self._path, "config")

ListNode

A node representing a list in the configuration.

Source code in src/ruff_sync/tui/types_.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
class ListNode:
    """A node representing a list in the configuration."""

    def __init__(self, key: str, path: str, data: list[Any]) -> None:
        """Initialize the List Node."""
        self._key = key
        self._path = path
        self.data = data

    @property
    def key(self) -> str:
        """Get the node's key."""
        return self._key

    @property
    def path(self) -> str:
        """Get the node's configuration path."""
        return self._path

    def children(self) -> list[ConfigNode]:
        """Return the list children wrapped as ConfigNodes."""
        return [
            wrap_data(
                str(v) if isinstance(v, str) and RULE_PATTERN.match(v) else f"[{i}]",
                v,
                f"{self.path}[{i}]",
            )
            for i, v in enumerate(self.data)
        ]

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """Resolve the primary target string and type for documentation."""
        return (self._path, "config")

data instance-attribute 

data = data

key property 

key

Get the node's key.

path property 

path

Get the node's configuration path.

__init__ 

__init__(key, path, data)

Initialize the List Node.

Source code in src/ruff_sync/tui/types_.py 
69
70
71
72
73
def __init__(self, key: str, path: str, data: list[Any]) -> None:
    """Initialize the List Node."""
    self._key = key
    self._path = path
    self.data = data

children 

children()

Return the list children wrapped as ConfigNodes.

Source code in src/ruff_sync/tui/types_.py 
85
86
87
88
89
90
91
92
93
94
def children(self) -> list[ConfigNode]:
    """Return the list children wrapped as ConfigNodes."""
    return [
        wrap_data(
            str(v) if isinstance(v, str) and RULE_PATTERN.match(v) else f"[{i}]",
            v,
            f"{self.path}[{i}]",
        )
        for i, v in enumerate(self.data)
    ]

doc_target 

doc_target()

Resolve the primary target string and type for documentation.

Source code in src/ruff_sync/tui/types_.py 
96
97
98
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """Resolve the primary target string and type for documentation."""
    return (self._path, "config")

ScalarNode

A node representing a scalar value in the configuration.

Source code in src/ruff_sync/tui/types_.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
class ScalarNode:
    """A node representing a scalar value in the configuration."""

    def __init__(self, key: str, path: str, value: Any) -> None:
        """Initialize the Scalar Node."""
        self._key = key
        self._path = path
        self.value = value

    @property
    def key(self) -> str:
        """Get the node's key."""
        return self._key

    @property
    def path(self) -> str:
        """Get the node's configuration path."""
        return self._path

    def children(self) -> list[ConfigNode]:
        """Return empty list, as scalars have no children."""
        return []

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """Resolve the primary target string and type for documentation."""
        if isinstance(self.value, str) and RULE_PATTERN.match(self.value):
            return (self.value, "rule")
        return (self._path, "config")

value instance-attribute 

value = value

key property 

key

Get the node's key.

path property 

path

Get the node's configuration path.

__init__ 

__init__(key, path, value)

Initialize the Scalar Node.

Source code in src/ruff_sync/tui/types_.py 
104
105
106
107
108
def __init__(self, key: str, path: str, value: Any) -> None:
    """Initialize the Scalar Node."""
    self._key = key
    self._path = path
    self.value = value

children 

children()

Return empty list, as scalars have no children.

Source code in src/ruff_sync/tui/types_.py 
120
121
122
def children(self) -> list[ConfigNode]:
    """Return empty list, as scalars have no children."""
    return []

doc_target 

doc_target()

Resolve the primary target string and type for documentation.

Source code in src/ruff_sync/tui/types_.py 
124
125
126
127
128
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """Resolve the primary target string and type for documentation."""
    if isinstance(self.value, str) and RULE_PATTERN.match(self.value):
        return (self.value, "rule")
    return (self._path, "config")

RulesCollectionNode

A node representing the root 'Effective Rule Status' section.

Source code in src/ruff_sync/tui/types_.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
class RulesCollectionNode:
    """A node representing the root 'Effective Rule Status' section."""

    def __init__(self, linters: list[RuffLinter], effective_rules: list[RuffRule]) -> None:
        """Initialize the Rules Collection Node."""
        self._key = "Effective Rule Status"
        self._path = "__rules__"
        self.linters = linters
        self.effective_rules = effective_rules

    @property
    def key(self) -> str:
        """Get the node's key."""
        return self._key

    @property
    def path(self) -> str:
        """Get the node's configuration path."""
        return self._path

    def children(self) -> list[ConfigNode]:
        """Return Linters as children."""
        return _build_linter_nodes(self.linters, self.effective_rules)

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """No documentation target for root collection."""
        return ("", "none")

linters instance-attribute 

linters = linters

effective_rules instance-attribute 

effective_rules = effective_rules

key property 

key

Get the node's key.

path property 

path

Get the node's configuration path.

__init__ 

__init__(linters, effective_rules)

Initialize the Rules Collection Node.

Source code in src/ruff_sync/tui/types_.py 
134
135
136
137
138
139
def __init__(self, linters: list[RuffLinter], effective_rules: list[RuffRule]) -> None:
    """Initialize the Rules Collection Node."""
    self._key = "Effective Rule Status"
    self._path = "__rules__"
    self.linters = linters
    self.effective_rules = effective_rules

children 

children()

Return Linters as children.

Source code in src/ruff_sync/tui/types_.py 
151
152
153
def children(self) -> list[ConfigNode]:
    """Return Linters as children."""
    return _build_linter_nodes(self.linters, self.effective_rules)

doc_target 

doc_target()

No documentation target for root collection.

Source code in src/ruff_sync/tui/types_.py 
155
156
157
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """No documentation target for root collection."""
    return ("", "none")

LinterNode

A node representing a category or linter group.

Source code in src/ruff_sync/tui/types_.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
class LinterNode:
    """A node representing a category or linter group."""

    def __init__(self, linter: RuffLinter, effective_rules: list[RuffRule]) -> None:
        """Initialize a Linter Node."""
        self.linter = linter
        name = linter["name"]
        prefix = linter.get("prefix")
        self._key = f"{name} ({prefix})" if prefix else name
        self._path = f"__linter__:{prefix}"
        self.effective_rules = effective_rules

    @property
    def key(self) -> str:
        """Get the node's key."""
        return self._key

    @property
    def path(self) -> str:
        """Get the node's configuration path."""
        return self._path

    def children(self) -> list[ConfigNode]:
        """Return subcategories of this Linter as children if they exist."""
        if "categories" in self.linter:
            return _build_linter_nodes(self.linter["categories"], self.effective_rules)
        return []

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """No documentation target for linter group itself."""
        return ("", "none")

linter instance-attribute 

linter = linter

effective_rules instance-attribute 

effective_rules = effective_rules

key property 

key

Get the node's key.

path property 

path

Get the node's configuration path.

__init__ 

__init__(linter, effective_rules)

Initialize a Linter Node.

Source code in src/ruff_sync/tui/types_.py 
163
164
165
166
167
168
169
170
def __init__(self, linter: RuffLinter, effective_rules: list[RuffRule]) -> None:
    """Initialize a Linter Node."""
    self.linter = linter
    name = linter["name"]
    prefix = linter.get("prefix")
    self._key = f"{name} ({prefix})" if prefix else name
    self._path = f"__linter__:{prefix}"
    self.effective_rules = effective_rules

children 

children()

Return subcategories of this Linter as children if they exist.

Source code in src/ruff_sync/tui/types_.py 
182
183
184
185
186
def children(self) -> list[ConfigNode]:
    """Return subcategories of this Linter as children if they exist."""
    if "categories" in self.linter:
        return _build_linter_nodes(self.linter["categories"], self.effective_rules)
    return []

doc_target 

doc_target()

No documentation target for linter group itself.

Source code in src/ruff_sync/tui/types_.py 
188
189
190
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """No documentation target for linter group itself."""
    return ("", "none")

RuleNode

A node representing an individual Ruff rule.

NOTE: Currently unused. In the read-only TUI, rule items are rendered directly as DataTable rows rather than populated as polymorphic ConfigNode tree elements, effectively stopping the tree hierarchy at the Linter/Category level to prevent UX clutter.

This class is retained as structural scaffolding for the future "Read-Write Interactive" phase. When building the Local Modification Engine, RuleNode will be necessary as an abstraction to hold state (e.g. toggled enabled/disabled, upstream drift provenance, and attached tomlkit inline comments) mapped back to the TOML tree.

Source code in src/ruff_sync/tui/types_.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
class RuleNode:
    """A node representing an individual Ruff rule.

    NOTE: Currently unused. In the read-only TUI, rule items are rendered
    directly as `DataTable` rows rather than populated as polymorphic
    `ConfigNode` tree elements, effectively stopping the tree hierarchy
    at the Linter/Category level to prevent UX clutter.

    This class is retained as structural scaffolding for the future
    "Read-Write Interactive" phase. When building the Local Modification
    Engine, `RuleNode` will be necessary as an abstraction to hold state
    (e.g. toggled enabled/disabled, upstream drift provenance, and
    attached `tomlkit` inline comments) mapped back to the TOML tree.
    """

    def __init__(self, rule: RuffRule) -> None:
        """Initialize a Rule Node."""
        self.rule = rule
        self._key = rule["code"]
        self._path = f"__rule__:{rule['code']}"

    @property
    def key(self) -> str:
        """Get the node's key."""
        return self._key

    @property
    def path(self) -> str:
        """Get the node's configuration path."""
        return self._path

    def children(self) -> list[ConfigNode]:
        """Return empty list; rules have no children."""
        return []

    def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
        """Target the rule exactly for documentation."""
        return (self.rule["code"], "rule")

rule instance-attribute 

rule = rule

key property 

key

Get the node's key.

path property 

path

Get the node's configuration path.

__init__ 

__init__(rule)

Initialize a Rule Node.

Source code in src/ruff_sync/tui/types_.py 
208
209
210
211
212
def __init__(self, rule: RuffRule) -> None:
    """Initialize a Rule Node."""
    self.rule = rule
    self._key = rule["code"]
    self._path = f"__rule__:{rule['code']}"

children 

children()

Return empty list; rules have no children.

Source code in src/ruff_sync/tui/types_.py 
224
225
226
def children(self) -> list[ConfigNode]:
    """Return empty list; rules have no children."""
    return []

doc_target 

doc_target()

Target the rule exactly for documentation.

Source code in src/ruff_sync/tui/types_.py 
228
229
230
def doc_target(self) -> tuple[str, Literal["rule", "config", "none"]]:
    """Target the rule exactly for documentation."""
    return (self.rule["code"], "rule")

wrap_data 

wrap_data(key, data, path='tool.ruff')

Wrap raw configuration data into strongly-typed ConfigNode instances.

Source code in src/ruff_sync/tui/types_.py 
257
258
259
260
261
262
263
def wrap_data(key: str, data: Any, path: str = "tool.ruff") -> ConfigNode:
    """Wrap raw configuration data into strongly-typed ConfigNode instances."""
    if isinstance(data, dict):
        return DictNode(key, path, data)
    if isinstance(data, list):
        return ListNode(key, path, data)
    return ScalarNode(key, path, data)