sigil-stitch 0.5.2

Type-safe, import-aware, width-aware code generation for multiple languages
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

use sigil_stitch::code_block::CodeBlock;
use sigil_stitch::lang::python::Python;
use sigil_stitch::spec::file_spec::FileSpec;
use sigil_stitch::spec::fun_spec::FunSpec;
use sigil_stitch::spec::modifiers::TypeKind;
use sigil_stitch::spec::parameter_spec::ParameterSpec;
use sigil_stitch::spec::type_spec::TypeSpec;
use sigil_stitch::type_name::TypeName;

use super::golden;

#[test]
fn test_top_level_function() {
    let json_dumps = TypeName::importable("json", "dumps");

    let file = FileSpec::builder_with("utils.py", Python::new())
        .add_function(
            FunSpec::builder("serialize")
                .doc("Serialize an object to JSON.")
                .add_param(ParameterSpec::new("value", TypeName::primitive("object")).unwrap())
                .returns(TypeName::primitive("str"))
                .body(CodeBlock::of("return %T(value)", (json_dumps,)).unwrap())
                .build()
                .unwrap(),
        )
        .build()
        .unwrap();

    let output = file.render(80).unwrap();
    golden::assert_golden("python/top_level_function.py", &output);
}

#[test]
fn test_function_with_doc() {
    let body = CodeBlock::of("return f\"Hello, {name}!\"", ()).unwrap();
    let fun = FunSpec::builder("greet")
        .doc("Greet the user by name.")
        .add_param(ParameterSpec::new("name", TypeName::primitive("str")).unwrap())
        .returns(TypeName::primitive("str"))
        .body(body)
        .build()
        .unwrap();

    let file = FileSpec::builder("greet.py")
        .add_function(fun)
        .build()
        .unwrap();
    let output = file.render(80).unwrap();

    golden::assert_golden("python/function_with_doc.py", &output);
}

#[test]
fn test_static_method_no_keyword() {
    let body = CodeBlock::of("return cls(name, age)", ()).unwrap();

    let ts = TypeSpec::builder("User", TypeKind::Class)
        .add_method(
            FunSpec::builder("from_dict")
                .is_static()
                .annotation(CodeBlock::of("@classmethod", ()).unwrap())
                .add_param(ParameterSpec::new("cls", TypeName::primitive("")).unwrap())
                .add_param(ParameterSpec::new("name", TypeName::primitive("str")).unwrap())
                .add_param(ParameterSpec::new("age", TypeName::primitive("int")).unwrap())
                .returns(TypeName::primitive("User"))
                .body(body)
                .build()
                .unwrap(),
        )
        .build()
        .unwrap();

    let file = FileSpec::builder_with("user.py", Python::new())
        .add_type(ts)
        .build()
        .unwrap();
    let output = file.render(80).unwrap();

    golden::assert_golden("python/static_method.py", &output);
}