sqry-lang-python 8.0.4

python language plugin for sqry
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
64
65
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
99
100
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
129
130
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
158
159
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
191
192
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use sqry_core::graph::GraphBuilder;
/// Property node tests for Python
/// Tests @property decorator detection and property node creation
use sqry_core::graph::Language;
use sqry_core::graph::unified::build::{StagingGraph, StagingOp};
use sqry_core::graph::unified::node::NodeKind;
use sqry_lang_python::relations::PythonGraphBuilder;
use std::collections::HashMap;
use std::path::Path;
use tree_sitter::Parser;

fn parse_python(source: &str) -> tree_sitter::Tree {
    let mut parser = Parser::new();
    parser
        .set_language(&tree_sitter_python::LANGUAGE.into())
        .expect("Error loading Python grammar");
    parser.parse(source, None).expect("Error parsing")
}

/// Build a string lookup table from staging operations.
fn build_string_lookup(staging: &StagingGraph) -> HashMap<u32, String> {
    let mut lookup = HashMap::new();
    for op in staging.operations() {
        if let StagingOp::InternString { local_id, value } = op {
            lookup.insert(local_id.index(), value.clone());
        }
    }
    lookup
}

/// Count property nodes in staging graph.
fn count_property_nodes(staging: &StagingGraph) -> usize {
    staging
        .operations()
        .iter()
        .filter(|op| {
            matches!(
                op,
                StagingOp::AddNode {
                    entry,
                    ..
                } if entry.kind == NodeKind::Property
            )
        })
        .count()
}

/// Find a property node by name pattern.
fn find_property_node(staging: &StagingGraph, name_pattern: &str) -> Option<String> {
    for op in staging.operations() {
        if let StagingOp::AddNode { entry, .. } = op
            && entry.kind == NodeKind::Property
            && let Some(node_name) = staging.resolve_node_canonical_name(entry)
            && node_name.contains(name_pattern)
        {
            return Some(node_name.to_string());
        }
    }
    None
}

/// Find a property display/native name by name pattern.
fn find_property_display_name(staging: &StagingGraph, name_pattern: &str) -> Option<String> {
    for op in staging.operations() {
        if let StagingOp::AddNode { entry, .. } = op
            && entry.kind == NodeKind::Property
            && let Some(node_name) = staging.resolve_node_display_name(Language::Python, entry)
            && node_name.contains(name_pattern)
        {
            return Some(node_name);
        }
    }
    None
}

/// Find the visibility of a property by name.
fn find_property_visibility(staging: &StagingGraph, name: &str) -> Option<String> {
    let strings = build_string_lookup(staging);
    for op in staging.operations() {
        if let StagingOp::AddNode { entry, .. } = op
            && entry.kind == NodeKind::Property
        {
            let node_name = staging.resolve_node_canonical_name(entry);
            if node_name.is_some_and(|n| n.contains(name)) {
                return entry
                    .visibility
                    .and_then(|id| strings.get(&id.index()).cloned());
            }
        }
    }
    None
}

#[test]
fn test_property_simple() {
    let source = r"
class User:
    @property
    def name(self):
        return self._name
";
    let tree = parse_python(source);
    let file = Path::new("test_property_simple.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 1,
        "Expected 1 property node for @property decorated method, got {property_count}"
    );

    let property_name = find_property_node(&staging, "name");
    assert!(
        property_name.is_some(),
        "Expected to find property node 'name'"
    );
    assert!(property_name.unwrap().contains("User::name"));

    let display_name = find_property_display_name(&staging, "name");
    assert!(
        display_name.is_some(),
        "Expected to find property display name 'name'"
    );
    assert!(display_name.unwrap().contains("User.name"));
}

