/usr/lib/python3/dist-packages/botocore/parameters.py is in python3-botocore 0.29.0+repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 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 263 264 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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 | # Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/
# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish, dis-
# tribute, sublicense, and/or sell copies of the Software, and to permit
# persons to whom the Software is furnished to do so, subject to the fol-
# lowing conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
import logging
import base64
import datetime
import decimal
import six
import dateutil.parser
from botocore import BotoCoreObject
from botocore.exceptions import ValidationError, RangeError, UnknownKeyError
from botocore.exceptions import MissingParametersError
logger = logging.getLogger(__name__)
class Parameter(BotoCoreObject):
def __init__(self, operation, **kwargs):
self.operation = operation
self.xmlname = None
self.required = False
self.flattened = False
self.allow_file = False
self.min = None
self.max = None
self.payload = False
self.streaming = False
self.example_fn = None
BotoCoreObject.__init__(self, **kwargs)
self.cli_name = '--' + self.cli_name
self._handle_subtypes()
def _handle_subtypes(self):
# Subclasses can implement this method to handle
# any members they might have (useful for complex types).
pass
def validate(self, value):
"""Validate the value.
If a parameter decides the value is not a valid value
then they can raise a ``ValidationError``.
"""
pass
def get_label(self):
if self.xmlname:
label = self.xmlname
else:
label = self.name
return label
def store_value_query(self, value, built_params, label):
if label:
label = label.format(label=self.get_label())
else:
label = self.get_label()
built_params[label] = str(value)
def build_parameter_query(self, value, built_params, label=''):
value = self.validate(value)
self.store_value_query(value, built_params, label)
def store_value_json(self, value, built_params, label):
if isinstance(built_params, list):
built_params.append(value)
else:
label = self.get_label()
built_params[label] = value
def build_parameter_json(self, value, built_params, label=''):
value = self.validate(value)
self.store_value_json(value, built_params, value)
def build_parameter_rest(self, style, value, built_params, label=''):
if hasattr(self, 'location'):
if self.location == 'uri':
built_params['uri_params'][self.name] = value
elif self.location == 'header':
if hasattr(self, 'location_name'):
key = self.location_name
else:
key = self.name
built_params['headers'][key] = value
elif style == 'rest-json' or style == 'rest-xml':
payload = built_params.get('payload')
if payload is not None:
payload.add_param(self, value, label)
def build_parameter(self, style, value, built_params, label=''):
self.validate(value)
if style == 'query':
self.build_parameter_query(value, built_params, label)
elif style == 'json':
self.build_parameter_json(value, built_params, label)
elif style in ('rest-xml', 'rest-json'):
self.build_parameter_rest(style, value, built_params, label)
def to_xml(self, value, label=None):
if not label:
label = self.name
return '<%s>%s</%s>' % (label, value, label)
class IntegerParameter(Parameter):
def validate(self, value):
if not isinstance(value, six.integer_types):
raise ValidationError(value=str(value), type_name='integer',
param=self)
if self.min:
if value < self.min:
raise RangeError(value=value,
param=self,
min_value=self.min,
max_value=self.max)
if self.max:
if value > self.max:
raise RangeError(value=value,
param=self,
min_value=self.min,
max_value=self.max)
return value
class FloatParameter(Parameter):
def validate(self, value):
original_value = value
# So isinstance(True, int) -> True.
# For a float parameter we should not allow a bool.
if isinstance(value, bool):
raise ValidationError(value=str(value), type_name='float',
param=self)
elif not isinstance(value, float):
# If the value is a float, that's good enough for a float
# param. Also you can't go directly from a float -> Decimal
# in python2.6.
# Otherwise the value has to look like a decimal,
# so we just need to validate that it converts to a
# decimal without issue and then run it through the min
# max range validations.
try:
# We don't want to type convert here, but we need
# to convert it to something we can use < and > against.
value = decimal.Decimal(value)
except (decimal.InvalidOperation, TypeError):
raise ValidationError(value=str(value), type_name='float',
param=self)
if self.min:
if value < self.min:
raise RangeError(value=value,
param=self,
min_value=self.min,
max_value=self.max)
if self.max:
if value > self.max:
raise RangeError(value=value,
param=self,
min_value=self.min,
max_value=self.max)
return original_value
class DoubleParameter(Parameter):
def validate(self, value):
if not isinstance(value, float):
raise ValidationError(value=str(value), type_name='double',
param=self)
if self.min:
if value < self.min:
raise RangeError(value=value,
param=self,
min_value=self.min,
max_value=self.max)
if self.max:
if value > self.max:
raise RangeError(value=value,
param=self,
min_value=self.min,
max_value=self.max)
return value
class BooleanParameter(Parameter):
def validate(self, value):
try:
if not isinstance(value, bool):
if isinstance(value, six.string_types):
if value.lower() == 'true':
value = True
elif value.lower() == 'false':
value = False
else:
raise ValueError
return value
except ValueError:
raise ValidationError(value=str(value), type_name='boolean',
param=self)
def _getstring(self, value):
if value:
value = 'true'
else:
value = 'false'
return value
def build_parameter_query(self, value, built_params, label=''):
value = self.validate(value)
value = self._getstring(value)
self.store_value_query(value, built_params, label)
@property
def false_name(self):
false_name = ''
if self.required:
false_name = '--no-' + self.cli_name[2:]
return false_name
def to_xml(self, value, label=None):
if not label:
label = self.name
value = self._getstring(value)
return '<%s>%s</%s>' % (label, value, label)
class TimestampParameter(Parameter):
Epoch = datetime.datetime(1970, 1, 1)
def totalseconds(self, td):
value = td.microseconds + (td.seconds + td.days * 24 * 3600)
return value * 10**6 / 10**6
def validate(self, value):
try:
return dateutil.parser.parse(value)
except:
pass
try:
# Might be specified as an epoch time
return datetime.datetime.utcfromtimestamp(value)
except:
pass
raise ValidationError(value=str(value), type_name='timestamp',
param=self)
def get_time_value(self, value):
if self.operation.service.timestamp_format == 'unixTimestamp':
delta = value - self.Epoch
value = int(self.totalseconds(delta))
else:
value = value.isoformat()
return value
def build_parameter_query(self, value, built_params, label=''):
value = self.validate(value)
self.store_value_query(self.get_time_value(value),
built_params, label)
def build_parameter_json(self, value, built_params, label=''):
value = self.validate(value)
self.store_value_json(self.get_time_value(value), built_params, value)
class StringParameter(Parameter):
def validate(self, value):
if not isinstance(value, six.string_types):
raise ValidationError(value=str(value), type_name='string',
param=self)
if self.min:
if len(value) < self.min:
raise RangeError(value=len(value),
param=self,
min_value=self.min,
max_value=self.max)
if self.max:
if len(value) > self.max:
raise RangeError(value=len(value),
param=self,
min_value=self.min,
max_value=self.max)
return value
class BlobParameter(Parameter):
def validate(self, value):
allowed_types = six.string_types + (bytes, bytearray,)
if self.payload and self.streaming:
# Streaming blobs should be file-like objects or be strings.
if not hasattr(value, 'read') and not isinstance(value, allowed_types):
raise ValidationError(value=str(value), type_name='blob',
param=self)
else:
if not isinstance(value, allowed_types):
raise ValidationError(value=str(value), type_name='string',
param=self)
if not hasattr(self, 'payload') or self.payload is False:
# Blobs that are not in the payload should be base64-encoded
value = base64.b64encode(six.b(value)).decode('utf-8')
return value
class ListParameter(Parameter):
def validate(self, value):
if not isinstance(value, (list, tuple)):
raise ValidationError(value=value, type_name='list', param=self)
for item in value:
try:
self.members.validate(item)
except ValidationError as e:
# ValidationError must provide a value
# argument so we can safely access that key.
raise ValidationError(value=e.kwargs['value'],
param='element of %s' % self,
type_name='list')
return value
def _handle_subtypes(self):
if self.members:
self.members = get_parameter(self.operation, None, self.members)
def build_parameter_query(self, value, built_params, label=''):
logger.debug("Building parameter for query service, name: %r, "
"label: %r", self.get_label(), label)
value = self.validate(value)
# If this is not a flattened list, find the label for member
# items in the list.
member_type = self.members
if self.flattened:
if member_type.xmlname:
if label:
label = label.format(label=member_type.xmlname)
else:
label = member_type.xmlname
else:
if label:
label = label.format(label=self.get_label())
else:
label = self.get_label()
else:
if label:
label = label.format(label=self.get_label())
else:
label = self.get_label()
label = '%s.%s' % (label, 'member')
if len(value) == 0 and self.required:
# If the parameter is required and an empty list is
# provided as a value, we should insert a parameter
# into the dictionary with the base name of the
# parameter and a value of the empty string. See
# ELB SetLoadBalancerPoliciesForBackendServer for example.
built_params[label.split('.')[0]] = ''
else:
for i, v in enumerate(value, 1):
member_type.build_parameter_query(v, built_params,
'%s.%d' % (label, i))
def build_parameter_json(self, value, built_params, label=''):
value = self.validate(value)
label = self.get_label()
built_params[label] = []
for v in value:
self.members.build_parameter_json(v, built_params[label], None)
def to_xml(self, value, label=None):
inner_xml = ''
for item in value:
xmlname = self.xmlname
if not xmlname:
xmlname = self.members.xmlname
inner_xml += self.members.to_xml(item, xmlname)
if self.flattened:
return inner_xml
else:
if not label:
label = self.xmlname
return '<%s>' % label + inner_xml + '</%s>' % label
class MapParameter(Parameter):
def validate(self, value):
if not isinstance(value, dict):
raise ValidationError(value=str(value),
type_name='map', param=self)
def _handle_subtypes(self):
if self.members:
self.members = get_parameter(self.operation, None, self.members)
if self.keys:
self.keys = get_parameter(self.operation, None, self.keys)
def build_parameter_query(self, value, built_params, label=''):
label = self.get_label()
if not self.flattened:
label = '%s.entry' % label
key_type = self.keys
member_type = self.members
for i, v in enumerate(value, 1):
key_name = key_type.xmlname
if not key_name:
key_name = 'key'
built_params['%s.%d.%s' % (label, i, key_name)] = v
member_name = member_type.xmlname
if not member_name:
member_name = 'value'
member_type.build_parameter_query(
value[v], built_params,
'%s.%d.%s' % (label, i, member_name))
def build_parameter_json(self, value, built_params, label=''):
label = self.get_label()
new_value = {}
if isinstance(built_params, list):
built_params.append(new_value)
else:
built_params[label] = new_value
for key in value:
new_value[key] = value[key]
class StructParameter(Parameter):
def validate(self, value):
if not isinstance(value, dict):
raise ValidationError(value=str(value), type_name='structure',
param=self)
self._validate_known_keys(value)
self._validate_required_keys(value)
for member in self.members:
sub_value = value.get(member.name)
if sub_value is not None:
member.validate(sub_value)
def _validate_known_keys(self, value):
valid_keys = [p.name for p in self.members]
for key in value:
if key not in valid_keys:
raise UnknownKeyError(
value=key, choices=', '.join(valid_keys), param=self.name)
def _validate_required_keys(self, value):
# There are some inner params that are marked as required
# even though the parent param is not marked required.
# It would be a good enhancement to also validate those
# params.
missing = []
for required in [p.name for p in self.members if p.required]:
if required not in value:
missing.append(required)
if missing:
raise MissingParametersError(object_name=self,
missing=', '.join(missing))
def _handle_subtypes(self):
if self.members:
l = []
for name, data in self.members.items():
l.append(get_parameter(self.operation, name, data))
self.members = l
def build_parameter_query(self, value, built_params, label=''):
if label:
label = label.format(label=self.get_label())
else:
label = self.get_label()
label = '%s.{label}' % label
for member in self.members:
if member.required and member.name not in value:
msg = 'Expected: %s, Got: %s' % (member.name, value.keys())
raise ValueError(msg)
if member.name in value:
member.build_parameter_query(value[member.name],
built_params,
label)
def build_parameter_json(self, value, built_params, label=''):
label = self.get_label()
new_value = {}
if isinstance(built_params, list):
built_params.append(new_value)
else:
built_params[label] = new_value
for member in self.members:
if member.required and member.name not in value:
msg = 'Expected: %s, Got: %s' % (member.name, value.keys())
raise ValueError(msg)
if member.name in value:
member_label = member.get_label()
member.build_parameter_json(value[member.name],
new_value,
member_label)
def store_value_json(self, value, built_params, label):
label = self.get_label()
built_params[label] = {}
for member in self.members:
if member.name in value:
member.store_value_json(value[member.name],
built_params[label],
member.name)
def to_xml(self, value, label=None):
if not label:
label = self.get_label()
xml = '<%s' % label
if hasattr(self, 'xmlnamespace'):
xml += ' xmlns:%s="%s" ' % (self.xmlnamespace['prefix'],
self.xmlnamespace['uri'])
# Now we need to look for members that have an
# xmlattribute attribute with a value of True.
# The value of these attributes belongs in the xmlattribute
# not in the body of the element.
for member in self.members:
if hasattr(member, 'xmlattribute'):
xml += '%s="%s"' % (member.xmlname, value[member.name])
xml += '>'
for member in self.members:
if member.name in value and not hasattr(member, 'xmlattribute'):
xml += member.to_xml(value[member.name], member.name)
xml += '</%s>' % label
return xml
type_map = {
'structure': StructParameter,
'map': MapParameter,
'timestamp': TimestampParameter,
'list': ListParameter,
'string': StringParameter,
'blob': BlobParameter,
'float': FloatParameter,
'double': DoubleParameter,
'integer': IntegerParameter,
'long': IntegerParameter,
'boolean': BooleanParameter,
'double': FloatParameter,
'member': Parameter,
'file': StringParameter}
def get_parameter(operation, name, type_data):
"""
Returns a Parameter object based on the parameter data passed in.
"""
if name and 'name' not in type_data:
type_data['name'] = name
param_cls = type_map[type_data['type']]
obj = param_cls(operation, **type_data)
return obj
|