Name Utilities

Name Utilities.

split_prefix cached

split_prefix(name)

Split Name Into Prefix and Basename.

Parameters:

Name	Type	Description	Default
name	str	Name.	required

Returns:

Name	Type	Description
tuple	tuple[str, str]	Tuple of Prefix and Basename

split_prefix Examples

Example:

>>> split_prefix("i_count")
('i_', 'count')
>>> split_prefix("u_count")
('u_', 'count')
>>> split_prefix("I_VERY_LONG_NAME")
('I_', 'VERY_LONG_NAME')
>>> split_prefix("")
('', '')

The counterpart to this function is `join_names`.

split_suffix cached

split_suffix(name, suffixes=None)

Split Name Into Basename And Suffix.

Parameters:

Name	Type	Description	Default
name	str	Name.	required

Other Parameters:

Name	Type	Description
suffixes		Suffixes.

Returns:

Name	Type	Description
tuple	tuple[str, str]	Tuple of Basename and Suffix

split_suffix Examples

Example:

>>> split_suffix("count_i")
('count', '_i')
>>> split_suffix("count_o")
('count', '_o')
>>> split_suffix("count_io")
('count', '_io')
>>> split_suffix("count_t")
('count', '_t')
>>> split_suffix("count_s")
('count', '_s')
>>> split_suffix("_s")
('', '_s')
>>> split_suffix("very_long_name_s")
('very_long_name', '_s')
>>> split_suffix("VERY_LONG_NAME_S")
('VERY_LONG_NAME', '_S')
>>> split_suffix("")
('', '')

The counterpart to this function is `join_names`.

join_names

join_names(*names, concat='_')

Join Names.

Parameters:

Name	Type	Description	Default
names		Names.	()

Other Parameters:

Name	Type	Description
concat		concat.

join_names Examples

Example:

>>> join_names('foo', 'bar')
'foo_bar'
>>> join_names('', 'bar')
'bar'
>>> join_names('foo', '')
'foo'

This function is the counterpart to split_names.

didyoumean

didyoumean(name, names, known=False, multiline=False)

Propose matching names.

Parameters:

Name	Type	Description	Default
name		Name.	required
names		Names.	required

Other Parameters:

Name	Type	Description
known		Show known strings.
multiline		Add new line

didyoumean Examples

Example:

>>> didyoumean('abb', tuple())
''
>>> didyoumean('abb', ('abba', 'ac/dc', 'beatles'), known=True)
" Known are 'abba', 'ac/dc' and 'beatles'. Did you mean 'abba'?"
>>> print(didyoumean('zz-top', ('abba', 'ac/dc', 'beatles'), known=True, multiline=True))
<BLANKLINE>
Known are 'abba', 'ac/dc' and 'beatles'.

get_snakecasename

get_snakecasename(item)

Get snakecase name of cls.

get_snakecasename Examples

Example:

>>> class MyClass:
...     pass
>>> get_snakecasename(MyClass)
'my_class'
>>> get_snakecasename("MyClass")
'my_class'
>>> get_snakecasename("MYClass")
'myclass'

str2identifier

str2identifier(value)

Convert Any String To Identifier.

Parameters:

Name	Type	Description	Default
value	str	Any String	required

str2identifier Examples

Example:

>>> str2identifier('A B C')
'a_b_c'
>>> str2identifier('1 2 3')
'v1_2_3'
>>> str2identifier('12.3')
'v123'