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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""Python code generator."""
from typing import List, Optional, Set
from fory_compiler.generators.base import BaseGenerator, GeneratedFile
from fory_compiler.parser.ast import (
Message,
Enum,
Field,
FieldType,
PrimitiveType,
PrimitiveKind,
NamedType,
ListType,
MapType,
)
class PythonGenerator(BaseGenerator):
"""Generates Python dataclasses with pyfory type hints."""
language_name = "python"
file_extension = ".py"
# Mapping from FDL primitive types to Python types
PRIMITIVE_MAP = {
PrimitiveKind.BOOL: "bool",
PrimitiveKind.INT8: "pyfory.int8",
PrimitiveKind.INT16: "pyfory.int16",
PrimitiveKind.INT32: "pyfory.int32",
PrimitiveKind.INT64: "pyfory.int64",
PrimitiveKind.FLOAT32: "pyfory.float32",
PrimitiveKind.FLOAT64: "pyfory.float64",
PrimitiveKind.STRING: "str",
PrimitiveKind.BYTES: "bytes",
PrimitiveKind.DATE: "datetime.date",
PrimitiveKind.TIMESTAMP: "datetime.datetime",
}
# Numpy dtype strings for primitive arrays
NUMPY_DTYPE_MAP = {
PrimitiveKind.BOOL: "np.bool_",
PrimitiveKind.INT8: "np.int8",
PrimitiveKind.INT16: "np.int16",
PrimitiveKind.INT32: "np.int32",
PrimitiveKind.INT64: "np.int64",
PrimitiveKind.FLOAT32: "np.float32",
PrimitiveKind.FLOAT64: "np.float64",
}
# Default values for primitive types
DEFAULT_VALUES = {
PrimitiveKind.BOOL: "False",
PrimitiveKind.INT8: "0",
PrimitiveKind.INT16: "0",
PrimitiveKind.INT32: "0",
PrimitiveKind.INT64: "0",
PrimitiveKind.FLOAT32: "0.0",
PrimitiveKind.FLOAT64: "0.0",
PrimitiveKind.STRING: '""',
PrimitiveKind.BYTES: 'b""',
PrimitiveKind.DATE: "None",
PrimitiveKind.TIMESTAMP: "None",
}
def generate(self) -> List[GeneratedFile]:
"""Generate Python files for the schema."""
files = []
# Generate a single module with all types
files.append(self.generate_module())
return files
def get_module_name(self) -> str:
"""Get the Python module name."""
if self.package:
return self.package.replace(".", "_")
return "generated"
def generate_module(self) -> GeneratedFile:
"""Generate a Python module with all types."""
lines = []
imports: Set[str] = set()
# Collect all imports
imports.add("from dataclasses import dataclass, field")
imports.add("from enum import IntEnum")
imports.add("from typing import Dict, List, Optional")
imports.add("import pyfory")
for message in self.schema.messages:
self.collect_message_imports(message, imports)
# License header
lines.append(self.get_license_header("#"))
lines.append("")
lines.append("from __future__ import annotations")
lines.append("")
# Imports
for imp in sorted(imports):
lines.append(imp)
lines.append("")
lines.append("")
# Generate enums (top-level only)
for enum in self.schema.enums:
lines.extend(self.generate_enum(enum))
lines.append("")
lines.append("")
# Generate messages (including nested types)
for message in self.schema.messages:
lines.extend(self.generate_message(message, indent=0))
lines.append("")
lines.append("")
# Generate registration function
lines.extend(self.generate_registration())
lines.append("")
return GeneratedFile(
path=f"{self.get_module_name()}.py",
content="\n".join(lines),
)
def collect_message_imports(self, message: Message, imports: Set[str]):
"""Collect imports for a message and its nested types recursively."""
for field in message.fields:
self.collect_field_imports(field, imports)
for nested_msg in message.nested_messages:
self.collect_message_imports(nested_msg, imports)
def generate_enum(self, enum: Enum, indent: int = 0) -> List[str]:
"""Generate a Python IntEnum."""
lines = []
ind = " " * indent
lines.append(f"{ind}class {enum.name}(IntEnum):")
# Enum values (strip prefix for scoped enums)
for value in enum.values:
stripped_name = self.strip_enum_prefix(enum.name, value.name)
lines.append(f"{ind} {stripped_name} = {value.value}")
return lines
def generate_message(
self,
message: Message,
indent: int = 0,
parent_stack: Optional[List[Message]] = None,
) -> List[str]:
"""Generate a Python dataclass with nested types."""
lines = []
ind = " " * indent
lineage = (parent_stack or []) + [message]
lines.append(f"{ind}@dataclass")
lines.append(f"{ind}class {message.name}:")
# Generate nested enums first (they need to be defined before fields reference them)
for nested_enum in message.nested_enums:
for line in self.generate_enum(nested_enum, indent=indent + 1):
lines.append(line)
lines.append("")
# Generate nested messages
for nested_msg in message.nested_messages:
for line in self.generate_message(
nested_msg,
indent=indent + 1,
parent_stack=lineage,
):
lines.append(line)
lines.append("")
# Generate fields
if (
not message.fields
and not message.nested_enums
and not message.nested_messages
):
lines.append(f"{ind} pass")
return lines
for field in message.fields:
field_lines = self.generate_field(field, lineage)
for line in field_lines:
lines.append(f"{ind} {line}")
# If there are nested types but no fields, add pass to avoid empty class body issues
if not message.fields and (message.nested_enums or message.nested_messages):
lines.append(f"{ind} pass")
return lines
def generate_field(
self,
field: Field,
parent_stack: Optional[List[Message]] = None,
) -> List[str]:
"""Generate a dataclass field."""
lines = []
python_type = self.generate_type(
field.field_type,
field.optional,
field.element_optional,
parent_stack,
)
field_name = self.to_snake_case(field.name)
default_factory = self.get_default_factory(field)
default = self.get_default_value(field.field_type, field.optional)
default_expr = default
trailing_comment = ""
if " # " in default:
default_expr, comment = default.split(" # ", 1)
trailing_comment = f" # {comment}"
if field.ref:
field_args = []
if field.optional:
field_args.append("nullable=True")
field_args.append("ref=True")
if default_factory is not None:
field_args.append(f"default_factory={default_factory}")
else:
field_args.append(f"default={default_expr}")
field_default = f"pyfory.field({', '.join(field_args)}){trailing_comment}"
else:
if default_factory is not None:
field_default = f"field(default_factory={default_factory})"
else:
field_default = f"{default_expr}{trailing_comment}"
lines.append(f"{field_name}: {python_type} = {field_default}")
return lines
def uses_numpy_array(self, field_type: ListType, element_optional: bool) -> bool:
"""Return True if a list should be represented as a numpy array."""
if not isinstance(field_type.element_type, PrimitiveType):
return False
return (
field_type.element_type.kind in self.NUMPY_DTYPE_MAP
and not element_optional
)
def get_default_factory(self, field: Field) -> Optional[str]:
"""Get default factory name for list/map fields."""
if field.optional:
return None
if isinstance(field.field_type, ListType):
if self.uses_numpy_array(field.field_type, field.element_optional):
return None
return "list"
if isinstance(field.field_type, MapType):
return "dict"
return None
def generate_type(
self,
field_type: FieldType,
nullable: bool = False,
element_optional: bool = False,
parent_stack: Optional[List[Message]] = None,
) -> str:
"""Generate Python type hint."""
if isinstance(field_type, PrimitiveType):
base_type = self.PRIMITIVE_MAP[field_type.kind]
if nullable:
return f"Optional[{base_type}]"
return base_type
elif isinstance(field_type, NamedType):
type_name = self.resolve_nested_type_name(field_type.name, parent_stack)
if nullable:
return f"Optional[{type_name}]"
return type_name
elif isinstance(field_type, ListType):
# Use numpy array for numeric primitive types
if isinstance(field_type.element_type, PrimitiveType):
if (
field_type.element_type.kind in self.NUMPY_DTYPE_MAP
and not element_optional
):
list_type = "np.ndarray"
else:
element_type = self.generate_type(
field_type.element_type,
element_optional,
parent_stack,
)
list_type = f"List[{element_type}]"
else:
element_type = self.generate_type(
field_type.element_type,
element_optional,
parent_stack,
)
list_type = f"List[{element_type}]"
if nullable:
return f"Optional[{list_type}]"
return list_type
elif isinstance(field_type, MapType):
key_type = self.generate_type(
field_type.key_type, False, False, parent_stack
)
value_type = self.generate_type(
field_type.value_type, False, False, parent_stack
)
map_type = f"Dict[{key_type}, {value_type}]"
if nullable:
return f"Optional[{map_type}]"
return map_type
return "object"
def resolve_nested_type_name(
self,
type_name: str,
parent_stack: Optional[List[Message]] = None,
) -> str:
"""Resolve nested type names to fully-qualified references."""
if "." in type_name or not parent_stack:
return type_name
for i in range(len(parent_stack) - 1, -1, -1):
message = parent_stack[i]
if message.get_nested_type(type_name) is not None:
prefix = ".".join(parent.name for parent in parent_stack[: i + 1])
return f"{prefix}.{type_name}"
return type_name
def get_default_value(self, field_type: FieldType, nullable: bool = False) -> str:
"""Get default value for a field."""
if nullable:
return "None"
if isinstance(field_type, PrimitiveType):
return self.DEFAULT_VALUES.get(field_type.kind, "None")
elif isinstance(field_type, NamedType):
return "None"
elif isinstance(field_type, ListType):
# Use numpy empty array for numeric types
if isinstance(field_type.element_type, PrimitiveType):
if field_type.element_type.kind in self.NUMPY_DTYPE_MAP:
dtype = self.NUMPY_DTYPE_MAP[field_type.element_type.kind]
return f"None # Use np.array([], dtype={dtype}) to initialize"
return "None"
elif isinstance(field_type, MapType):
return "None"
return "None"
def collect_imports(
self,
field_type: FieldType,
imports: Set[str],
element_optional: bool = False,
):
"""Collect required imports for a field type."""
if isinstance(field_type, PrimitiveType):
if field_type.kind in (PrimitiveKind.DATE, PrimitiveKind.TIMESTAMP):
imports.add("import datetime")
elif isinstance(field_type, ListType):
# Add numpy import for numeric primitive arrays
if isinstance(field_type.element_type, PrimitiveType):
if (
field_type.element_type.kind in self.NUMPY_DTYPE_MAP
and not element_optional
):
imports.add("import numpy as np")
return
self.collect_imports(field_type.element_type, imports)
elif isinstance(field_type, MapType):
self.collect_imports(field_type.key_type, imports)
self.collect_imports(field_type.value_type, imports)
def collect_field_imports(self, field: Field, imports: Set[str]):
"""Collect imports for a field, including list modifiers."""
self.collect_imports(field.field_type, imports, field.element_optional)
def generate_registration(self) -> List[str]:
"""Generate the Fory registration function."""
lines = []
func_name = f"register_{self.get_module_name()}_types"
lines.append(f"def {func_name}(fory: pyfory.Fory):")
if not self.schema.enums and not self.schema.messages:
lines.append(" pass")
return lines
# Register enums (top-level)
for enum in self.schema.enums:
self.generate_enum_registration(lines, enum, "")
# Register messages (including nested types)
for message in self.schema.messages:
self.generate_message_registration(lines, message, "")
return lines
def generate_enum_registration(
self, lines: List[str], enum: Enum, parent_path: str
):
"""Generate registration code for an enum."""
# In Python, nested class references use Outer.Inner syntax
class_ref = f"{parent_path}.{enum.name}" if parent_path else enum.name
type_name = class_ref if parent_path else enum.name
if enum.type_id is not None:
lines.append(f" fory.register_type({class_ref}, type_id={enum.type_id})")
else:
ns = self.package or "default"
lines.append(
f' fory.register_type({class_ref}, namespace="{ns}", typename="{type_name}")'
)
def generate_message_registration(
self, lines: List[str], message: Message, parent_path: str
):
"""Generate registration code for a message and its nested types."""
# In Python, nested class references use Outer.Inner syntax
class_ref = f"{parent_path}.{message.name}" if parent_path else message.name
type_name = class_ref if parent_path else message.name
if message.type_id is not None:
lines.append(
f" fory.register_type({class_ref}, type_id={message.type_id})"
)
else:
ns = self.package or "default"
lines.append(
f' fory.register_type({class_ref}, namespace="{ns}", typename="{type_name}")'
)
# Register nested enums
for nested_enum in message.nested_enums:
self.generate_enum_registration(lines, nested_enum, class_ref)
# Register nested messages
for nested_msg in message.nested_messages:
self.generate_message_registration(lines, nested_msg, class_ref)