Skip to content

Commit ed559eb

Browse files
stephenfinstephenfin
committed
typing: Add hints to new vpnaas commands
Change-Id: I657e2030749d7d62d8c1f22833460a4f46e21e6b Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
1 parent 6754dca commit ed559eb

7 files changed

Lines changed: 138 additions & 82 deletions

File tree

‎openstackclient/network/v2/vpnaas/endpoint_group.py‎

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
1313
# License for the specific language governing permissions and limitations
1414
# under the License.
15-
#
15+
16+
import argparse
17+
from collections.abc import Iterable, Sequence
18+
from typing import Any
1619

1720
from osc_lib.cli import identity as identity_utils
1821
from osc_lib import exceptions
@@ -46,7 +49,7 @@
4649
class CreateEndpointGroup(command.ShowOne):
4750
_description = _("Create an endpoint group")
4851

49-
def get_parser(self, prog_name):
52+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
5053
parser = super().get_parser(prog_name)
5154
parser.add_argument(
5255
'--description',
@@ -78,7 +81,9 @@ def get_parser(self, prog_name):
7881
identity_utils.add_project_owner_option_to_parser(parser)
7982
return parser
8083

81-
def take_action(self, parsed_args):
84+
def take_action(
85+
self, parsed_args: argparse.Namespace
86+
) -> tuple[Sequence[str], Iterable[Any]]:
8287
client = self.app.client_manager.network
8388
attrs = {}
8489
if parsed_args.project is not None:
@@ -112,7 +117,7 @@ def take_action(self, parsed_args):
112117
class DeleteEndpointGroup(command.Command):
113118
_description = _("Delete endpoint group(s)")
114119

115-
def get_parser(self, prog_name):
120+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
116121
parser = super().get_parser(prog_name)
117122
parser.add_argument(
118123
'endpoint_group',
@@ -122,7 +127,7 @@ def get_parser(self, prog_name):
122127
)
123128
return parser
124129

125-
def take_action(self, parsed_args):
130+
def take_action(self, parsed_args: argparse.Namespace) -> None:
126131
client = self.app.client_manager.network
127132
result = 0
128133
for endpoint in parsed_args.endpoint_group:
@@ -149,7 +154,7 @@ def take_action(self, parsed_args):
149154
class ListEndpointGroup(command.Lister):
150155
_description = _("List endpoint groups that belong to a given project")
151156

152-
def get_parser(self, prog_name):
157+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
153158
parser = super().get_parser(prog_name)
154159
parser.add_argument(
155160
'--long',
@@ -159,7 +164,9 @@ def get_parser(self, prog_name):
159164
)
160165
return parser
161166

162-
def take_action(self, parsed_args):
167+
def take_action(
168+
self, parsed_args: argparse.Namespace
169+
) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
163170
client = self.app.client_manager.network
164171
obj = client.vpn_endpoint_groups()
165172
headers, columns = column_util.get_column_definitions(
@@ -171,7 +178,7 @@ def take_action(self, parsed_args):
171178
class SetEndpointGroup(command.Command):
172179
_description = _("Set endpoint group properties")
173180

174-
def get_parser(self, prog_name):
181+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
175182
parser = super().get_parser(prog_name)
176183
parser.add_argument(
177184
'--description',
@@ -190,7 +197,7 @@ def get_parser(self, prog_name):
190197
)
191198
return parser
192199

193-
def take_action(self, parsed_args):
200+
def take_action(self, parsed_args: argparse.Namespace) -> None:
194201
client = self.app.client_manager.network
195202
attrs = {}
196203
if parsed_args.description:
@@ -212,7 +219,7 @@ def take_action(self, parsed_args):
212219
class ShowEndpointGroup(command.ShowOne):
213220
_description = _("Display endpoint group details")
214221

215-
def get_parser(self, prog_name):
222+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
216223
parser = super().get_parser(prog_name)
217224
parser.add_argument(
218225
'endpoint_group',
@@ -221,7 +228,9 @@ def get_parser(self, prog_name):
221228
)
222229
return parser
223230

224-
def take_action(self, parsed_args):
231+
def take_action(
232+
self, parsed_args: argparse.Namespace
233+
) -> tuple[Sequence[str], Iterable[Any]]:
225234
client = self.app.client_manager.network
226235
obj = client.find_vpn_endpoint_group(
227236
parsed_args.endpoint_group, ignore_missing=False

‎openstackclient/network/v2/vpnaas/ikepolicy.py‎

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
1313
# License for the specific language governing permissions and limitations
1414
# under the License.
15-
#
15+
16+
import argparse
17+
from collections.abc import Iterable, Sequence
18+
from typing import Any
1619

1720
from osc_lib.cli import identity as identity_utils
1821
from osc_lib import exceptions
@@ -116,11 +119,13 @@
116119
]
117120

118121

119-
def _convert_to_lowercase(string):
122+
def _convert_to_lowercase(string: str) -> str:
120123
return string.lower()
121124

122125

123-
def _get_common_parser(parser):
126+
def _get_common_parser(
127+
parser: argparse.ArgumentParser,
128+
) -> argparse.ArgumentParser:
124129
parser.add_argument(
125130
'--description',
126131
metavar='<description>',
@@ -165,8 +170,8 @@ def _get_common_parser(parser):
165170
return parser
166171

167172

168-
def _get_common_attrs(parsed_args):
169-
attrs = {}
173+
def _get_common_attrs(parsed_args: argparse.Namespace) -> dict[str, Any]:
174+
attrs: dict[str, Any] = {}
170175
if parsed_args.description:
171176
attrs['description'] = parsed_args.description
172177
if parsed_args.auth_algorithm:
@@ -188,7 +193,7 @@ def _get_common_attrs(parsed_args):
188193
class CreateIKEPolicy(command.ShowOne):
189194
_description = _("Create an IKE policy")
190195

191-
def get_parser(self, prog_name):
196+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
192197
parser = super().get_parser(prog_name)
193198
_get_common_parser(parser)
194199
parser.add_argument(
@@ -197,7 +202,9 @@ def get_parser(self, prog_name):
197202
identity_utils.add_project_owner_option_to_parser(parser)
198203
return parser
199204

200-
def take_action(self, parsed_args):
205+
def take_action(
206+
self, parsed_args: argparse.Namespace
207+
) -> tuple[Sequence[str], Iterable[Any]]:
201208
client = self.app.client_manager.network
202209
attrs = _get_common_attrs(parsed_args)
203210
if 'project' in parsed_args and parsed_args.project is not None:
@@ -219,7 +226,7 @@ def take_action(self, parsed_args):
219226
class DeleteIKEPolicy(command.Command):
220227
_description = _("Delete IKE policy (policies)")
221228

222-
def get_parser(self, prog_name):
229+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
223230
parser = super().get_parser(prog_name)
224231
parser.add_argument(
225232
'ikepolicy',
@@ -229,7 +236,7 @@ def get_parser(self, prog_name):
229236
)
230237
return parser
231238

232-
def take_action(self, parsed_args):
239+
def take_action(self, parsed_args: argparse.Namespace) -> None:
233240
client = self.app.client_manager.network
234241
result = 0
235242
for ike in parsed_args.ikepolicy:
@@ -256,7 +263,7 @@ def take_action(self, parsed_args):
256263
class ListIKEPolicy(command.Lister):
257264
_description = _("List IKE policies that belong to a given project")
258265

259-
def get_parser(self, prog_name):
266+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
260267
parser = super().get_parser(prog_name)
261268
parser.add_argument(
262269
'--long',
@@ -265,7 +272,9 @@ def get_parser(self, prog_name):
265272
)
266273
return parser
267274

268-
def take_action(self, parsed_args):
275+
def take_action(
276+
self, parsed_args: argparse.Namespace
277+
) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
269278
client = self.app.client_manager.network
270279
obj = client.vpn_ike_policies()
271280
headers, columns = column_util.get_column_definitions(
@@ -277,7 +286,7 @@ def take_action(self, parsed_args):
277286
class SetIKEPolicy(command.Command):
278287
_description = _("Set IKE policy properties")
279288

280-
def get_parser(self, prog_name):
289+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
281290
parser = super().get_parser(prog_name)
282291
_get_common_parser(parser)
283292
parser.add_argument(
@@ -290,7 +299,7 @@ def get_parser(self, prog_name):
290299
)
291300
return parser
292301

293-
def take_action(self, parsed_args):
302+
def take_action(self, parsed_args: argparse.Namespace) -> None:
294303
client = self.app.client_manager.network
295304
attrs = _get_common_attrs(parsed_args)
296305
if parsed_args.name:
@@ -311,7 +320,7 @@ def take_action(self, parsed_args):
311320
class ShowIKEPolicy(command.ShowOne):
312321
_description = _("Display IKE policy details")
313322

314-
def get_parser(self, prog_name):
323+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
315324
parser = super().get_parser(prog_name)
316325
parser.add_argument(
317326
'ikepolicy',
@@ -320,7 +329,9 @@ def get_parser(self, prog_name):
320329
)
321330
return parser
322331

323-
def take_action(self, parsed_args):
332+
def take_action(
333+
self, parsed_args: argparse.Namespace
334+
) -> tuple[Sequence[str], Iterable[Any]]:
324335
client = self.app.client_manager.network
325336
obj = client.find_vpn_ike_policy(
326337
parsed_args.ikepolicy, ignore_missing=False

0 commit comments

Comments
 (0)