Skip to content

mkname

mkname

mkname(names=(), prefix='', suffix='', max_tries=100, n_random_chars=4)

Generate a unique name by combining a given prefix and suffix with a randomly generated string.

Parameters:

Name Type Description Default
names Iterable[str]

Existing names to check for uniqueness. Defaults to an empty iterable.

()
prefix str

Prefix to prepend to the generated name. Defaults to an empty string.

''
suffix str

Suffix to append to the generated name. Defaults to an empty string.

''
max_tries int

Maximum number of attempts to generate a unique name. Defaults to 100.

100
n_random_chars int

Number of random characters to generate for the name. Defaults to 4.

4

Returns:

Type Description
str

A unique name that combines the prefix, randomly generated characters, and suffix.

Raises:

Type Description
ValueError

If the maximum number of attempts is exceeded and a unique name cannot be generated.

Examples:

>>> spark = SparkSession.builder.getOrCreate()
>>> df = FlickerDataFrame.from_shape(spark, 2, 4, names=['name', 'age', 'weight_lbs', 'height'])
>>> mkname(df.names, prefix='age_')
'age_bzrl'