Skip to content

Text

cognite.pygen.utils.text

as_plural(noun)

Pluralize a noun.

Parameters:

Name Type Description Default
noun str

The noun to pluralize.

 required

Returns: The pluralized noun.

Examples:

>>> as_plural('person')
'persons'
>>> as_plural('Roles')
'Roles'
>>> as_plural('activity')
'activities'
Source code in cognite/pygen/utils/text.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def as_plural(noun: str) -> str:
    """Pluralize a noun.

    Args:
        noun: The noun to pluralize.
    Returns:
        The pluralized noun.

    Examples:
        >>> as_plural('person')
        'persons'
        >>> as_plural('Roles')
        'Roles'
        >>> as_plural('activity')
        'activities'
    """
    numbers = re.findall(r"\d+$", noun)
    noun = noun[: -len(numbers[0])] if numbers else noun

    if noun.lower() in _S_EXCEPTIONS:
        noun = f"{noun}s" if noun[-1] != "s" else noun
    elif noun.lower() in _SINGULAR_BY_PLURAL:
        ...
    elif noun.lower() in _PLURAL_BY_SINGULAR:
        noun = _PLURAL_BY_SINGULAR[noun.lower()]
    elif noun and _Inflect.engine().singular_noun(noun) is False:
        noun = _Inflect.engine().plural_noun(noun)

    if numbers:
        return f"{noun}{numbers[0]}"
    else:
        return noun

as_singular(noun)

Singularize a noun.

Parameters:

Name Type Description Default
noun str

The noun to singularize.

 required

Returns: The singularized noun.

Examples:

>>> as_singular('persons')
'person'
>>> as_singular('Roles')
'Role'
>>> as_singular('role')
'role'
Source code in cognite/pygen/utils/text.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
def as_singular(noun: str) -> str:
    """Singularize a noun.

    Args:
        noun: The noun to singularize.
    Returns:
        The singularized noun.

    Examples:
        >>> as_singular('persons')
        'person'
        >>> as_singular('Roles')
        'Role'
        >>> as_singular('role')
        'role'
    """
    numbers = re.findall(r"\d+$", noun)
    noun = noun[: -len(numbers[0])] if numbers else noun
    if noun.lower() in _S_EXCEPTIONS:
        noun = noun[:-1] if noun[-1] == "s" else noun
    elif noun.lower() in _PLURAL_BY_SINGULAR:
        ...
    elif noun.lower() in _SINGULAR_BY_PLURAL:
        noun = _SINGULAR_BY_PLURAL[noun.lower()]
    elif noun and isinstance(singular := _Inflect.engine().singular_noun(noun), str):
        noun = singular

    if numbers:
        return f"{noun}{numbers[0]}"
    else:
        return noun

create_name(raw_name, naming)

Create a name from a raw name and following the given naming convention.

Parameters:

Name Type Description Default
raw_name str

The raw string to convert.

 required
naming Naming

The naming convention to follow.

 required

Returns:

Type Description
str

The converted name.
Source code in cognite/pygen/utils/text.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def create_name(raw_name: str, naming: Naming) -> str:
    """
    Create a name from a raw name and following the given naming convention.

    Args:
        raw_name: The raw string to convert.
        naming: The naming convention to follow.

    Returns:
        The converted name.

    """
    is_plural = naming.number == Number.plural
    is_singular = naming.number == Number.singular
    if naming.case is Case.pascal:
        return to_pascal(raw_name, is_plural, is_singular)
    elif naming.case is Case.snake:
        return to_snake(raw_name, is_plural, is_singular)
    elif naming.case is Case.camel:
        return to_camel(raw_name, is_plural, is_singular)
    elif naming.case is Case.human:
        return to_words(raw_name, is_plural, is_singular)
    else:
        return raw_name

to_camel(string, pluralize=False, singularize=False)

Convert snake_case_name to camelCaseName.

Parameters:

Name Type Description Default
string str

The string to convert.

 required
pluralize bool

Whether to pluralize the last word.

 False
singularize bool

Whether to singularize the last word.

 False

Returns: camelCase of the input string.

Examples:

