People
Generate synthetic people.
PeopleParams
Bases: BaseModel
Parameters for people generation.
- locale: Locale code for generating names (must be supported by Faker)
- number: Number of people to generate (must be positive)
- seed: Random seed for reproducibility
Source code in src/snailz/people.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
|
validate_locale(v)
Validate that the locale is available in faker.
Source code in src/snailz/people.py
25 26 27 28 29 30 |
|
Person
Bases: BaseModel
A single person.
- family: family name
- ident: unique identifier
- personal: personal name
Source code in src/snailz/people.py
35 36 37 38 39 40 41 42 43 44 45 |
|
People
Bases: BaseModel
A set of generated people.
- individuals: list of people
- params: parameters used to generate this data
Source code in src/snailz/people.py
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
|
to_csv()
Return a CSV string representation of the people data.
Returns:
Type | Description |
---|---|
str
|
A CSV-formatted string with people data (without parameters) using Unix line endings |
Source code in src/snailz/people.py
58 59 60 61 62 63 64 65 66 67 68 69 |
|
people_generate(params)
Generate synthetic people data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
PeopleParams
|
PeopleParams object |
required |
Returns:
Type | Description |
---|---|
People
|
People object containing generated individuals and parameters |
Source code in src/snailz/people.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|