People
Generate synthetic people.
PeopleParams
Bases: BaseModel
Parameters for people generation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale
|
str
|
Locale code for generating names (must be supported by Faker) |
required |
number
|
int
|
Number of people to generate (must be positive) |
required |
seed
|
int
|
Random seed for reproducibility |
required |
Source code in src/snailz/people.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
|
validate_fields(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.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
family
|
str
|
family name |
required |
ident
|
str
|
unique identifier |
required |
personal
|
str
|
personal name |
required |
Source code in src/snailz/people.py
33 34 35 36 37 38 |
|
AllPersons
Bases: BaseModel
A set of generated people.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
individuals
|
list[Person]
|
list of people |
required |
params
|
PeopleParams
|
parameters used to generate data |
required |
Source code in src/snailz/people.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
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
47 48 49 50 51 52 53 54 55 56 57 58 |
|
people_generate(params)
Generate synthetic people data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
PeopleParams
|
PeopleParams object |
required |
Returns:
Type | Description |
---|---|
AllPersons
|
AllPersons object containing generated individuals and parameters |
Source code in src/snailz/people.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|