>>> to_camel("a_b")
'aB'
>>> to_camel('camel_case', pluralize=True)
'camelCases'
>>> to_camel('best_directors', singularize=True)
'bestDirector'
>>> to_camel("ScenarioInstance_priceForecast")
'scenarioInstancePriceForecast'
Source code in cognite/pygen/utils/text.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
def to_camel(string: str, pluralize: bool = False, singularize: bool = False) -> str:
    """Convert snake_case_name to camelCaseName.

    Args:
        string: The string to convert.
        pluralize: Whether to pluralize the last word.
        singularize: Whether to singularize the last word.
    Returns:
        camelCase of the input string.

    Examples:
        >>> to_camel("a_b")
        'aB'
        >>> to_camel('camel_case', pluralize=True)
        'camelCases'
        >>> to_camel('best_directors', singularize=True)
        'bestDirector'
        >>> to_camel("ScenarioInstance_priceForecast")
        'scenarioInstancePriceForecast'
    """
    if "_" in string:
        # Could be a combination of snake and pascal/camel case
        parts = string.split("_")
        pascal_splits = [to_pascal(subpart) for part in parts for subpart in part.split("-") if subpart]
    elif "-" in string:
        # Could be a combination of kebab and pascal/camel case
        parts = string.split("-")
        pascal_splits = [to_pascal(subpart) for part in parts for subpart in part.split("_") if subpart]
    else:
        # Assume is pascal/camel case
        # Ensure pascal
        string = string[0].upper() + string[1:]
        pascal_splits = [string]
    string_split = []
    for part in pascal_splits:
        string_split.extend(re.findall(r"[A-Z][a-z0-9]*", part))
    if not string_split:
        string_split = [string]
    if pluralize and singularize:
        raise ValueError("Cannot pluralize and singularize at the same time")
    elif pluralize:
        string_split[-1] = as_plural(string_split[-1].casefold())
    elif singularize:
        string_split[-1] = as_singular(string_split[-1].casefold())
    try:
        return string_split[0].casefold() + "".join(word.capitalize() for word in string_split[1:])
    except IndexError:
        return ""

to_pascal(string, pluralize=False, singularize=False)

Convert string to PascalCaseName.

Parameters:

Name Type Description Default
string str

The string to convert.

 required
pluralize bool

Whether to pluralize the last word.

 False
singularize bool

Whether to singularize the last word.

 False

Returns: PascalCase of the input string.

Examples:

>>> to_pascal("a_b")
'AB'
>>> to_pascal('camel_case', pluralize=True)
'CamelCases'
>>> to_pascal('best_directors', singularize=True)
'BestDirector'
>>> to_pascal("BestLeadingActress", singularize=True)
'BestLeadingActress'
>>> to_pascal("priceScenarios", pluralize=True)
'PriceScenarios'
>>> to_pascal("reserveScenarios", pluralize=True)
'ReserveScenarios'
>>> to_pascal("ScenarioInstance_priceForecast")
'ScenarioInstancePriceForecast'
Source code in cognite/pygen/utils/text.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def to_pascal(string: str, pluralize: bool = False, singularize: bool = False) -> str:
    """Convert string to PascalCaseName.

    Args:
        string: The string to convert.
        pluralize: Whether to pluralize the last word.
        singularize: Whether to singularize the last word.
    Returns:
        PascalCase of the input string.

    Examples:
        >>> to_pascal("a_b")
        'AB'
        >>> to_pascal('camel_case', pluralize=True)
        'CamelCases'
        >>> to_pascal('best_directors', singularize=True)
        'BestDirector'
        >>> to_pascal("BestLeadingActress", singularize=True)
        'BestLeadingActress'
        >>> to_pascal("priceScenarios", pluralize=True)
        'PriceScenarios'
        >>> to_pascal("reserveScenarios", pluralize=True)
        'ReserveScenarios'
        >>> to_pascal("ScenarioInstance_priceForecast")
        'ScenarioInstancePriceForecast'
    """
    camel = to_camel(string, pluralize, singularize)
    return f"{camel[0].upper()}{camel[1:]}" if camel else ""

to_snake(string, pluralize=False, singularize=False)

Convert input string to snake_case

Parameters:

Name Type Description Default
string str

The string to convert.

 required
pluralize bool

Whether to pluralize the last word.

 False
singularize bool

Whether to singularize the last word.

 False

Returns: snake_case of the input string.

Examples:

