openapi_nexus/generators/python/requests/
emit_models.rs

1//! Model emission for IR schemas (Python dataclasses/enums/aliases).
2//!
3//! Uses sigil-stitch high-level APIs (TypeSpec, FieldSpec, FunSpec, TypeName,
4//! sigil_quote!) for structured code generation with automatic import tracking.
5//! Each schema produces one `.py` file via `FileSpec`.
6
7use crate::codegen::traits::file_writer::FileInfo;
8use crate::ir::types::{
9    IrEnum, IrEnumValueType, IrIntersection, IrObject, IrPrimitive, IrProperty, IrSchema,
10    IrSchemaKind, IrSpec, IrTaggedUnion, IrTaggedVariant, IrTypeExpr, IrUnion, TaggingStyle,
11};
12use heck::{ToPascalCase, ToSnakeCase};
13use sigil_stitch::code_block::CodeBlock;
14use sigil_stitch::lang::python::Python;
15use sigil_stitch::prelude::*;
16
17/// Generate every model file from the IR.
18pub fn generate_model_files(ir: &IrSpec, header: &str) -> Result<Vec<FileInfo>, String> {
19    let mut files = Vec::new();
20    for (_name, schema) in &ir.schemas {
21        let body = emit_model_body(schema, ir).ok_or_else(|| {
22            format!(
23                "unsupported schema kind for {}: {:?}",
24                schema.name, schema.kind
25            )
26        })?;
27        let stem = schema.name.to_snake_case();
28        let filename = format!("{stem}.py");
29        let mut content = String::with_capacity(header.len() + body.len());
30        content.push_str(header);
31        content.push_str(&body);
32        files.push(FileInfo::model(filename, content));
33    }
34    Ok(files)
35}
36
37fn emit_model_body(schema: &IrSchema, ir: &IrSpec) -> Option<String> {
38    let file_spec = match &schema.kind {
39        IrSchemaKind::Object(obj) => emit_object(schema, obj, ir),
40        IrSchemaKind::Enum(en) => emit_enum(schema, en),
41        IrSchemaKind::Alias(expr) => emit_alias(schema, expr),
42        IrSchemaKind::Union(u) => emit_union(schema, u),
43        IrSchemaKind::Intersection(i) => emit_intersection(schema, i, ir),
44        IrSchemaKind::TaggedUnion(tu) => emit_tagged_union(schema, tu, ir),
45    }?;
46    file_spec.render(100).ok()
47}
48
49pub fn future_annotations_header() -> CodeBlock {
50    CodeBlock::of("from __future__ import annotations", ()).expect("static header")
51}
52
53// ---------------------------------------------------------------------------
54// Object -> @dataclass
55// ---------------------------------------------------------------------------
56
57fn emit_object(schema: &IrSchema, obj: &IrObject, ir: &IrSpec) -> Option<FileSpec> {
58    let name = schema.name.to_pascal_case();
59
60    let mut file =
61        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
62
63    if needs_typing_literal_in_props(&obj.properties) {
64        file = file.add_import(ImportSpec::named("typing", "Literal"));
65    }
66
67    let dataclass_tn = TypeName::importable("dataclasses", "dataclass");
68    let mut cls = TypeSpec::builder(&name, TypeKind::Class)
69        .annotate(AnnotationSpec::importable(dataclass_tn));
70
71    if let Some(doc) = &schema.description {
72        cls = cls.doc(&format!("{}.", escape_docstring(doc)));
73    }
74
75    let mut required: Vec<(&String, &IrProperty)> = Vec::new();
76    let mut optional: Vec<(&String, &IrProperty)> = Vec::new();
77    for (json_name, prop) in &obj.properties {
78        if prop.required && !prop.nullable {
79            required.push((json_name, prop));
80        } else {
81            optional.push((json_name, prop));
82        }
83    }
84
85    let all_fields: Vec<(&String, &IrProperty)> =
86        required.iter().chain(optional.iter()).copied().collect();
87
88    if all_fields.is_empty() {
89        cls = cls.extra_member(CodeBlock::of("pass", ()).expect("pass"));
90    } else {
91        for (_json_name, prop) in &required {
92            let field_name = python_field_name(&prop.name);
93            let type_name = python_type_name(&prop.type_expr);
94            cls = cls.add_field(
95                FieldSpec::builder(&field_name, type_name)
96                    .build()
97                    .expect("required field"),
98            );
99        }
100        for (_json_name, prop) in &optional {
101            let field_name = python_field_name(&prop.name);
102            let type_name = python_type_name(&prop.type_expr);
103            cls = cls.add_field(
104                FieldSpec::builder(&field_name, TypeName::optional(type_name))
105                    .initializer(CodeBlock::of("None", ()).expect("None init"))
106                    .build()
107                    .expect("optional field"),
108            );
109        }
110
111        cls = cls.add_method(build_to_dict_method(&all_fields, ir, &obj.properties));
112        cls = cls.add_method(build_from_dict_method(
113            &name,
114            &all_fields,
115            ir,
116            &obj.properties,
117        ));
118    }
119
120    file = file.add_type(cls.build().ok()?);
121    file.build().ok()
122}
123
124fn build_to_dict_method(
125    all_fields: &[(&String, &IrProperty)],
126    ir: &IrSpec,
127    properties: &indexmap::IndexMap<String, IrProperty>,
128) -> FunSpec {
129    let self_param = ParameterSpec::of("self", TypeName::primitive(""));
130    let return_type = TypeName::generic(
131        TypeName::primitive("dict"),
132        vec![TypeName::primitive("str"), TypeName::primitive("object")],
133    );
134
135    let mut body = CodeBlock::builder();
136    body.add_statement("result: dict[str, object] = {}", ());
137    for (json_name, prop) in all_fields {
138        let field_name = python_field_name(&prop.name);
139        let to_expr = render_to_dict_expr(&format!("self.{field_name}"), json_name, ir, properties);
140        if prop.required && !prop.nullable {
141            body.add_statement(&format!("result[\"{json_name}\"] = {to_expr}"), ());
142        } else {
143            body.add_statement(&format!("if self.{field_name} is not None:%>"), ());
144            body.add_statement(&format!("result[\"{json_name}\"] = {to_expr}%<"), ());
145        }
146    }
147    body.add_statement("return result", ());
148
149    FunSpec::builder("to_dict")
150        .add_param(self_param)
151        .returns(return_type)
152        .body(body.build().expect("to_dict body"))
153        .build()
154        .expect("to_dict method")
155}
156
157fn build_from_dict_method(
158    class_name: &str,
159    all_fields: &[(&String, &IrProperty)],
160    ir: &IrSpec,
161    properties: &indexmap::IndexMap<String, IrProperty>,
162) -> FunSpec {
163    let cls_param = ParameterSpec::of("cls", TypeName::primitive(""));
164    let data_param = ParameterSpec::of(
165        "data",
166        TypeName::generic(
167            TypeName::primitive("dict"),
168            vec![TypeName::primitive("str"), TypeName::primitive("object")],
169        ),
170    );
171
172    let mut body = CodeBlock::builder();
173    body.add_statement("return cls(%>", ());
174    for (json_name, prop) in all_fields {
175        let field_name = python_field_name(&prop.name);
176        let is_required = prop.required && !prop.nullable;
177        let expr = if is_required {
178            render_from_dict_expr(json_name, ir, properties)
179        } else {
180            render_from_dict_optional_expr(json_name, ir, properties)
181        };
182        if let Some(comment_start) = expr.find("  #") {
183            let (value_part, comment_part) = expr.split_at(comment_start);
184            body.add_statement(&format!("{field_name}={value_part},{comment_part}"), ());
185        } else {
186            body.add_statement(&format!("{field_name}={expr},"), ());
187        }
188    }
189    body.add("%<", ());
190    body.add_statement(")", ());
191
192    FunSpec::builder("from_dict")
193        .annotation(CodeBlock::of("@classmethod", ()).expect("classmethod"))
194        .add_param(cls_param)
195        .add_param(data_param)
196        .returns(TypeName::primitive(class_name))
197        .body(body.build().expect("from_dict body"))
198        .build()
199        .expect("from_dict method")
200}
201
202// ---------------------------------------------------------------------------
203// Enum -> class(str, Enum) or class(int, Enum)
204// ---------------------------------------------------------------------------
205
206fn emit_enum(schema: &IrSchema, en: &IrEnum) -> Option<FileSpec> {
207    if en.value_type == IrEnumValueType::Mixed {
208        return emit_type_alias_raw(schema, "object");
209    }
210
211    let name = schema.name.to_pascal_case();
212    let base = match en.value_type {
213        IrEnumValueType::String => TypeName::primitive("str"),
214        IrEnumValueType::Integer | IrEnumValueType::Number => TypeName::primitive("int"),
215        IrEnumValueType::Mixed => unreachable!(),
216    };
217
218    let mut ts = TypeSpec::builder(&name, TypeKind::Enum)
219        .extends(base)
220        .extends(TypeName::importable("enum", "Enum"));
221
222    if let Some(doc) = &schema.description {
223        ts = ts.doc(&format!("{}.", escape_docstring(doc)));
224    }
225
226    for v in &en.values {
227        let (member_name, value_code) = match en.value_type {
228            IrEnumValueType::String => {
229                let s = v.value.as_str()?;
230                (
231                    python_enum_member_name(s),
232                    format!("\"{}\"", escape_python_string(s)),
233                )
234            }
235            IrEnumValueType::Integer | IrEnumValueType::Number => {
236                let n = v
237                    .value
238                    .as_i64()
239                    .or_else(|| v.value.as_f64().map(|f| f as i64))?;
240                (format!("N{n}").replace('-', "NEG"), format!("{n}"))
241            }
242            IrEnumValueType::Mixed => unreachable!(),
243        };
244        ts = ts.add_variant(
245            EnumVariantSpec::builder(&member_name)
246                .value(CodeBlock::of(&value_code, ()).expect("enum value"))
247                .build()
248                .expect("enum variant"),
249        );
250    }
251
252    let file = FileSpec::builder_with("model.py", Python::new())
253        .header(future_annotations_header())
254        .add_type(ts.build().ok()?);
255    file.build().ok()
256}
257
258// ---------------------------------------------------------------------------
259// Alias -> type X = Y (PEP 695)
260// ---------------------------------------------------------------------------
261
262fn emit_alias(schema: &IrSchema, expr: &IrTypeExpr) -> Option<FileSpec> {
263    let name = schema.name.to_pascal_case();
264    let rhs_type = python_type_name(expr);
265
266    let type_alias = sigil_quote!(Python {
267        type $N(name.as_str()) = $T(rhs_type);
268    })
269    .ok()?;
270
271    let mut file =
272        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
273    if needs_typing_literal(expr) {
274        file = file.add_import(ImportSpec::named("typing", "Literal"));
275    }
276    if let Some(doc) = &schema.description {
277        file = file.add_raw(&format!("# {}\n", escape_docstring(doc)));
278    }
279    file = file.add_code(type_alias);
280    file.build().ok()
281}
282
283fn emit_type_alias_raw(schema: &IrSchema, rhs: &str) -> Option<FileSpec> {
284    let name = schema.name.to_pascal_case();
285
286    let type_alias = sigil_quote!(Python {
287        type $N(name.as_str()) = $L(rhs);
288    })
289    .ok()?;
290
291    let mut file =
292        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
293    if let Some(doc) = &schema.description {
294        file = file.add_raw(&format!("# {}\n", escape_docstring(doc)));
295    }
296    file = file.add_code(type_alias);
297    file.build().ok()
298}
299
300// ---------------------------------------------------------------------------
301// Union -> type X = A | B | C
302// ---------------------------------------------------------------------------
303
304fn emit_union(schema: &IrSchema, u: &IrUnion) -> Option<FileSpec> {
305    let name = schema.name.to_pascal_case();
306
307    let mut members: Vec<TypeName> = u.members.iter().map(python_type_name).collect();
308    if u.nullable {
309        members.push(TypeName::primitive("None"));
310    }
311    let union_ty = if members.is_empty() {
312        TypeName::importable("typing", "Any")
313    } else {
314        TypeName::union(members)
315    };
316
317    let type_alias = sigil_quote!(Python {
318        type $N(name.as_str()) = $T(union_ty);
319    })
320    .ok()?;
321
322    let mut file =
323        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
324    if needs_typing_literal_in_exprs(&u.members) {
325        file = file.add_import(ImportSpec::named("typing", "Literal"));
326    }
327    if let Some(doc) = &schema.description {
328        file = file.add_raw(&format!("# {}\n", escape_docstring(doc)));
329    }
330    file = file.add_code(type_alias);
331    file.build().ok()
332}
333
334// ---------------------------------------------------------------------------
335// Intersection -> merged @dataclass
336// ---------------------------------------------------------------------------
337
338fn emit_intersection(schema: &IrSchema, inter: &IrIntersection, ir: &IrSpec) -> Option<FileSpec> {
339    let mut all_props: indexmap::IndexMap<String, IrProperty> = indexmap::IndexMap::new();
340    for member in &inter.members {
341        if let IrTypeExpr::Named(ref_name) = member
342            && let Some(s) = ir.schemas.get(ref_name.as_str())
343            && let IrSchemaKind::Object(obj) = &s.kind
344        {
345            for (k, v) in &obj.properties {
346                all_props.entry(k.clone()).or_insert_with(|| v.clone());
347            }
348        }
349    }
350
351    if all_props.is_empty() {
352        return emit_intersection_as_alias(schema, inter);
353    }
354
355    emit_intersection_as_dataclass(schema, &all_props, ir)
356}
357
358fn emit_intersection_as_alias(schema: &IrSchema, inter: &IrIntersection) -> Option<FileSpec> {
359    let name = schema.name.to_pascal_case();
360    let members: Vec<TypeName> = inter.members.iter().map(python_type_name).collect();
361    let union_ty = if members.is_empty() {
362        TypeName::importable("typing", "Any")
363    } else {
364        TypeName::union(members)
365    };
366
367    let type_alias = sigil_quote!(Python {
368        type $N(name.as_str()) = $T(union_ty);
369    })
370    .ok()?;
371
372    let mut file =
373        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
374    if needs_typing_literal_in_exprs(&inter.members) {
375        file = file.add_import(ImportSpec::named("typing", "Literal"));
376    }
377    file = file.add_code(type_alias);
378    file.build().ok()
379}
380
381fn emit_intersection_as_dataclass(
382    schema: &IrSchema,
383    all_props: &indexmap::IndexMap<String, IrProperty>,
384    ir: &IrSpec,
385) -> Option<FileSpec> {
386    let name = schema.name.to_pascal_case();
387
388    let mut file =
389        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
390
391    if needs_typing_literal_in_props(all_props) {
392        file = file.add_import(ImportSpec::named("typing", "Literal"));
393    }
394
395    let dataclass_tn = TypeName::importable("dataclasses", "dataclass");
396    let mut cls = TypeSpec::builder(&name, TypeKind::Class)
397        .annotate(AnnotationSpec::importable(dataclass_tn));
398
399    if let Some(doc) = &schema.description {
400        cls = cls.doc(&format!("{}.", escape_docstring(doc)));
401    }
402
403    let mut required: Vec<(&String, &IrProperty)> = Vec::new();
404    let mut optional: Vec<(&String, &IrProperty)> = Vec::new();
405    for (json_name, prop) in all_props {
406        if prop.required && !prop.nullable {
407            required.push((json_name, prop));
408        } else {
409            optional.push((json_name, prop));
410        }
411    }
412
413    if required.is_empty() && optional.is_empty() {
414        cls = cls.extra_member(CodeBlock::of("pass", ()).expect("pass"));
415    } else {
416        for (_json_name, prop) in &required {
417            let field_name = python_field_name(&prop.name);
418            let type_name = python_type_name(&prop.type_expr);
419            cls = cls.add_field(
420                FieldSpec::builder(&field_name, type_name)
421                    .build()
422                    .expect("required field"),
423            );
424        }
425        for (_json_name, prop) in &optional {
426            let field_name = python_field_name(&prop.name);
427            let type_name = python_type_name(&prop.type_expr);
428            cls = cls.add_field(
429                FieldSpec::builder(&field_name, TypeName::optional(type_name))
430                    .initializer(CodeBlock::of("None", ()).expect("None init"))
431                    .build()
432                    .expect("optional field"),
433            );
434        }
435
436        let all_fields: Vec<(&String, &IrProperty)> =
437            required.iter().chain(optional.iter()).copied().collect();
438        cls = cls.add_method(build_to_dict_method(&all_fields, ir, all_props));
439        cls = cls.add_method(build_from_dict_method(&name, &all_fields, ir, all_props));
440    }
441
442    file = file.add_type(cls.build().ok()?);
443    file.build().ok()
444}
445
446// ---------------------------------------------------------------------------
447// TaggedUnion -> type X = A | B | C
448// ---------------------------------------------------------------------------
449
450fn emit_tagged_union(schema: &IrSchema, tu: &IrTaggedUnion, ir: &IrSpec) -> Option<FileSpec> {
451    let name = schema.name.to_pascal_case();
452    let snake_name = schema.name.to_snake_case();
453
454    let members: Vec<TypeName> = tu
455        .variants
456        .iter()
457        .map(|v| python_type_name(&v.content_type))
458        .collect();
459
460    let union_ty = if members.is_empty() {
461        TypeName::importable("typing", "Any")
462    } else {
463        TypeName::union(members)
464    };
465
466    let type_alias = sigil_quote!(Python {
467        type $N(name.as_str()) = $T(union_ty);
468    })
469    .ok()?;
470
471    let hint = match &tu.tagging {
472        TaggingStyle::Internal => {
473            format!("Discriminator: {} (internal).", tu.discriminator_field)
474        }
475        TaggingStyle::Adjacent { content_field } => format!(
476            "Discriminator: {} / content: {} (adjacent).",
477            tu.discriminator_field, content_field
478        ),
479        TaggingStyle::External => "Discriminator: variant key (external).".to_string(),
480    };
481
482    let doc = match &schema.description {
483        Some(desc) => format!("{desc}\n\n{hint}"),
484        None => hint,
485    };
486
487    let mut file =
488        FileSpec::builder_with("model.py", Python::new()).header(future_annotations_header());
489    let exprs: Vec<&IrTypeExpr> = tu.variants.iter().map(|v| &v.content_type).collect();
490    if exprs.iter().any(|e| needs_typing_literal(e)) {
491        file = file.add_import(ImportSpec::named("typing", "Literal"));
492    }
493    let mut doc_block = String::new();
494    for line in doc.lines() {
495        doc_block.push_str(&format!("# {line}\n"));
496    }
497    file = file.add_raw(&doc_block);
498    file = file.add_code(type_alias);
499
500    if !tu.variants.is_empty() {
501        let helpers = build_tagged_union_helpers(&name, &snake_name, tu, ir);
502        file = file.add_code(helpers);
503    }
504
505    file.build().ok()
506}
507
508fn build_tagged_union_helpers(
509    pascal_name: &str,
510    snake_name: &str,
511    tu: &IrTaggedUnion,
512    ir: &IrSpec,
513) -> CodeBlock {
514    let tag_field = &tu.discriminator_field;
515
516    let resolved_variants: Vec<(&IrTaggedVariant, String)> = tu
517        .variants
518        .iter()
519        .filter_map(|v| {
520            if let IrTypeExpr::Named(ref_name) = &v.content_type
521                && is_object_schema(ref_name, ir)
522            {
523                return Some((v, ref_name.to_pascal_case()));
524            }
525            None
526        })
527        .collect();
528
529    let mut cb = CodeBlock::builder();
530
531    if resolved_variants.is_empty() {
532        return cb.build_unwrap();
533    }
534
535    // from_dict
536    cb.add_line();
537    cb.begin_control_flow(
538        &format!("def {snake_name}_from_dict(data: dict[str, object]) -> {pascal_name}"),
539        (),
540    );
541    match &tu.tagging {
542        TaggingStyle::Internal => {
543            cb.add_statement(&format!("_tag = data[\"{tag_field}\"]"), ());
544            for (i, (variant, py_class)) in resolved_variants.iter().enumerate() {
545                let cond = format!("_tag == \"{}\"", variant.discriminator_value);
546                emit_elif(&mut cb, i == 0, false, &cond);
547                cb.add_statement(&format!("return {py_class}.from_dict(data)"), ());
548            }
549            cb.end_control_flow_no_newline();
550        }
551        TaggingStyle::Adjacent { content_field } => {
552            cb.add_statement(&format!("_tag = data[\"{tag_field}\"]"), ());
553            cb.add_statement(
554                &format!("_content = data[\"{content_field}\"]  # type: ignore[assignment]"),
555                (),
556            );
557            for (i, (variant, py_class)) in resolved_variants.iter().enumerate() {
558                let cond = format!("_tag == \"{}\"", variant.discriminator_value);
559                emit_elif(&mut cb, i == 0, false, &cond);
560                cb.add_statement(
561                    &format!("return {py_class}.from_dict(_content)  # type: ignore[arg-type]"),
562                    (),
563                );
564            }
565            cb.end_control_flow_no_newline();
566        }
567        TaggingStyle::External => {
568            for (i, (variant, py_class)) in resolved_variants.iter().enumerate() {
569                let cond = format!("\"{}\" in data", variant.discriminator_value);
570                emit_elif(&mut cb, i == 0, false, &cond);
571                cb.add_statement(
572                    &format!(
573                        "return {py_class}.from_dict(data[\"{}\"])  # type: ignore[arg-type]",
574                        variant.discriminator_value
575                    ),
576                    (),
577                );
578            }
579            cb.end_control_flow_no_newline();
580        }
581    }
582    cb.add_statement(
583        "raise ValueError(%V)",
584        VerbatimStrArg(format!(
585            "Unknown discriminator value for {pascal_name}: {{data}}"
586        )),
587    );
588    cb.end_control_flow();
589
590    // to_dict
591    cb.add_line();
592    cb.begin_control_flow(
593        &format!("def {snake_name}_to_dict(obj: {pascal_name}) -> dict[str, object]"),
594        (),
595    );
596    let last_idx = resolved_variants.len() - 1;
597    match &tu.tagging {
598        TaggingStyle::Internal => {
599            for (i, (variant, py_class)) in resolved_variants.iter().enumerate() {
600                let cond = format!("isinstance(obj, {py_class})");
601                emit_elif(&mut cb, i == 0, i == last_idx, &cond);
602                cb.add_statement("result = obj.to_dict()", ());
603                cb.add_statement(
604                    &format!(
605                        "result[\"{tag_field}\"] = \"{}\"",
606                        variant.discriminator_value
607                    ),
608                    (),
609                );
610                cb.add_statement("return result", ());
611            }
612            cb.end_control_flow_no_newline();
613        }
614        TaggingStyle::Adjacent { content_field } => {
615            for (i, (variant, py_class)) in resolved_variants.iter().enumerate() {
616                let cond = format!("isinstance(obj, {py_class})");
617                emit_elif(&mut cb, i == 0, i == last_idx, &cond);
618                cb.add_statement(
619                    &format!(
620                        "return {{\"{tag_field}\": \"{}\", \"{content_field}\": obj.to_dict()}}",
621                        variant.discriminator_value
622                    ),
623                    (),
624                );
625            }
626            cb.end_control_flow_no_newline();
627        }
628        TaggingStyle::External => {
629            for (i, (variant, py_class)) in resolved_variants.iter().enumerate() {
630                let cond = format!("isinstance(obj, {py_class})");
631                emit_elif(&mut cb, i == 0, i == last_idx, &cond);
632                cb.add_statement(
633                    &format!(
634                        "return {{\"{}\": obj.to_dict()}}",
635                        variant.discriminator_value
636                    ),
637                    (),
638                );
639            }
640            cb.end_control_flow_no_newline();
641        }
642    }
643    cb.add_statement(
644        "raise ValueError(%V)",
645        VerbatimStrArg(format!("Unknown variant for {pascal_name}: {{type(obj)}}")),
646    );
647    cb.end_control_flow();
648
649    cb.build_unwrap()
650}
651
652fn emit_elif(
653    cb: &mut sigil_stitch::code_block::CodeBlockBuilder,
654    is_first: bool,
655    is_last: bool,
656    cond: &str,
657) {
658    if !is_first {
659        cb.end_control_flow_no_newline();
660    }
661    if is_last && !is_first {
662        cb.begin_control_flow("else", ());
663    } else {
664        let kw = if is_first { "if" } else { "elif" };
665        cb.begin_control_flow(&format!("{kw} {cond}"), ());
666    }
667}
668
669// ---------------------------------------------------------------------------
670// Type mapping
671// ---------------------------------------------------------------------------
672
673/// Map an IR type expression to a sigil-stitch TypeName with auto-import tracking.
674pub fn python_type_name(expr: &IrTypeExpr) -> TypeName {
675    match expr {
676        IrTypeExpr::Named(name) => {
677            let py_name = name.to_pascal_case();
678            let module = format!(".{}", name.to_snake_case());
679            TypeName::importable(&module, &py_name)
680        }
681        IrTypeExpr::Primitive(p) => python_primitive_type_name(p),
682        IrTypeExpr::StringLiteral(s) => {
683            let lit = format!("Literal[\"{}\"]", escape_python_string(s));
684            TypeName::raw(&lit)
685        }
686        IrTypeExpr::StringEnum(values) => {
687            let members: Vec<String> = values
688                .iter()
689                .map(|v| format!("\"{}\"", escape_python_string(v)))
690                .collect();
691            let lit = format!("Literal[{}]", members.join(", "));
692            TypeName::raw(&lit)
693        }
694        IrTypeExpr::Array(inner) => {
695            TypeName::generic(TypeName::primitive("list"), vec![python_type_name(inner)])
696        }
697        IrTypeExpr::Map(inner) => TypeName::generic(
698            TypeName::primitive("dict"),
699            vec![TypeName::primitive("str"), python_type_name(inner)],
700        ),
701        IrTypeExpr::Union(members) => {
702            if members.is_empty() {
703                TypeName::importable("typing", "Any")
704            } else {
705                TypeName::union(members.iter().map(python_type_name).collect())
706            }
707        }
708        IrTypeExpr::Nullable(inner) => TypeName::optional(python_type_name(inner)),
709        IrTypeExpr::Any => TypeName::importable("typing", "Any"),
710    }
711}
712
713/// Like `python_type_name` but Named types import from `..models.{snake}` (for API files).
714pub fn api_type_name(expr: &IrTypeExpr) -> TypeName {
715    match expr {
716        IrTypeExpr::Named(name) => {
717            let py_name = name.to_pascal_case();
718            let module = format!("..models.{}", name.to_snake_case());
719            TypeName::importable(&module, &py_name)
720        }
721        IrTypeExpr::Array(inner) => {
722            TypeName::generic(TypeName::primitive("list"), vec![api_type_name(inner)])
723        }
724        IrTypeExpr::Map(inner) => TypeName::generic(
725            TypeName::primitive("dict"),
726            vec![TypeName::primitive("str"), api_type_name(inner)],
727        ),
728        IrTypeExpr::Union(members) => {
729            if members.is_empty() {
730                TypeName::importable("typing", "Any")
731            } else {
732                TypeName::union(members.iter().map(api_type_name).collect())
733            }
734        }
735        IrTypeExpr::Nullable(inner) => TypeName::optional(api_type_name(inner)),
736        _ => python_type_name(expr),
737    }
738}
739
740fn python_primitive_type_name(p: &IrPrimitive) -> TypeName {
741    match p {
742        IrPrimitive::String | IrPrimitive::StringWithFormat(_) => TypeName::primitive("str"),
743        IrPrimitive::Integer | IrPrimitive::IntegerWithFormat(_) => TypeName::primitive("int"),
744        IrPrimitive::Number | IrPrimitive::NumberWithFormat(_) => TypeName::primitive("float"),
745        IrPrimitive::Boolean => TypeName::primitive("bool"),
746        IrPrimitive::Binary => TypeName::primitive("bytes"),
747        IrPrimitive::Date => TypeName::importable("datetime", "date"),
748        IrPrimitive::DateTime => TypeName::importable("datetime", "datetime"),
749        IrPrimitive::Uuid => TypeName::importable("uuid", "UUID"),
750    }
751}
752
753/// Map an IR type expression to a Python type string (for serialization helpers).
754pub fn python_type_str(expr: &IrTypeExpr) -> String {
755    match expr {
756        IrTypeExpr::Named(name) => name.to_pascal_case(),
757        IrTypeExpr::Primitive(p) => python_primitive(p).to_string(),
758        IrTypeExpr::StringLiteral(s) => {
759            format!("Literal[\"{}\"]", escape_python_string(s))
760        }
761        IrTypeExpr::StringEnum(values) => {
762            let members: Vec<String> = values
763                .iter()
764                .map(|v| format!("\"{}\"", escape_python_string(v)))
765                .collect();
766            format!("Literal[{}]", members.join(", "))
767        }
768        IrTypeExpr::Array(inner) => {
769            let inner_ty = python_type_str(inner);
770            format!("list[{inner_ty}]")
771        }
772        IrTypeExpr::Map(inner) => {
773            let inner_ty = python_type_str(inner);
774            format!("dict[str, {inner_ty}]")
775        }
776        IrTypeExpr::Union(members) => {
777            let parts: Vec<String> = members.iter().map(python_type_str).collect();
778            if parts.is_empty() {
779                "Any".to_string()
780            } else {
781                parts.join(" | ")
782            }
783        }
784        IrTypeExpr::Nullable(inner) => {
785            let inner_ty = python_type_str(inner);
786            format!("{inner_ty} | None")
787        }
788        IrTypeExpr::Any => "Any".to_string(),
789    }
790}
791
792fn python_primitive(p: &IrPrimitive) -> &'static str {
793    match p {
794        IrPrimitive::String | IrPrimitive::StringWithFormat(_) => "str",
795        IrPrimitive::Integer | IrPrimitive::IntegerWithFormat(_) => "int",
796        IrPrimitive::Number | IrPrimitive::NumberWithFormat(_) => "float",
797        IrPrimitive::Boolean => "bool",
798        IrPrimitive::Binary => "bytes",
799        IrPrimitive::Date => "datetime.date",
800        IrPrimitive::DateTime => "datetime.datetime",
801        IrPrimitive::Uuid => "uuid.UUID",
802    }
803}
804
805fn needs_typing_literal(expr: &IrTypeExpr) -> bool {
806    match expr {
807        IrTypeExpr::StringLiteral(_) | IrTypeExpr::StringEnum(_) => true,
808        IrTypeExpr::Array(inner) | IrTypeExpr::Map(inner) | IrTypeExpr::Nullable(inner) => {
809            needs_typing_literal(inner)
810        }
811        IrTypeExpr::Union(members) => members.iter().any(needs_typing_literal),
812        _ => false,
813    }
814}
815
816fn needs_typing_literal_in_props(props: &indexmap::IndexMap<String, IrProperty>) -> bool {
817    props.values().any(|p| needs_typing_literal(&p.type_expr))
818}
819
820fn needs_typing_literal_in_exprs(exprs: &[IrTypeExpr]) -> bool {
821    exprs.iter().any(needs_typing_literal)
822}
823
824// ---------------------------------------------------------------------------
825// Serialization helpers
826// ---------------------------------------------------------------------------
827
828fn render_to_dict_expr(
829    value_expr: &str,
830    json_name: &str,
831    ir: &IrSpec,
832    properties: &indexmap::IndexMap<String, IrProperty>,
833) -> String {
834    let prop = properties.get(json_name);
835    let type_expr = prop.map(|p| &p.type_expr);
836    match type_expr {
837        Some(IrTypeExpr::Named(ref_name)) => {
838            if is_object_schema(ref_name, ir) {
839                format!("{value_expr}.to_dict()")
840            } else {
841                value_expr.to_string()
842            }
843        }
844        Some(IrTypeExpr::Array(inner)) => {
845            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
846                && is_object_schema(ref_name, ir)
847            {
848                return format!("[item.to_dict() for item in {value_expr}]");
849            }
850            value_expr.to_string()
851        }
852        Some(IrTypeExpr::Nullable(inner)) => {
853            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
854                && is_object_schema(ref_name, ir)
855            {
856                return format!("{value_expr}.to_dict() if {value_expr} is not None else None");
857            }
858            value_expr.to_string()
859        }
860        Some(IrTypeExpr::Map(inner)) => {
861            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
862                && is_object_schema(ref_name, ir)
863            {
864                return format!("{{k: v.to_dict() for k, v in {value_expr}.items()}}");
865            }
866            value_expr.to_string()
867        }
868        _ => value_expr.to_string(),
869    }
870}
871
872fn render_from_dict_expr(
873    json_name: &str,
874    ir: &IrSpec,
875    properties: &indexmap::IndexMap<String, IrProperty>,
876) -> String {
877    let prop = properties.get(json_name);
878    let type_expr = prop.map(|p| &p.type_expr);
879    let accessor = format!("data[\"{json_name}\"]");
880    match type_expr {
881        Some(IrTypeExpr::Named(ref_name)) => {
882            if is_object_schema(ref_name, ir) {
883                let py_name = ref_name.to_pascal_case();
884                format!("{py_name}.from_dict({accessor})  # type: ignore[arg-type]")
885            } else {
886                format!("{accessor}  # type: ignore[assignment]")
887            }
888        }
889        Some(IrTypeExpr::Array(inner)) => {
890            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
891                && is_object_schema(ref_name, ir)
892            {
893                let py_name = ref_name.to_pascal_case();
894                return format!(
895                    "[{py_name}.from_dict(item) for item in {accessor}]  # type: ignore[union-attr]"
896                );
897            }
898            format!("{accessor}  # type: ignore[assignment]")
899        }
900        Some(IrTypeExpr::Map(inner)) => {
901            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
902                && is_object_schema(ref_name, ir)
903            {
904                let py_name = ref_name.to_pascal_case();
905                return format!(
906                    "{{k: {py_name}.from_dict(v) for k, v in {accessor}.items()}}  # type: ignore[union-attr]"
907                );
908            }
909            format!("{accessor}  # type: ignore[assignment]")
910        }
911        _ => format!("{accessor}  # type: ignore[assignment]"),
912    }
913}
914
915fn render_from_dict_optional_expr(
916    json_name: &str,
917    ir: &IrSpec,
918    properties: &indexmap::IndexMap<String, IrProperty>,
919) -> String {
920    let prop = properties.get(json_name);
921    let type_expr = prop.map(|p| &p.type_expr);
922    let raw_type = type_expr.map(|t| match t {
923        IrTypeExpr::Nullable(inner) => inner.as_ref(),
924        _ => t,
925    });
926    let accessor = format!("data.get(\"{json_name}\")");
927    match raw_type {
928        Some(IrTypeExpr::Named(ref_name)) => {
929            if is_object_schema(ref_name, ir) {
930                let py_name = ref_name.to_pascal_case();
931                format!(
932                    "{py_name}.from_dict({accessor}) if {accessor} is not None else None  # type: ignore[arg-type]"
933                )
934            } else {
935                format!("{accessor}  # type: ignore[assignment]")
936            }
937        }
938        Some(IrTypeExpr::Array(inner)) => {
939            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
940                && is_object_schema(ref_name, ir)
941            {
942                let py_name = ref_name.to_pascal_case();
943                return format!(
944                    "[{py_name}.from_dict(item) for item in {accessor}] if {accessor} is not None else None  # type: ignore[union-attr]"
945                );
946            }
947            format!("{accessor}  # type: ignore[assignment]")
948        }
949        Some(IrTypeExpr::Map(inner)) => {
950            if let IrTypeExpr::Named(ref_name) = inner.as_ref()
951                && is_object_schema(ref_name, ir)
952            {
953                let py_name = ref_name.to_pascal_case();
954                return format!(
955                    "{{k: {py_name}.from_dict(v) for k, v in {accessor}.items()}} if {accessor} is not None else None  # type: ignore[union-attr]"
956                );
957            }
958            format!("{accessor}  # type: ignore[assignment]")
959        }
960        _ => format!("{accessor}  # type: ignore[assignment]"),
961    }
962}
963
964pub fn is_object_schema(name: &str, ir: &IrSpec) -> bool {
965    ir.schemas.get(name).is_some_and(|s| match &s.kind {
966        IrSchemaKind::Object(_) => true,
967        IrSchemaKind::Intersection(inter) => inter.members.iter().any(|m| {
968            if let IrTypeExpr::Named(ref_name) = m {
969                ir.schemas
970                    .get(ref_name.as_str())
971                    .is_some_and(|ms| matches!(ms.kind, IrSchemaKind::Object(_)))
972            } else {
973                false
974            }
975        }),
976        _ => false,
977    })
978}
979
980// ---------------------------------------------------------------------------
981// Helpers
982// ---------------------------------------------------------------------------
983
984pub fn python_field_name(name: &str) -> String {
985    let snake = name.to_snake_case();
986    if snake.is_empty() {
987        return "field_".to_string();
988    }
989    match snake.as_str() {
990        "and" | "as" | "assert" | "async" | "await" | "break" | "class" | "continue" | "def"
991        | "del" | "elif" | "else" | "except" | "finally" | "for" | "from" | "global" | "if"
992        | "import" | "in" | "is" | "lambda" | "nonlocal" | "not" | "or" | "pass" | "raise"
993        | "return" | "try" | "while" | "with" | "yield" | "type" => {
994            format!("{snake}_")
995        }
996        _ => snake,
997    }
998}
999
1000fn python_enum_member_name(value: &str) -> String {
1001    let upper = value
1002        .to_uppercase()
1003        .replace(|c: char| !c.is_alphanumeric(), "_");
1004    if upper.is_empty() {
1005        return "EMPTY".to_string();
1006    }
1007    if upper.starts_with(|c: char| c.is_ascii_digit()) {
1008        return format!("N{upper}");
1009    }
1010    upper
1011}
1012
1013fn escape_python_string(s: &str) -> String {
1014    s.replace('\\', "\\\\").replace('"', "\\\"")
1015}
1016
1017fn escape_docstring(s: &str) -> String {
1018    s.replace("\"\"\"", "\\\"\\\"\\\"")
1019        .lines()
1020        .next()
1021        .unwrap_or("")
1022        .to_string()
1023}
openapi_nexus/generators/python/requests/emit_models.rs

openapi_nexus/generators/python/requests/
emit_models.rs
