-
Notifications
You must be signed in to change notification settings - Fork 4
/
pyheck.pyi
166 lines (124 loc) · 4.9 KB
/
pyheck.pyi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
84
85
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
114
115
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
from typing import Sequence
def snake(s: str) -> str:
"""Convert to snake_case.
In snake_case, word boundaries are indicated by underscores.
Example:
>>> from pyheck import snake
>>> snake("We carry a new world here, in our hearts.")
'we_carry_a_new_world_here_in_our_hearts'
"""
def snake_many(strings: Sequence[str]) -> list[str]:
"""Convert a list of strings to snake_case.
In snake_case, word boundaries are indicated by underscores.
Example:
>>> from pyheck import snake_many
>>> snake_many(["DeviceType", "fooBar"])
['device_type', 'foo_bar']
"""
def lower_camel(s: str) -> str:
"""Convert to lowerCamelCase.
In lowerCamelCase, word boundaries are indicated by capital letters,
excepting the first word.
Example:
>>> from pyheck import lower_camel
>>> lower_camel("It is we who built these palaces and cities.")
'itIsWeWhoBuiltThesePalacesAndCities'
"""
def lower_camel_many(strings: Sequence[str]) -> list[str]:
"""Convert a list of strings to lowerCamelCase.
In lowerCamelCase, word boundaries are indicated by capital letters,
excepting the first word.
Example:
>>> from pyheck import lower_camel_many
>>> lower_camel_many(["It is we", "who built these"])
['itIsWe', 'whoBuiltThese']
"""
def title(s: str) -> str:
"""Convert to Title Case.
In Title Case, word boundaries are indicated by spaces, and every word is
capitalized.
Example:
>>> from pyheck import title
>>> title("We have always lived in slums and holes in the wall.")
'We Have Always Lived In Slums And Holes In The Wall'
"""
def title_many(strings: Sequence[str]) -> list[str]:
"""Convert a list of strings to Title Case.
In Title Case, word boundaries are indicated by spaces, and every word is
capitalized.
Example:
>>> from pyheck import title_many
>>> title_many(["We have always", "lived in slums"])
['We Have Always', 'Lived In Slums']
>>> print(title_many.__doc__)
"""
def upper_camel(s: str) -> str:
"""Convert to UpperCamelCase.
In UpperCamelCase, word boundaries are indicated by capital letters,
including the first word.
Example:
>>> from pyheck import upper_camel
>>> upper_camel("We are not in the least afraid of ruins.")
'WeAreNotInTheLeastAfraidOfRuins'
"""
def upper_camel_many(strings: Sequence[str]) -> list[str]:
"""Convert a list of strings to UpperCamelCase.
In UpperCamelCase, word boundaries are indicated by capital letters,
including the first word.
Example:
>>> from pyheck import upper_camel_many
>>> upper_camel_many(["We are not", "in the least"])
['WeAreNot', 'InTheLeast']
"""
def kebab(s: str) -> str:
"""Convert to kebab-case.
In kebab-case, word boundaries are indicated by hyphens.
Example:
>>> from pyheck import kebab
>>> kebab("We are going to inherit the earth.")
'we-are-going-to-inherit-the-earth'
"""
def kebab_many(strings: Sequence[str]) -> list[str]:
"""Convert list of strings to kebab-case.
In kebab-case, word boundaries are indicated by hyphens.
Example:
>>> from pyheck import kebab_many
>>> kebab_many(["We are going", "to inherit the earth."])
['we-are-going', 'to-inherit-the-earth']
"""
def shouty_kebab(s: str) -> str:
"""Convert to SHOUTY-KEBAB-CASE.
In SHOUTY-KEBAB-CASE, word boundaries are indicated by hyphens and all
words are in uppercase.
Example:
>>> from pyheck import shouty_kebab
>>> shouty_kebab("We are going to inherit the earth.")
'WE-ARE-GOING-TO-INHERIT-THE-EARTH'
"""
def shouty_kebab_many(strings: Sequence[str]) -> list[str]:
"""Convert a list of strings to SHOUTY-KEBAB-CASE.
In SHOUTY-KEBAB-CASE, word boundaries are indicated by hyphens and all
words are in uppercase.
Example:
>>> from pyheck import shouty_kebab_many
>>> shouty_kebab_many(["We are going", "to inherit the earth."])
['WE-ARE-GOING', 'TO-INHERIT-THE-EARTH']
"""
def shouty_snake(s: str) -> str:
"""Convert to SHOUTY_SNAKE_CASE.
In SHOUTY_SNAKE_CASE, word boundaries are indicated by underscores and all
words are in uppercase.
Example:
>>> from pyheck import shouty_snake
>>> shouty_snake("That world is growing in this minute.")
'THAT_WORLD_IS_GROWING_IN_THIS_MINUTE'
"""
def shouty_snake_many(strings: Sequence[str]) -> list[str]:
"""Convert a list of strings to SHOUTY_SNAKE_CASE.
In SHOUTY_SNAKE_CASE, word boundaries are indicated by underscores and all
words are in uppercase.
Example:
>>> from pyheck import shouty_snake_many
>>> shouty_snake_many(["That world is", "growing in this minute."])
['THAT_WORLD_IS', 'GROWING_IN_THIS_MINUTE']
"""