>>> to_snake("aB")
'a_b'
>>> to_snake('CamelCase')
'camel_case'
>>> to_snake('camelCamelCase')
'camel_camel_case'
>>> to_snake('Camel2Camel2Case')
'camel_2_camel_2_case'
>>> to_snake('getHTTPResponseCode')
'get_http_response_code'
>>> to_snake('get200HTTPResponseCode')
'get_200_http_response_code'
>>> to_snake('getHTTP200ResponseCode')
'get_http_200_response_code'
>>> to_snake('HTTPResponseCode')
'http_response_code'
>>> to_snake('ResponseHTTP')
'response_http'
>>> to_snake('ResponseHTTP2')
'response_http_2'
>>> to_snake('Fun?!awesome')
'fun_awesome'
>>> to_snake('Fun?!Awesome')
'fun_awesome'
>>> to_snake('10CoolDudes')
'10_cool_dudes'
>>> to_snake('20coolDudes')
'20_cool_dudes'
>>> to_snake('BestDirector', pluralize=True)
'best_directors'
>>> to_snake('BestDirectors', singularize=True)
'best_director'
>>> to_snake('BestLeadingActress', pluralize=True)
'best_leading_actresses'
>>> to_snake('APM_Activity', pluralize=True)
'apm_activities'
>>> to_snake('APM_Activities', singularize=True)
'apm_activity'
>>> to_snake('APM_Operation', pluralize=True)
'apm_operations'
>>> to_snake('APM_Asset', pluralize=True)
'apm_assets'
>>> to_snake('APM_Material', pluralize=True)
'apm_materials'
Source code in cognite/pygen/utils/text.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def to_snake(string: str, pluralize: bool = False, singularize: bool = False) -> str:
    """
    Convert input string to snake_case

    Args:
        string: The string to convert.
        pluralize: Whether to pluralize the last word.
        singularize: Whether to singularize the last word.
    Returns:
        snake_case of the input string.

    Examples:
        >>> to_snake("aB")
        'a_b'
        >>> to_snake('CamelCase')
        'camel_case'
        >>> to_snake('camelCamelCase')
        'camel_camel_case'
        >>> to_snake('Camel2Camel2Case')
        'camel_2_camel_2_case'
        >>> to_snake('getHTTPResponseCode')
        'get_http_response_code'
        >>> to_snake('get200HTTPResponseCode')
        'get_200_http_response_code'
        >>> to_snake('getHTTP200ResponseCode')
        'get_http_200_response_code'
        >>> to_snake('HTTPResponseCode')
        'http_response_code'
        >>> to_snake('ResponseHTTP')
        'response_http'
        >>> to_snake('ResponseHTTP2')
        'response_http_2'
        >>> to_snake('Fun?!awesome')
        'fun_awesome'
        >>> to_snake('Fun?!Awesome')
        'fun_awesome'
        >>> to_snake('10CoolDudes')
        '10_cool_dudes'
        >>> to_snake('20coolDudes')
        '20_cool_dudes'
        >>> to_snake('BestDirector', pluralize=True)
        'best_directors'
        >>> to_snake('BestDirectors', singularize=True)
        'best_director'
        >>> to_snake('BestLeadingActress', pluralize=True)
        'best_leading_actresses'
        >>> to_snake('APM_Activity', pluralize=True)
        'apm_activities'
        >>> to_snake('APM_Activities', singularize=True)
        'apm_activity'
        >>> to_snake('APM_Operation', pluralize=True)
        'apm_operations'
        >>> to_snake('APM_Asset', pluralize=True)
        'apm_assets'
        >>> to_snake('APM_Material', pluralize=True)
        'apm_materials'
    """
    pattern = re.compile(r"[A-Z]?[a-z]+|[A-Z]+(?=[A-Z][a-z]|\d|\W|$)|\d+")
    if "_" in string:
        words = [word for section in string.split("_") for word in pattern.findall(section)]
    else:
        words = pattern.findall(string)
    if pluralize and singularize:
        raise ValueError("Cannot pluralize and singularize at the same time")
    elif pluralize:
        words[-1] = as_plural(words[-1].casefold())
    elif singularize:
        words[-1] = as_singular(words[-1].casefold())
    return "_".join(map(str.lower, words))

to_words(string, pluralize=False, singularize=False)

Convert input string to words

Parameters:

Name Type Description Default
string str

The string to convert.

 required
pluralize bool

Whether to pluralize the last word.

 False
singularize bool

Whether to singularize the last word.

 False

Returns: words of the input string.

Examples:

>>> to_words("aB")
'a b'
>>> to_words('CamelCase')
'camel case'
>>> to_words('APM_Activity', pluralize=True)
'apm activities'
>>> to_words('APM_Activities', singularize=True)
'apm activity'
Source code in cognite/pygen/utils/text.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def to_words(string: str, pluralize: bool = False, singularize: bool = False):
    """
    Convert input string to words

    Args:
        string: The string to convert.
        pluralize: Whether to pluralize the last word.
        singularize: Whether to singularize the last word.
    Returns:
        words of the input string.

    Examples:
        >>> to_words("aB")
        'a b'
        >>> to_words('CamelCase')
        'camel case'
        >>> to_words('APM_Activity', pluralize=True)
        'apm activities'
        >>> to_words('APM_Activities', singularize=True)
        'apm activity'
    """
    return to_snake(string, pluralize, singularize).replace("_", " ")