#[test]
fn test_property_with_setter() {
    let source = r"
class User:
    @property
    def email(self):
        return self._email

    @email.setter
    def email(self, value):
        self._email = value
";
    let tree = parse_python(source);
    let file = Path::new("test_property_setter.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    // Should have 1 property node for getter, 1 method for setter
    // (setter is technically a method, not a property in our model)
    let property_count = count_property_nodes(&staging);
    assert!(
        property_count >= 1,
        "Expected at least 1 property node for @property getter, got {property_count}"
    );
}

#[test]
fn test_property_with_type_annotation() {
    let source = r"
class Person:
    @property
    def age(self) -> int:
        return self._age
";
    let tree = parse_python(source);
    let file = Path::new("test_property_typed.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 1,
        "Expected 1 property node with type annotation, got {property_count}"
    );

    let property_name = find_property_node(&staging, "age");
    assert!(property_name.is_some(), "Expected to find property 'age'");
}

#[test]
fn test_multiple_properties() {
    let source = r"
class Rectangle:
    @property
    def width(self):
        return self._width

    @property
    def height(self):
        return self._height

    @property
    def area(self):
        return self.width * self.height
";
    let tree = parse_python(source);
    let file = Path::new("test_multiple_properties.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 3,
        "Expected 3 property nodes (width, height, area), got {property_count}"
    );

    assert!(find_property_node(&staging, "width").is_some());
    assert!(find_property_node(&staging, "height").is_some());
    assert!(find_property_node(&staging, "area").is_some());
}

#[test]
fn test_property_visibility_public() {
    let source = r"
class Config:
    @property
    def value(self):
        return self._value
";
    let tree = parse_python(source);
    let file = Path::new("test_property_public.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let visibility = find_property_visibility(&staging, "value");
    assert_eq!(
        visibility,
        Some("public".to_string()),
        "Expected public visibility for property 'value'"
    );
}

#[test]
fn test_property_visibility_protected() {
    let source = r"
class Internal:
    @property
    def _config(self):
        return self.__config
";
    let tree = parse_python(source);
    let file = Path::new("test_property_protected.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let visibility = find_property_visibility(&staging, "_config");
    assert_eq!(
        visibility,
        Some("protected".to_string()),
        "Expected protected visibility for property '_config'"
    );
}

#[test]
fn test_property_mixed_with_methods() {
    let source = r"
class Account:
    @property
    def balance(self):
        return self._balance

    def deposit(self, amount):
        self._balance += amount

    @property
    def status(self):
        return 'active' if self.balance > 0 else 'inactive'
";
    let tree = parse_python(source);
    let file = Path::new("test_mixed_property_methods.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 2,
        "Expected 2 property nodes (balance, status), got {property_count}"
    );

    // Verify method is not counted as property
    let strings = build_string_lookup(&staging);
    let method_count = staging
        .operations()
        .iter()
        .filter(|op| {
            if let StagingOp::AddNode { entry, .. } = op
                && entry.kind == NodeKind::Method
                && let Some(name) = strings.get(&entry.name.index())
            {
                return name.contains("deposit");
            }
            false
        })
        .count();
    assert_eq!(
        method_count, 1,
        "Expected 1 method node (deposit), got {method_count}"
    );
}

#[test]
fn test_property_in_nested_class() {
    let source = r"
class Outer:
    class Inner:
        @property
        def nested_prop(self):
            return 'nested'
";
    let tree = parse_python(source);
    let file = Path::new("test_nested_property.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 1,
        "Expected 1 property node in nested class, got {property_count}"
    );

    let property_name = find_property_node(&staging, "nested_prop");
    assert!(
        property_name.is_some(),
        "Expected to find nested property 'nested_prop'"
    );
}

#[test]
fn test_regular_method_not_property() {
    let source = r"
class Service:
    def get_data(self):
        return self.data

    def set_data(self, value):
        self.data = value
";
    let tree = parse_python(source);
    let file = Path::new("test_not_property.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 0,
        "Expected 0 property nodes (no @property decorator), got {property_count}"
    );
}

#[test]
fn test_property_with_deleter() {
    let source = r"
class Resource:
    @property
    def handle(self):
        return self._handle

    @handle.setter
    def handle(self, value):
        self._handle = value

    @handle.deleter
    def handle(self):
        del self._handle
";
    let tree = parse_python(source);
    let file = Path::new("test_property_deleter.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert!(
        property_count >= 1,
        "Expected at least 1 property node (getter), got {property_count}"
    );
}

#[test]
fn test_property_with_complex_return_type() {
    let source = r"
from typing import Optional, List

class DataStore:
    @property
    def items(self) -> Optional[List[str]]:
        return self._items
";
    let tree = parse_python(source);
    let file = Path::new("test_property_complex_type.py");
    let mut staging = StagingGraph::new();
    let builder = PythonGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), file, &mut staging)
        .expect("build graph should succeed");

    let property_count = count_property_nodes(&staging);
    assert_eq!(
        property_count, 1,
        "Expected 1 property node with complex type, got {property_count}"
    );
}