Persons
Generate random persons.
PersonParams
Bases: BaseModel
Parameters for people generation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
locale
|
str
|
Locale for names |
'et_EE'
|
number
|
int
|
Number of people |
5
|
Source code in src/snailz/persons.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
validate_fields(v)
Validate that the locale is available in faker.
Source code in src/snailz/persons.py
20 21 22 23 24 25 |
|
Person
Bases: BaseModel
A single person.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ident
|
str
|
unique identifier |
required |
family
|
str
|
family name |
required |
personal
|
str
|
personal name |
required |
Source code in src/snailz/persons.py
28 29 30 31 32 33 34 35 |
|
AllPersons
Bases: BaseModel
A set of generated people.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
items
|
list[Person]
|
all persons |
required |
Source code in src/snailz/persons.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
to_csv()
Create a CSV representation of the people data.
Returns:
Type | Description |
---|---|
str
|
A CSV-formatted string with people data. |
Source code in src/snailz/persons.py
45 46 47 48 49 50 51 52 53 54 55 |
|
persons_generate(params)
Generate random persons.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
PersonParams
|
Data generation parameters. |
required |
Returns:
Type | Description |
---|---|
AllPersons
|
Data model including all persons. |
Source code in src/snailz/persons.py
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 |
|
_person_id_generator(family, personal)
Generate unique ID for a person.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
family
|
str
|
Person's family name. |
required |
personal
|
str
|
Person's personal name. |
required |
Returns:
Type | Description |
---|---|
str
|
Candidate identifier 'CCNNNN'. |
Source code in src/snailz/persons.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
|