dissolve-python 0.3.0

A tool to dissolve deprecated calls in Python codebases
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
// Tests for all magic method migrations

use crate::migrate_ruff::migrate_file;
use crate::type_introspection_context::TypeIntrospectionContext;
use crate::{RuffDeprecatedFunctionCollector, TypeIntrospectionMethod};
use std::collections::HashMap;
use std::path::Path;

#[test]
fn test_repr_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __repr__(self):
        return self.debug_representation()

obj = MyClass()
result = repr(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // repr(obj) should be replaced with obj.debug_representation()
    assert!(migrated.contains("result = obj.debug_representation()"));
}

#[test]
fn test_bool_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __bool__(self):
        return self.is_valid()

obj = MyClass()
result = bool(obj)
if obj:  # This won't be migrated in this implementation
    pass
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // bool(obj) should be replaced with obj.is_valid()
    assert!(migrated.contains("result = obj.is_valid()"));
    // if obj: is not migrated in this implementation
    assert!(migrated.contains("if obj:"));
}

#[test]
fn test_int_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __int__(self):
        return self.to_integer()

obj = MyClass()
result = int(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // int(obj) should be replaced with obj.to_integer()
    assert!(migrated.contains("result = obj.to_integer()"));
}

#[test]
fn test_float_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __float__(self):
        return float(self.get_value())

obj = MyClass()
result = float(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // float(obj) should be replaced with self.get_value() (unwrapped from float())
    assert!(migrated.contains("result = obj.get_value()"));
}

#[test]
fn test_bytes_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __bytes__(self):
        return self.to_bytes()

obj = MyClass()
result = bytes(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // bytes(obj) should be replaced with obj.to_bytes()
    assert!(migrated.contains("result = obj.to_bytes()"));
}

#[test]
fn test_hash_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __hash__(self):
        return hash(self.get_key())

obj = MyClass()
result = hash(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // hash(obj) should be replaced with self.get_key() (unwrapped from hash())
    assert!(migrated.contains("result = obj.get_key()"));
}

#[test]
fn test_len_magic_method_migration() {
    let source = r#"
from dissolve import replace_me

class MyContainer:
    @replace_me()
    def __len__(self):
        return self.size()

container = MyContainer()
length = len(container)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    // Create test context with proper workspace root for LSP
    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = TypeIntrospectionContext::new_with_workspace(
        TypeIntrospectionMethod::PyrightLsp,
        Some(&test_ctx.workspace_root()),
    )
    .unwrap();

    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // len(container) should be replaced with container.size()
    assert!(migrated.contains("length = container.size()"));
}

#[test]
fn test_mixed_magic_methods() {
    // Test multiple magic methods in the same class
    let source = r#"
from dissolve import replace_me

class MyClass:
    @replace_me()
    def __str__(self):
        return self.display()
    
    @replace_me()
    def __repr__(self):
        return repr(self.debug_info())
    
    @replace_me()
    def __int__(self):
        return int(self.value)

obj = MyClass()
s = str(obj)
r = repr(obj)
i = int(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // Check all migrations
    assert!(migrated.contains("s = obj.display()"));
    assert!(migrated.contains("r = obj.debug_info()")); // unwrapped from repr()
    assert!(migrated.contains("i = int(obj.value)")); // replacement preserves int() call
}

#[test]
fn test_magic_method_without_decorator_not_migrated() {
    // Test that magic methods without @replace_me are not migrated
    let source = r#"
class MyClass:
    def __str__(self):
        return "string"
    
    def __repr__(self):
        return "repr"
    
    def __bool__(self):
        return True

obj = MyClass()
s = str(obj)
r = repr(obj)
b = bool(obj)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    let test_ctx = crate::tests::test_utils::TestContext::new(source);
    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    // Should remain unchanged
    assert_eq!(source, migrated);
}

#[test]
fn test_magic_method_with_complex_expressions() {
    let source = r#"
from dissolve import replace_me
from __future__ import annotations

class Item:
    @replace_me()
    def __str__(self) -> str:
        return self.name()
    
    @replace_me()
    def __int__(self) -> int:
        return self.count()

class Container:
    def __init__(self) -> None:
        self.item: Item = Item()

container: Container = Container()

# Attribute access
s = str(container.item)
i = int(container.item)

# In expressions
result = "Item: " + str(container.item)
total = 10 + int(container.item)
"#;

    let collector = RuffDeprecatedFunctionCollector::new("test_module".to_string(), None);
    let result = collector.collect_from_source(source.to_string()).unwrap();

    // Create a real temporary file for type introspection to work
    let test_ctx = crate::tests::test_utils::TestContext::new(source);

    let mut type_context = test_ctx.create_type_context(TypeIntrospectionMethod::PyrightLsp);
    let migrated = migrate_file(
        source,
        "test_module",
        Path::new(&test_ctx.file_path),
        &mut type_context,
        result.replacements,
        HashMap::new(),
    )
    .unwrap();
    type_context.shutdown().unwrap();

    println!("Migrated output:\n{}", migrated);

    // Check migrations
    assert!(migrated.contains("s = container.item.name()"));
    assert!(migrated.contains("i = container.item.count()"));
    assert!(migrated.contains("\"Item: \" + container.item.name()"));
    assert!(migrated.contains("10 + container.item.count()"));
}