genotype_cli 0.17.0

Genotype language CLI
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
# Python Target Overview

Genotype generates idiomatic Python code that can be used directly in the application or published as a package.

This overview shows how Genotype types translate to Python, target-specific features and configuration options.

See the [Quick Genotype Language Tour](language.md) for the language overview and [Python Configuration](python-configuration.md) for detailed configuration reference.

## Translation

The following examples give an overview of how Genotype translates into Python.

**Note:**

Latest and Legacy tabs show differences between [Python
versions](python-configuration.md#pyversion---python-version). Examples without tabs
apply to both. Feature examples omit imports. Genotype includes the required standard library,
[Pydantic](https://pypi.org/project/pydantic/), and [Genotype
runtime](https://pypi.org/project/genotype-runtime/) imports. The [complete
module](#complete-module) below shows them together.

### Complete Module

This source combines an object, a literal field, an optional field, a record, and `any`:

```type
Book: {
  kind: "book",
  displayTitle: string,
  subtitle?: string,
  ratings: { []: int },
  extra: any,
}
```

The generated module includes its type definitions and imports:

**Latest**

```python
from __future__ import annotations

from typing import Literal, Optional, Any
from pydantic import Field
from genotype import Model

class Book(Model):
    kind: Literal["book"]
    display_title: str = Field(alias="displayTitle")
    subtitle: Optional[str] = None
    ratings: dict[str, int]
    extra: Any
```

**Legacy**

```python
from __future__ import annotations

from typing import Literal, Optional, Dict, Any
from pydantic import Field
from genotype import Model

class Book(Model):
    kind: Literal["book"]
    display_title: str = Field(alias="displayTitle")
    subtitle: Optional[str] = None
    ratings: Dict[str, int]
    extra: Any
```

### Unions

Genotype unions translate into Python union types. Legacy output uses `Union[...]`.

```type
Value: string | int
```

**Latest**

```python
type Value = str | int
```

**Legacy**

```python
Value = Union[str, int]
```

### Primitives

#### Numeric Types

##### `number`

Genotype `number` translates into the Python `float` type.

```type
Amount: number
```

**Latest**

```python
type Amount = float
```

**Legacy**

```python
Amount = float
```

##### `int`

Genotype `int` translates directly to the Python `int` type.

```type
Count: int
```

**Latest**

```python
type Count = int
```

**Legacy**

```python
Count = int
```

##### `float`

Genotype `float` translates directly to the Python `float` type.

```type
Ratio: float
```

**Latest**

```python
type Ratio = float
```

**Legacy**

```python
Ratio = float
```

##### Sized Numeric Types

Sized Genotype integers translate into Python `int`, and sized floating-point types translate into `float`.

```type
SmallCount: i16
PreciseRatio: f32
LargeCount: i128
```

**Latest**

```python
type SmallCount = int

type PreciseRatio = float

type LargeCount = int
```

**Legacy**

```python
SmallCount = int

PreciseRatio = float

LargeCount = int
```

#### Booleans

Genotype `boolean` translates into the Python `bool` type.

```type
Ready: boolean
```

**Latest**

```python
type Ready = bool
```

**Legacy**

```python
Ready = bool
```

#### Strings

Genotype `string` translates into the Python `str` type.

```type
Title: string
```

**Latest**

```python
type Title = str
```

**Legacy**

```python
Title = str
```

#### Literal Types

Genotype literal types translate into Python `Literal` types, preserving their exact values.

```type
Category: "fiction"
```

**Latest**

```python
type Category = Literal["fiction"]
```

**Legacy**

```python
Category = Literal["fiction"]
```

#### Null

Genotype `null` translates into Python `Literal[None]`.

```type
Empty: null
```

**Latest**

```python
type Empty = Literal[None]
```

**Legacy**

```python
Empty = Literal[None]
```

#### Branded Primitives

Genotype branded primitives translate into Python `NewType` definitions. Type checkers distinguish them; runtime values retain the underlying primitive.

```type
BookId: @string
```

```python
BookId = NewType("BookId", str)
```

### Composite Types

#### Objects

Genotype objects translate into classes extending the [Genotype runtime](https://pypi.org/project/genotype-runtime/)'s [Pydantic](https://pypi.org/project/pydantic/)-based `Model`. Nested objects become separate model classes.

```type
Book: { title: string }
```

```python
class Book(Model):
    title: str
```

Use `Book.model_validate(data)` to validate incoming data and `book.model_dump()` to serialize it. Field names use `snake_case`, with aliases preserving their original names in serialized data.

##### Optional Object Fields

Optional Genotype object fields translate into Python `Optional[T]` fields, defaulting to `None`.

```type
Draft: { subtitle?: string }
```

```python
class Draft(Model):
    subtitle: Optional[str] = None
```

##### Object Extensions

Genotype object extensions translate into Python model inheritance.

```type
Named: { name: string }
NamedBook: { ...Named, pages: int }
```

```python
class Named(Model):
    name: str

class NamedBook(Named, Model):
    pages: int
```

#### Arrays

Genotype arrays translate into Python `list[T]` types. Legacy output uses `List[T]`.

```type
Titles: [string]
```

**Latest**

```python
type Titles = list[str]
```

**Legacy**

```python
Titles = List[str]
```

#### Tuples

Genotype tuples translate into Python `tuple` types. Legacy output uses `Tuple[...]`.

```type
Point: (float, float)
```

**Latest**

```python
type Point = tuple[float, float]
```

**Legacy**

```python
Point = Tuple[float, float]
```

#### Records

Genotype records translate into Python `dict[K, V]` types. Legacy output uses `Dict[K, V]`. An omitted key type means string keys.

```type
Scores: { []: int }
```

**Latest**

```python
type Scores = dict[str, int]
```

**Legacy**

```python
Scores = Dict[str, int]
```

### Special Data Types

#### Any Type

Genotype `any` translates into Python `typing.Any`.

```type
Payload: any
```

**Latest**

```python
type Payload = Any
```

**Legacy**

```python
Payload = Any
```

### Generic Types

Genotype generic types translate into Python generic models or aliases. You can specialize this model as `Envelope[Book]`.

```type
Envelope<Body>: { body: Body }
```

**Latest**

```python
class Envelope[Body](Model):
    body: Body
```

**Legacy**

```python
Body = TypeVar("Body")

class Envelope(Model, Generic[Body]):
    body: Body
```

### Recursive Types

Genotype recursive types translate into Python recursive types with forward references where needed.

```type
LinkedNode: { value: string, next?: LinkedNode }
```

```python
class LinkedNode(Model):
    value: str
    next: Optional[LinkedNode] = None
```

### Annotations

The `discriminator` annotation adds metadata to a union's JSON Schema:

```type
#[discriminator = "status"]
Result: Success | Failure

Success: { status: "ok", body: string }
Failure: { status: "error", message: string }
```

The generated union includes Pydantic field metadata identifying `status` as the discriminator. This adds schema metadata; it doesn't configure Pydantic's discriminated-union validation.

## Configuration

Use `[py]` in `genotype.toml` to configure Python. See the [Python Configuration Reference](python-configuration.md) for more details.

See [Genotype Configuration](configuration.md) for global settings and [Common Target Options](configuration.md#common-target-options).