faker.providers.python.en_US
¶
Package Contents¶
Classes¶
- class faker.providers.python.en_US.PythonProvider(generator: Any)¶
Bases:
faker.providers.BaseProvider
- default_value_types: faker.providers.ElementsType[str] = ('str', 'str', 'str', 'str', 'float', 'int', 'int', 'decimal', 'date_time', 'uri', 'email')¶
- _check_signature(value_types: Optional[TypesSpec], allowed_types: Optional[TypesSpec]) TypesSpec ¶
- pyobject(object_type: Optional[Type[Union[bool, str, float, int, tuple, set, list, Iterable, dict]]] = None) Optional[Union[bool, str, float, int, tuple, set, list, Iterable, dict]] ¶
Generates a random object passing the type desired.
- Object_type
the type of the object to generate.
- Returns
the random object generated.
- Raises
ValueError – if the object type passed is not supported
- pybool(truth_probability: int = 50) bool ¶
Generates a random boolean, optionally biased towards True or False.
- Truth_probability
Probability of generating a True value. Must be between 0 and 100 inclusive’.
- Returns
Random boolean.
- Raises
ValueError – If invalid truth_probability is provided.
- pystr(min_chars: Optional[int] = None, max_chars: int = 20, prefix: str = '', suffix: str = '') str ¶
Generates a random string of upper and lowercase letters.
- Parameters
min_chars – minimum length of the random part.
max_chars – maximum length of the random part.
prefix – an optional prefix to prepend to the random string.
suffix – an optional suffix to append to the random string.
- Returns
Random of random length between min and max characters.
- pystr_format(string_format: str = '?#-###{{random_int}}{{random_letter}}', letters: str = string.ascii_letters) str ¶
- pyfloat(left_digits=None, right_digits=None, positive=False, min_value=None, max_value=None)¶
- pydecimal(left_digits=None, right_digits=None, positive=False, min_value=None, max_value=None)¶
- pytuple(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) Tuple[Any, Ellipsis] ¶
- pyset(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) Set[Any] ¶
- pylist(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) List[Any] ¶
- pyiterable(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) Iterable[Any] ¶
- _pyiterable(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) Iterator ¶
- pydict(nb_elements: int = 10, variable_nb_elements: bool = True, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) Dict[Any, Any] ¶
Returns a dictionary.
- Nb_elements
number of elements for dictionary
- Variable_nb_elements
is use variable number of elements for dictionary
- Value_types
type of dictionary values
- pystruct(count: int = 10, value_types: Optional[TypesSpec] = None, allowed_types: Optional[TypesSpec] = None) Tuple[List, Dict, Dict] ¶
- enum(enum_cls: Type[TEnum]) TEnum ¶
Returns a random enum of the provided input Enum type.
- Parameters
enum_cls – The Enum type to produce the value for.
- Returns
A randomly selected enum value.
- class faker.providers.python.en_US.Provider(generator: Any)¶