code
stringlengths 26
870k
| docstring
stringlengths 1
65.6k
| func_name
stringlengths 1
194
| language
stringclasses 1
value | repo
stringlengths 8
68
| path
stringlengths 5
194
| url
stringlengths 46
254
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
def list_network_rules(cmd, client, resource_group_name, vault_name): # pylint: disable=unused-argument
""" List the network rules from the network ACLs for a Key Vault. """
vault = client.get(resource_group_name=resource_group_name, vault_name=vault_name)
return vault.properties.network_acls | List the network rules from the network ACLs for a Key Vault. | list_network_rules | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def delete_policy(cmd, client, resource_group_name, vault_name,
object_id=None, application_id=None, spn=None, upn=None, no_wait=False):
""" Delete security policy settings for a Key Vault. """
VaultCreateOrUpdateParameters = cmd.get_models('VaultCreateOrUpdateParameters',
resource_type=ResourceType.MGMT_KEYVAULT)
object_id = _object_id_args_helper(cmd.cli_ctx, object_id, spn, upn)
vault = client.get(resource_group_name=resource_group_name,
vault_name=vault_name)
try:
enable_rbac_authorization = getattr(vault.properties, 'enable_rbac_authorization')
except: # pylint: disable=bare-except
pass
else:
if enable_rbac_authorization:
raise CLIError('Cannot delete policies to a vault with \'--enable-rbac-authorization\' specified')
prev_policies_len = len(vault.properties.access_policies)
vault.properties.access_policies = [p for p in vault.properties.access_policies if
vault.properties.tenant_id.lower() != p.tenant_id.lower() or
object_id.lower() != p.object_id.lower() or
(application_id or '').lower() != (p.application_id or '').lower()]
if len(vault.properties.access_policies) == prev_policies_len:
raise CLIError('No matching policies found')
return _azure_stack_wrapper(cmd, client, 'create_or_update',
resource_type=ResourceType.MGMT_KEYVAULT,
min_api_version='2018-02-14',
resource_group_name=resource_group_name,
vault_name=vault_name,
parameters=VaultCreateOrUpdateParameters(
location=vault.location,
tags=vault.tags,
properties=vault.properties),
no_wait=no_wait) | Delete security policy settings for a Key Vault. | delete_policy | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def import_key(cmd, client, name=None, # pylint: disable=too-many-locals
protection=None, key_ops=None, disabled=False, expires=None,
not_before=None, tags=None, pem_file=None, pem_string=None, pem_password=None, byok_file=None,
byok_string=None, kty='RSA', curve=None, exportable=None, release_policy=None):
""" Import a private key. Supports importing base64 encoded private keys from PEM files or strings.
Supports importing BYOK keys into HSM for premium key vaults. """
JsonWebKey = cmd.loader.get_sdk('JsonWebKey', resource_type=ResourceType.DATA_KEYVAULT_KEYS, mod='_models')
key_obj = JsonWebKey(key_ops=key_ops)
if pem_file or pem_string:
if pem_file:
logger.info('Reading %s', pem_file)
with open(pem_file, 'rb') as f:
pem_data = f.read()
elif pem_string:
pem_data = pem_string.encode('UTF-8')
pem_password = str(pem_password).encode() if pem_password else None
try:
pkey = load_pem_private_key(pem_data, pem_password, default_backend())
except (ValueError, TypeError, UnsupportedAlgorithm) as e:
if str(e) == 'Could not deserialize key data.':
raise CLIError('Import failed: {} The private key in the PEM file must be encrypted.'.format(e))
raise CLIError('Import failed: {}'.format(e))
# populate key into jwk
if isinstance(pkey, rsa.RSAPrivateKey):
key_obj.kty = 'RSA'
_private_rsa_key_to_jwk(pkey, key_obj)
elif isinstance(pkey, ec.EllipticCurvePrivateKey):
key_obj.kty = 'EC'
_private_ec_key_to_jwk(pkey, key_obj)
else:
raise CLIError('Import failed: Unsupported key type, {}.'.format(type(pkey)))
elif byok_file or byok_string:
if byok_file:
logger.info('Reading %s', byok_file)
with open(byok_file, 'rb') as f:
byok_data = f.read()
elif byok_string:
byok_data = byok_string.encode('UTF-8')
key_obj.kty = kty + '-HSM'
key_obj.t = byok_data
key_obj.crv = curve
return client.import_key(name=name, key=key_obj,
hardware_protected=(protection == 'hsm'),
enabled=not disabled, tags=tags,
not_before=not_before, expires_on=expires,
exportable=exportable, release_policy=release_policy) | Import a private key. Supports importing base64 encoded private keys from PEM files or strings.
Supports importing BYOK keys into HSM for premium key vaults. | import_key | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def _bytes_to_int(b):
"""Convert bytes to hex integer"""
len_diff = 4 - len(b) % 4 if len(b) % 4 > 0 else 0
b = len_diff * b'\x00' + b # We have to patch leading zeros for using struct.unpack
bytes_num = int(math.floor(len(b) / 4))
ans = 0
items = struct.unpack('>' + 'I' * bytes_num, b)
for sub_int in items: # Accumulate all items into a big integer
ans *= 2 ** 32
ans += sub_int
return ans | Convert bytes to hex integer | _bytes_to_int | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def _jwk_to_dict(jwk):
"""Convert a `JsonWebKey` struct to a python dict"""
d = {}
if jwk.crv:
d['crv'] = jwk.crv
if jwk.kid:
d['kid'] = jwk.kid
if jwk.kty:
d['kty'] = jwk.kty
if jwk.d:
d['d'] = _bytes_to_int(jwk.d)
if jwk.dp:
d['dp'] = _bytes_to_int(jwk.dp)
if jwk.dq:
d['dq'] = _bytes_to_int(jwk.dq)
if jwk.e:
d['e'] = _bytes_to_int(jwk.e)
if jwk.k:
d['k'] = _bytes_to_int(jwk.k)
if jwk.n:
d['n'] = _bytes_to_int(jwk.n)
if jwk.p:
d['p'] = _bytes_to_int(jwk.p)
if jwk.q:
d['q'] = _bytes_to_int(jwk.q)
if jwk.qi:
d['qi'] = _bytes_to_int(jwk.qi)
if jwk.t:
d['t'] = _bytes_to_int(jwk.t)
if jwk.x:
d['x'] = _bytes_to_int(jwk.x)
if jwk.y:
d['y'] = _bytes_to_int(jwk.y)
return d | Convert a `JsonWebKey` struct to a python dict | _jwk_to_dict | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def download_key(client, file_path, name, version='', encoding=None):
""" Download a key from a KeyVault. """
if os.path.isfile(file_path) or os.path.isdir(file_path):
raise CLIError("File or directory named '{}' already exists.".format(file_path))
key = client.get_key(name=name, version=version)
json_web_key = _jwk_to_dict(key.key)
key_type = json_web_key['kty']
pub_key = ''
if key_type in ['RSA', 'RSA-HSM']:
pub_key = _extract_rsa_public_key_from_jwk(json_web_key)
elif key_type in ['EC', 'EC-HSM']:
pub_key = _extract_ec_public_key_from_jwk(json_web_key)
else:
raise CLIError('Unsupported key type: {}. (Supported key types: RSA, RSA-HSM, EC, EC-HSM)'.format(key_type))
methods = {
'DER': _export_public_key_to_der,
'PEM': _export_public_key_to_pem
}
if encoding not in methods:
raise CLIError('Unsupported encoding: {}. (Supported encodings: DER, PEM)'.format(encoding))
try:
with open(file_path, 'wb') as f:
f.write(methods[encoding](pub_key))
except Exception as ex: # pylint: disable=broad-except
if os.path.isfile(file_path):
os.remove(file_path)
raise ex | Download a key from a KeyVault. | download_key | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def download_secret(client, file_path, name=None, encoding=None, version=''): # pylint: disable=unused-argument
""" Download a secret from a KeyVault. """
if os.path.isfile(file_path) or os.path.isdir(file_path):
raise CLIError("File or directory named '{}' already exists.".format(file_path))
secret = client.get_secret(name, version)
if not encoding:
encoding = secret.properties.tags.get('file-encoding', 'utf-8') if secret.properties.tags else 'utf-8'
secret_value = secret.value
try:
if encoding in secret_text_encoding_values:
with open(file_path, 'w') as f:
f.write(secret_value)
else:
if encoding == 'base64':
decoded = base64.b64decode(secret_value)
elif encoding == 'hex':
import binascii
decoded = binascii.unhexlify(secret_value)
with open(file_path, 'wb') as f:
f.write(decoded)
except Exception as ex: # pylint: disable=broad-except
if os.path.isfile(file_path):
os.remove(file_path)
raise ex | Download a secret from a KeyVault. | download_secret | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def download_certificate(client, file_path, certificate_name=None, encoding='PEM', version=''):
""" Download a certificate from a KeyVault. """
if os.path.isfile(file_path) or os.path.isdir(file_path):
raise CLIError("File or directory named '{}' already exists.".format(file_path))
cert = client.get_certificate_version(certificate_name, version).cer
try:
with open(file_path, 'wb') as f:
if encoding == 'DER':
f.write(cert)
else:
encoded = base64.encodebytes(cert)
if isinstance(encoded, bytes):
encoded = encoded.decode("utf-8")
encoded = '-----BEGIN CERTIFICATE-----\n' + encoded + '-----END CERTIFICATE-----\n'
f.write(encoded.encode("utf-8"))
except Exception as ex: # pylint: disable=broad-except
if os.path.isfile(file_path):
os.remove(file_path)
raise ex | Download a certificate from a KeyVault. | download_certificate | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def add_certificate_contact(cmd, client, email, name=None, phone=None):
""" Add a contact to the specified vault to receive notifications of certificate operations. """
CertificateContact = cmd.loader.get_sdk('CertificateContact', resource_type=ResourceType.DATA_KEYVAULT_CERTIFICATES,
mod='_models')
from azure.core.exceptions import ResourceNotFoundError
try:
contacts = client.get_contacts()
except ResourceNotFoundError:
contacts = []
contact = CertificateContact(email=email, name=name, phone=phone)
if any(x for x in contacts if x.email == email):
raise CLIError("contact '{}' already exists".format(email))
contacts.append(contact)
return client.set_contacts(contacts) | Add a contact to the specified vault to receive notifications of certificate operations. | add_certificate_contact | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def delete_certificate_contact(client, email):
""" Remove a certificate contact from the specified vault. """
orig_contacts = client.get_contacts()
remaining_contacts = [x for x in orig_contacts if x.email != email]
if len(remaining_contacts) == len(orig_contacts):
raise CLIError("contact '{}' not found in vault".format(email))
if remaining_contacts is not None and len(remaining_contacts) > 0:
return client.set_contacts(remaining_contacts)
client.delete_contacts()
return [] | Remove a certificate contact from the specified vault. | delete_certificate_contact | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def create_certificate_issuer(client, issuer_name, provider_name, account_id=None,
password=None, disabled=None, organization_id=None):
""" Create a certificate issuer record.
:param issuer_name: The name of the issuer.
:param provider_name: The certificate provider name. Must be registered with your
tenant ID and in your region.
:param account_id: The issuer account id/username/etc.
:param password: The issuer account password/secret/etc.
:param organization_id: The organization id.
"""
return client.create_issuer(issuer_name, provider_name, enabled=not disabled, account_id=account_id,
password=password, organization_id=organization_id) | Create a certificate issuer record.
:param issuer_name: The name of the issuer.
:param provider_name: The certificate provider name. Must be registered with your
tenant ID and in your region.
:param account_id: The issuer account id/username/etc.
:param password: The issuer account password/secret/etc.
:param organization_id: The organization id. | create_certificate_issuer | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def update_certificate_issuer(client, issuer_name, provider_name=None,
account_id=None, password=None, enabled=None, organization_id=None):
""" Update a certificate issuer record.
:param issuer_name: Unique identifier for the issuer settings.
:param provider_name: The certificate provider name. Must be registered with your
tenant ID and in your region.
:param account_id: The issuer account id/username/etc.
:param password: The issuer account password/secret/etc.
:param organization_id: The organization id.
"""
return client.update_issuer(issuer_name, provider=provider_name, enabled=enabled, account_id=account_id,
password=password, organization_id=organization_id) | Update a certificate issuer record.
:param issuer_name: Unique identifier for the issuer settings.
:param provider_name: The certificate provider name. Must be registered with your
tenant ID and in your region.
:param account_id: The issuer account id/username/etc.
:param password: The issuer account password/secret/etc.
:param organization_id: The organization id. | update_certificate_issuer | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def add_certificate_issuer_admin(cmd, client, issuer_name, email, first_name=None,
last_name=None, phone=None):
""" Add admin details for a specified certificate issuer. """
AdministratorContact = cmd.loader.get_sdk('AdministratorContact',
resource_type=ResourceType.DATA_KEYVAULT_CERTIFICATES,
mod='_models')
issuer = client.get_issuer(issuer_name)
admins = issuer.admin_contacts
if any(x for x in admins if x.email == email):
raise CLIError("admin '{}' already exists".format(email))
new_admin = AdministratorContact(first_name=first_name, last_name=last_name, email=email, phone=phone)
admins.append(new_admin)
client.update_issuer(issuer_name, admin_contacts=admins)
return {
"emailAddress": email,
"firstName": first_name,
"lastName": last_name,
"phone": phone
} | Add admin details for a specified certificate issuer. | add_certificate_issuer_admin | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def delete_certificate_issuer_admin(client, issuer_name, email):
""" Remove admin details for the specified certificate issuer. """
issuer = client.get_issuer(issuer_name)
admins = issuer.admin_contacts
remaining = [x for x in admins if x.email != email]
if len(remaining) == len(admins):
raise CLIError("admin '{}' not found for issuer '{}'".format(email, issuer_name))
if remaining:
client.update_issuer(issuer_name, admin_contacts=remaining)
else:
organization_id = issuer.organization_id
client.update_issuer(issuer_name, organization_id=organization_id) | Remove admin details for the specified certificate issuer. | delete_certificate_issuer_admin | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def approve_private_endpoint_connection(cmd, client, resource_group_name, private_endpoint_connection_name,
vault_name=None, hsm_name=None, description=None, no_wait=False):
"""Approve a private endpoint connection request for a Key Vault."""
pec_client = _get_vault_or_hsm_pec_client(cmd, client, vault_name, hsm_name)
return _update_private_endpoint_connection_status(cmd, pec_client, resource_group_name,
vault_name or hsm_name, private_endpoint_connection_name,
is_approved=True, description=description, no_wait=no_wait) | Approve a private endpoint connection request for a Key Vault. | approve_private_endpoint_connection | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def reject_private_endpoint_connection(cmd, client, resource_group_name, private_endpoint_connection_name,
vault_name=None, hsm_name=None, description=None, no_wait=False):
"""Reject a private endpoint connection request for a Key Vault."""
pec_client = _get_vault_or_hsm_pec_client(cmd, client, vault_name, hsm_name)
return _update_private_endpoint_connection_status(cmd, pec_client, resource_group_name,
vault_name or hsm_name, private_endpoint_connection_name,
is_approved=False, description=description, no_wait=no_wait) | Reject a private endpoint connection request for a Key Vault. | reject_private_endpoint_connection | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def create_role_assignment(cmd, client, role, scope, assignee_object_id=None,
role_assignment_name=None, assignee=None,
assignee_principal_type=None, hsm_name=None, identifier=None):
""" Create a new role assignment for a user, group, or service principal. """
from azure.cli.command_modules.role.custom import _resolve_object_id
if not assignee_object_id and not assignee:
raise CLIError('Please specify --assignee or --assignee-object-id.')
if assignee_object_id is None:
if _is_guid(assignee):
assignee_object_id = assignee
else:
assignee_object_id = _resolve_object_id(cmd.cli_ctx, assignee)
role_definition_id = _resolve_role_id(client, role=role, scope=scope)
if not role_definition_id:
raise CLIError('Unknown role "{}". Please use "az keyvault role definition list" '
'to check whether the role is existing.'.format(role))
if role_assignment_name is None:
role_assignment_name = str(_gen_guid())
if scope is None:
scope = ''
role_assignment = client.create_role_assignment(
scope=scope,
definition_id=role_definition_id,
principal_id=assignee_object_id,
name=role_assignment_name,
)
role_defs = list_role_definitions(client)
role_dics = _get_role_dics(role_defs)
principal_dics = _get_principal_dics(cmd.cli_ctx, [role_assignment])
return _reconstruct_role_assignment(
role_dics=role_dics,
principal_dics=principal_dics,
role_assignment=role_assignment
) | Create a new role assignment for a user, group, or service principal. | create_role_assignment | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def delete_role_assignment(cmd, client, role_assignment_name=None, scope=None, assignee=None, role=None,
assignee_object_id=None, ids=None, hsm_name=None, identifier=None):
""" Delete a role assignment. """
query_scope = scope
if query_scope is None:
query_scope = ''
if ids is not None:
for cnt_id in ids:
cnt_name = cnt_id.split('/')[-1]
client.delete_role_assignment(scope=query_scope, name=cnt_name)
else:
if role_assignment_name is not None:
client.delete_role_assignment(scope=query_scope, name=role_assignment_name)
else:
matched_role_assignments = list_role_assignments(
cmd, client, scope=scope, role=role, assignee_object_id=assignee_object_id, assignee=assignee
)
for role_assignment in matched_role_assignments:
client.delete_role_assignment(scope=query_scope, name=role_assignment.get('name')) | Delete a role assignment. | delete_role_assignment | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def list_role_assignments(cmd, client, scope=None, assignee=None, role=None, assignee_object_id=None,
hsm_name=None, identifier=None): # pylint: disable=unused-argument
""" List role assignments. """
from azure.cli.command_modules.role.custom import _resolve_object_id
if assignee_object_id is None and assignee is not None:
assignee_object_id = _resolve_object_id(cmd.cli_ctx, assignee)
query_scope = scope
if query_scope is None:
query_scope = ''
role_definition_id = None
if role is not None:
role_definition_id = _resolve_role_id(client, role=role, scope=query_scope)
all_role_assignments = client.list_role_assignments(scope=query_scope)
matched_role_assignments = []
for role_assignment in all_role_assignments:
if role_definition_id is not None:
if role_assignment.properties.role_definition_id != role_definition_id:
continue
if scope is not None:
cnt_scope = role_assignment.properties.scope
if cnt_scope not in [scope, '/' + scope]:
continue
if assignee_object_id is not None:
if role_assignment.properties.principal_id != assignee_object_id:
continue
matched_role_assignments.append(role_assignment)
role_defs = list_role_definitions(client)
role_dics = _get_role_dics(role_defs)
principal_dics = _get_principal_dics(cmd.cli_ctx, matched_role_assignments)
ret = []
for i in matched_role_assignments:
ret.append(_reconstruct_role_assignment(
role_dics=role_dics,
principal_dics=principal_dics,
role_assignment=i
))
return ret | List role assignments. | list_role_assignments | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def list_role_definitions(client, scope=None, hsm_name=None, custom_role_only=False): # pylint: disable=unused-argument
""" List role definitions. """
query_scope = scope
if query_scope is None:
query_scope = ''
role_definitions = client.list_role_definitions(scope=query_scope)
if custom_role_only:
role_definitions = [role for role in role_definitions if role.role_type == 'CustomRole']
return role_definitions | List role definitions. | list_role_definitions | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/custom.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/custom.py | MIT |
def _encode_hex(item):
""" Recursively crawls the object structure and converts bytes or bytearrays to base64
encoded strings. """
if isinstance(item, list):
return [_encode_hex(x) for x in item]
if hasattr(item, '__dict__'):
for key, val in item.__dict__.items():
if not key.startswith('_'):
try:
setattr(item, key, _encode_hex(val))
except TypeError:
item.__dict__[key] = _encode_hex(val)
return item
if isinstance(item, (bytes, bytearray)):
return base64.b64encode(item).decode('utf-8')
return item | Recursively crawls the object structure and converts bytes or bytearrays to base64
encoded strings. | _encode_hex | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/_command_type.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/_command_type.py | MIT |
def keyvault_command(self, name, method_name=None, command_type=None, **kwargs):
""" Registers an Azure CLI KeyVault Data Plane command. These commands must respond to a
challenge from the service when they make requests. """
command_type_name = 'command_type'
if command_type:
kwargs[command_type_name] = command_type
self._create_keyvault_command(name, method_name, command_type_name, **kwargs) | Registers an Azure CLI KeyVault Data Plane command. These commands must respond to a
challenge from the service when they make requests. | keyvault_command | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/_command_type.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/_command_type.py | MIT |
def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any:
"""Decode data according to content-type.
Accept a stream of data as well, but will be load at once in memory for now.
If no content-type, will return the string version (not bytes, not stream)
:param data: Input, could be bytes or stream (will be decoded with UTF8) or text
:type data: str or bytes or IO
:param str content_type: The content type.
:return: The deserialized data.
:rtype: object
"""
if hasattr(data, "read"):
# Assume a stream
data = cast(IO, data).read()
if isinstance(data, bytes):
data_as_str = data.decode(encoding="utf-8-sig")
else:
# Explain to mypy the correct type.
data_as_str = cast(str, data)
# Remove Byte Order Mark if present in string
data_as_str = data_as_str.lstrip(_BOM)
if content_type is None:
return data
if cls.JSON_REGEXP.match(content_type):
try:
return json.loads(data_as_str)
except ValueError as err:
raise DeserializationError("JSON is invalid: {}".format(err), err) from err
elif "xml" in (content_type or []):
try:
try:
if isinstance(data, unicode): # type: ignore
# If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string
data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore
except NameError:
pass
return ET.fromstring(data_as_str) # nosec
except ET.ParseError as err:
# It might be because the server has an issue, and returned JSON with
# content-type XML....
# So let's try a JSON load, and if it's still broken
# let's flow the initial exception
def _json_attemp(data):
try:
return True, json.loads(data)
except ValueError:
return False, None # Don't care about this one
success, json_result = _json_attemp(data)
if success:
return json_result
# If i'm here, it's not JSON, it's not XML, let's scream
# and raise the last context in this block (the XML exception)
# The function hack is because Py2.7 messes up with exception
# context otherwise.
_LOGGER.critical("Wasn't XML not JSON, failing")
raise DeserializationError("XML is invalid") from err
elif content_type.startswith("text/"):
return data_as_str
raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) | Decode data according to content-type.
Accept a stream of data as well, but will be load at once in memory for now.
If no content-type, will return the string version (not bytes, not stream)
:param data: Input, could be bytes or stream (will be decoded with UTF8) or text
:type data: str or bytes or IO
:param str content_type: The content type.
:return: The deserialized data.
:rtype: object | deserialize_from_text | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any:
"""Deserialize from HTTP response.
Use bytes and headers to NOT use any requests/aiohttp or whatever
specific implementation.
Headers will tested for "content-type"
:param bytes body_bytes: The body of the response.
:param dict headers: The headers of the response.
:returns: The deserialized data.
:rtype: object
"""
# Try to use content-type from headers if available
content_type = None
if "content-type" in headers:
content_type = headers["content-type"].split(";")[0].strip().lower()
# Ouch, this server did not declare what it sent...
# Let's guess it's JSON...
# Also, since Autorest was considering that an empty body was a valid JSON,
# need that test as well....
else:
content_type = "application/json"
if body_bytes:
return cls.deserialize_from_text(body_bytes, content_type)
return None | Deserialize from HTTP response.
Use bytes and headers to NOT use any requests/aiohttp or whatever
specific implementation.
Headers will tested for "content-type"
:param bytes body_bytes: The body of the response.
:param dict headers: The headers of the response.
:returns: The deserialized data.
:rtype: object | deserialize_from_http_generics | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def utcoffset(self, dt):
"""UTF offset for UTC is 0.
:param datetime.datetime dt: The datetime
:returns: The offset
:rtype: datetime.timedelta
"""
return datetime.timedelta(0) | UTF offset for UTC is 0.
:param datetime.datetime dt: The datetime
:returns: The offset
:rtype: datetime.timedelta | utcoffset | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def tzname(self, dt):
"""Timestamp representation.
:param datetime.datetime dt: The datetime
:returns: The timestamp representation
:rtype: str
"""
return "Z" | Timestamp representation.
:param datetime.datetime dt: The datetime
:returns: The timestamp representation
:rtype: str | tzname | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def dst(self, dt):
"""No daylight saving for UTC.
:param datetime.datetime dt: The datetime
:returns: The daylight saving time
:rtype: datetime.timedelta
"""
return datetime.timedelta(hours=1) | No daylight saving for UTC.
:param datetime.datetime dt: The datetime
:returns: The daylight saving time
:rtype: datetime.timedelta | dst | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def attribute_transformer(key, attr_desc, value): # pylint: disable=unused-argument
"""A key transformer that returns the Python attribute.
:param str key: The attribute name
:param dict attr_desc: The attribute metadata
:param object value: The value
:returns: A key using attribute name
:rtype: str
"""
return (key, value) | A key transformer that returns the Python attribute.
:param str key: The attribute name
:param dict attr_desc: The attribute metadata
:param object value: The value
:returns: A key using attribute name
:rtype: str | attribute_transformer | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def full_restapi_key_transformer(key, attr_desc, value): # pylint: disable=unused-argument
"""A key transformer that returns the full RestAPI key path.
:param str key: The attribute name
:param dict attr_desc: The attribute metadata
:param object value: The value
:returns: A list of keys using RestAPI syntax.
:rtype: list
"""
keys = _FLATTEN.split(attr_desc["key"])
return ([_decode_attribute_map_key(k) for k in keys], value) | A key transformer that returns the full RestAPI key path.
:param str key: The attribute name
:param dict attr_desc: The attribute metadata
:param object value: The value
:returns: A list of keys using RestAPI syntax.
:rtype: list | full_restapi_key_transformer | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def last_restapi_key_transformer(key, attr_desc, value):
"""A key transformer that returns the last RestAPI key.
:param str key: The attribute name
:param dict attr_desc: The attribute metadata
:param object value: The value
:returns: The last RestAPI key.
:rtype: str
"""
key, value = full_restapi_key_transformer(key, attr_desc, value)
return (key[-1], value) | A key transformer that returns the last RestAPI key.
:param str key: The attribute name
:param dict attr_desc: The attribute metadata
:param object value: The value
:returns: The last RestAPI key.
:rtype: str | last_restapi_key_transformer | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _create_xml_node(tag, prefix=None, ns=None):
"""Create a XML node.
:param str tag: The tag name
:param str prefix: The prefix
:param str ns: The namespace
:return: The XML node
:rtype: xml.etree.ElementTree.Element
"""
if prefix and ns:
ET.register_namespace(prefix, ns)
if ns:
return ET.Element("{" + ns + "}" + tag)
return ET.Element(tag) | Create a XML node.
:param str tag: The tag name
:param str prefix: The prefix
:param str ns: The namespace
:return: The XML node
:rtype: xml.etree.ElementTree.Element | _create_xml_node | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def __eq__(self, other: Any) -> bool:
"""Compare objects by comparing all attributes.
:param object other: The object to compare
:returns: True if objects are equal
:rtype: bool
"""
if isinstance(other, self.__class__):
return self.__dict__ == other.__dict__
return False | Compare objects by comparing all attributes.
:param object other: The object to compare
:returns: True if objects are equal
:rtype: bool | __eq__ | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def __ne__(self, other: Any) -> bool:
"""Compare objects by comparing all attributes.
:param object other: The object to compare
:returns: True if objects are not equal
:rtype: bool
"""
return not self.__eq__(other) | Compare objects by comparing all attributes.
:param object other: The object to compare
:returns: True if objects are not equal
:rtype: bool | __ne__ | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _create_xml_node(cls):
"""Create XML node.
:returns: The XML node
:rtype: xml.etree.ElementTree.Element
"""
try:
xml_map = cls._xml_map # type: ignore
except AttributeError:
xml_map = {}
return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) | Create XML node.
:returns: The XML node
:rtype: xml.etree.ElementTree.Element | _create_xml_node | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON:
"""Return the JSON that would be sent to server from this model.
This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`.
If you want XML serialization, you can pass the kwargs is_xml=True.
:param bool keep_readonly: If you want to serialize the readonly attributes
:returns: A dict JSON compatible object
:rtype: dict
"""
serializer = Serializer(self._infer_class_models())
return serializer._serialize( # type: ignore # pylint: disable=protected-access
self, keep_readonly=keep_readonly, **kwargs
) | Return the JSON that would be sent to server from this model.
This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`.
If you want XML serialization, you can pass the kwargs is_xml=True.
:param bool keep_readonly: If you want to serialize the readonly attributes
:returns: A dict JSON compatible object
:rtype: dict | serialize | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def as_dict(
self,
keep_readonly: bool = True,
key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer,
**kwargs: Any
) -> JSON:
"""Return a dict that can be serialized using json.dump.
Advanced usage might optionally use a callback as parameter:
.. code::python
def my_key_transformer(key, attr_desc, value):
return key
Key is the attribute name used in Python. Attr_desc
is a dict of metadata. Currently contains 'type' with the
msrest type and 'key' with the RestAPI encoded key.
Value is the current value in this object.
The string returned will be used to serialize the key.
If the return type is a list, this is considered hierarchical
result dict.
See the three examples in this file:
- attribute_transformer
- full_restapi_key_transformer
- last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
:param bool keep_readonly: If you want to serialize the readonly attributes
:param function key_transformer: A key transformer function.
:returns: A dict JSON compatible object
:rtype: dict
"""
serializer = Serializer(self._infer_class_models())
return serializer._serialize( # type: ignore # pylint: disable=protected-access
self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs
) | Return a dict that can be serialized using json.dump.
Advanced usage might optionally use a callback as parameter:
.. code::python
def my_key_transformer(key, attr_desc, value):
return key
Key is the attribute name used in Python. Attr_desc
is a dict of metadata. Currently contains 'type' with the
msrest type and 'key' with the RestAPI encoded key.
Value is the current value in this object.
The string returned will be used to serialize the key.
If the return type is a list, this is considered hierarchical
result dict.
See the three examples in this file:
- attribute_transformer
- full_restapi_key_transformer
- last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
:param bool keep_readonly: If you want to serialize the readonly attributes
:param function key_transformer: A key transformer function.
:returns: A dict JSON compatible object
:rtype: dict | as_dict | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType:
"""Parse a str using the RestAPI syntax and return a model.
:param str data: A str using RestAPI structure. JSON by default.
:param str content_type: JSON by default, set application/xml if XML.
:returns: An instance of this model
:raises: DeserializationError if something went wrong
:rtype: ModelType
"""
deserializer = Deserializer(cls._infer_class_models())
return deserializer(cls.__name__, data, content_type=content_type) # type: ignore | Parse a str using the RestAPI syntax and return a model.
:param str data: A str using RestAPI structure. JSON by default.
:param str content_type: JSON by default, set application/xml if XML.
:returns: An instance of this model
:raises: DeserializationError if something went wrong
:rtype: ModelType | deserialize | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def from_dict(
cls: Type[ModelType],
data: Any,
key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None,
content_type: Optional[str] = None,
) -> ModelType:
"""Parse a dict using given key extractor return a model.
By default consider key
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
and last_rest_key_case_insensitive_extractor)
:param dict data: A dict using RestAPI structure
:param function key_extractors: A key extractor function.
:param str content_type: JSON by default, set application/xml if XML.
:returns: An instance of this model
:raises: DeserializationError if something went wrong
:rtype: ModelType
"""
deserializer = Deserializer(cls._infer_class_models())
deserializer.key_extractors = ( # type: ignore
[ # type: ignore
attribute_key_case_insensitive_extractor,
rest_key_case_insensitive_extractor,
last_rest_key_case_insensitive_extractor,
]
if key_extractors is None
else key_extractors
)
return deserializer(cls.__name__, data, content_type=content_type) # type: ignore | Parse a dict using given key extractor return a model.
By default consider key
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
and last_rest_key_case_insensitive_extractor)
:param dict data: A dict using RestAPI structure
:param function key_extractors: A key extractor function.
:param str content_type: JSON by default, set application/xml if XML.
:returns: An instance of this model
:raises: DeserializationError if something went wrong
:rtype: ModelType | from_dict | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _classify(cls, response, objects):
"""Check the class _subtype_map for any child classes.
We want to ignore any inherited _subtype_maps.
Remove the polymorphic key from the initial data.
:param dict response: The initial data
:param dict objects: The class objects
:returns: The class to be used
:rtype: class
"""
for subtype_key in cls.__dict__.get("_subtype_map", {}).keys():
subtype_value = None
if not isinstance(response, ET.Element):
rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1]
subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None)
else:
subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response)
if subtype_value:
# Try to match base class. Can be class name only
# (bug to fix in Autorest to support x-ms-discriminator-name)
if cls.__name__ == subtype_value:
return cls
flatten_mapping_type = cls._flatten_subtype(subtype_key, objects)
try:
return objects[flatten_mapping_type[subtype_value]] # type: ignore
except KeyError:
_LOGGER.warning(
"Subtype value %s has no mapping, use base class %s.",
subtype_value,
cls.__name__,
)
break
else:
_LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__)
break
return cls | Check the class _subtype_map for any child classes.
We want to ignore any inherited _subtype_maps.
Remove the polymorphic key from the initial data.
:param dict response: The initial data
:param dict objects: The class objects
:returns: The class to be used
:rtype: class | _classify | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _get_rest_key_parts(cls, attr_key):
"""Get the RestAPI key of this attr, split it and decode part
:param str attr_key: Attribute key must be in attribute_map.
:returns: A list of RestAPI part
:rtype: list
"""
rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"])
return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] | Get the RestAPI key of this attr, split it and decode part
:param str attr_key: Attribute key must be in attribute_map.
:returns: A list of RestAPI part
:rtype: list | _get_rest_key_parts | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _decode_attribute_map_key(key):
"""This decode a key in an _attribute_map to the actual key we want to look at
inside the received data.
:param str key: A key string from the generated code
:returns: The decoded key
:rtype: str
"""
return key.replace("\\.", ".") | This decode a key in an _attribute_map to the actual key we want to look at
inside the received data.
:param str key: A key string from the generated code
:returns: The decoded key
:rtype: str | _decode_attribute_map_key | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals
self, target_obj, data_type=None, **kwargs
):
"""Serialize data into a string according to type.
:param object target_obj: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str, dict
:raises: SerializationError if serialization fails.
:returns: The serialized data.
"""
key_transformer = kwargs.get("key_transformer", self.key_transformer)
keep_readonly = kwargs.get("keep_readonly", False)
if target_obj is None:
return None
attr_name = None
class_name = target_obj.__class__.__name__
if data_type:
return self.serialize_data(target_obj, data_type, **kwargs)
if not hasattr(target_obj, "_attribute_map"):
data_type = type(target_obj).__name__
if data_type in self.basic_types.values():
return self.serialize_data(target_obj, data_type, **kwargs)
# Force "is_xml" kwargs if we detect a XML model
try:
is_xml_model_serialization = kwargs["is_xml"]
except KeyError:
is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model())
serialized = {}
if is_xml_model_serialization:
serialized = target_obj._create_xml_node() # pylint: disable=protected-access
try:
attributes = target_obj._attribute_map # pylint: disable=protected-access
for attr, attr_desc in attributes.items():
attr_name = attr
if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access
attr_name, {}
).get("readonly", False):
continue
if attr_name == "additional_properties" and attr_desc["key"] == "":
if target_obj.additional_properties is not None:
serialized.update(target_obj.additional_properties)
continue
try:
orig_attr = getattr(target_obj, attr)
if is_xml_model_serialization:
pass # Don't provide "transformer" for XML for now. Keep "orig_attr"
else: # JSON
keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr)
keys = keys if isinstance(keys, list) else [keys]
kwargs["serialization_ctxt"] = attr_desc
new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs)
if is_xml_model_serialization:
xml_desc = attr_desc.get("xml", {})
xml_name = xml_desc.get("name", attr_desc["key"])
xml_prefix = xml_desc.get("prefix", None)
xml_ns = xml_desc.get("ns", None)
if xml_desc.get("attr", False):
if xml_ns:
ET.register_namespace(xml_prefix, xml_ns)
xml_name = "{{{}}}{}".format(xml_ns, xml_name)
serialized.set(xml_name, new_attr) # type: ignore
continue
if xml_desc.get("text", False):
serialized.text = new_attr # type: ignore
continue
if isinstance(new_attr, list):
serialized.extend(new_attr) # type: ignore
elif isinstance(new_attr, ET.Element):
# If the down XML has no XML/Name,
# we MUST replace the tag with the local tag. But keeping the namespaces.
if "name" not in getattr(orig_attr, "_xml_map", {}):
splitted_tag = new_attr.tag.split("}")
if len(splitted_tag) == 2: # Namespace
new_attr.tag = "}".join([splitted_tag[0], xml_name])
else:
new_attr.tag = xml_name
serialized.append(new_attr) # type: ignore
else: # That's a basic type
# Integrate namespace if necessary
local_node = _create_xml_node(xml_name, xml_prefix, xml_ns)
local_node.text = str(new_attr)
serialized.append(local_node) # type: ignore
else: # JSON
for k in reversed(keys): # type: ignore
new_attr = {k: new_attr}
_new_attr = new_attr
_serialized = serialized
for k in keys: # type: ignore
if k not in _serialized:
_serialized.update(_new_attr) # type: ignore
_new_attr = _new_attr[k] # type: ignore
_serialized = _serialized[k]
except ValueError as err:
if isinstance(err, SerializationError):
raise
except (AttributeError, KeyError, TypeError) as err:
msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj))
raise SerializationError(msg) from err
return serialized | Serialize data into a string according to type.
:param object target_obj: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str, dict
:raises: SerializationError if serialization fails.
:returns: The serialized data. | _serialize | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def body(self, data, data_type, **kwargs):
"""Serialize data intended for a request body.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: dict
:raises: SerializationError if serialization fails.
:raises: ValueError if data is None
:returns: The serialized request body
"""
# Just in case this is a dict
internal_data_type_str = data_type.strip("[]{}")
internal_data_type = self.dependencies.get(internal_data_type_str, None)
try:
is_xml_model_serialization = kwargs["is_xml"]
except KeyError:
if internal_data_type and issubclass(internal_data_type, Model):
is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model())
else:
is_xml_model_serialization = False
if internal_data_type and not isinstance(internal_data_type, Enum):
try:
deserializer = Deserializer(self.dependencies)
# Since it's on serialization, it's almost sure that format is not JSON REST
# We're not able to deal with additional properties for now.
deserializer.additional_properties_detection = False
if is_xml_model_serialization:
deserializer.key_extractors = [ # type: ignore
attribute_key_case_insensitive_extractor,
]
else:
deserializer.key_extractors = [
rest_key_case_insensitive_extractor,
attribute_key_case_insensitive_extractor,
last_rest_key_case_insensitive_extractor,
]
data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access
except DeserializationError as err:
raise SerializationError("Unable to build a model: " + str(err)) from err
return self._serialize(data, data_type, **kwargs) | Serialize data intended for a request body.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: dict
:raises: SerializationError if serialization fails.
:raises: ValueError if data is None
:returns: The serialized request body | body | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def url(self, name, data, data_type, **kwargs):
"""Serialize data intended for a URL path.
:param str name: The name of the URL path parameter.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str
:returns: The serialized URL path
:raises: TypeError if serialization fails.
:raises: ValueError if data is None
"""
try:
output = self.serialize_data(data, data_type, **kwargs)
if data_type == "bool":
output = json.dumps(output)
if kwargs.get("skip_quote") is True:
output = str(output)
output = output.replace("{", quote("{")).replace("}", quote("}"))
else:
output = quote(str(output), safe="")
except SerializationError as exc:
raise TypeError("{} must be type {}.".format(name, data_type)) from exc
return output | Serialize data intended for a URL path.
:param str name: The name of the URL path parameter.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str
:returns: The serialized URL path
:raises: TypeError if serialization fails.
:raises: ValueError if data is None | url | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def query(self, name, data, data_type, **kwargs):
"""Serialize data intended for a URL query.
:param str name: The name of the query parameter.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str, list
:raises: TypeError if serialization fails.
:raises: ValueError if data is None
:returns: The serialized query parameter
"""
try:
# Treat the list aside, since we don't want to encode the div separator
if data_type.startswith("["):
internal_data_type = data_type[1:-1]
do_quote = not kwargs.get("skip_quote", False)
return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs)
# Not a list, regular serialization
output = self.serialize_data(data, data_type, **kwargs)
if data_type == "bool":
output = json.dumps(output)
if kwargs.get("skip_quote") is True:
output = str(output)
else:
output = quote(str(output), safe="")
except SerializationError as exc:
raise TypeError("{} must be type {}.".format(name, data_type)) from exc
return str(output) | Serialize data intended for a URL query.
:param str name: The name of the query parameter.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str, list
:raises: TypeError if serialization fails.
:raises: ValueError if data is None
:returns: The serialized query parameter | query | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def header(self, name, data, data_type, **kwargs):
"""Serialize data intended for a request header.
:param str name: The name of the header.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str
:raises: TypeError if serialization fails.
:raises: ValueError if data is None
:returns: The serialized header
"""
try:
if data_type in ["[str]"]:
data = ["" if d is None else d for d in data]
output = self.serialize_data(data, data_type, **kwargs)
if data_type == "bool":
output = json.dumps(output)
except SerializationError as exc:
raise TypeError("{} must be type {}.".format(name, data_type)) from exc
return str(output) | Serialize data intended for a request header.
:param str name: The name of the header.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:rtype: str
:raises: TypeError if serialization fails.
:raises: ValueError if data is None
:returns: The serialized header | header | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_data(self, data, data_type, **kwargs):
"""Serialize generic data according to supplied data type.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:raises: AttributeError if required data is None.
:raises: ValueError if data is None
:raises: SerializationError if serialization fails.
:returns: The serialized data.
:rtype: str, int, float, bool, dict, list
"""
if data is None:
raise ValueError("No value for given attribute")
try:
if data is CoreNull:
return None
if data_type in self.basic_types.values():
return self.serialize_basic(data, data_type, **kwargs)
if data_type in self.serialize_type:
return self.serialize_type[data_type](data, **kwargs)
# If dependencies is empty, try with current data class
# It has to be a subclass of Enum anyway
enum_type = self.dependencies.get(data_type, data.__class__)
if issubclass(enum_type, Enum):
return Serializer.serialize_enum(data, enum_obj=enum_type)
iter_type = data_type[0] + data_type[-1]
if iter_type in self.serialize_type:
return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs)
except (ValueError, TypeError) as err:
msg = "Unable to serialize value: {!r} as type: {!r}."
raise SerializationError(msg.format(data, data_type)) from err
return self._serialize(data, **kwargs) | Serialize generic data according to supplied data type.
:param object data: The data to be serialized.
:param str data_type: The type to be serialized from.
:raises: AttributeError if required data is None.
:raises: ValueError if data is None
:raises: SerializationError if serialization fails.
:returns: The serialized data.
:rtype: str, int, float, bool, dict, list | serialize_data | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_basic(cls, data, data_type, **kwargs):
"""Serialize basic builting data type.
Serializes objects to str, int, float or bool.
Possible kwargs:
- basic_types_serializers dict[str, callable] : If set, use the callable as serializer
- is_xml bool : If set, use xml_basic_types_serializers
:param obj data: Object to be serialized.
:param str data_type: Type of object in the iterable.
:rtype: str, int, float, bool
:return: serialized object
"""
custom_serializer = cls._get_custom_serializers(data_type, **kwargs)
if custom_serializer:
return custom_serializer(data)
if data_type == "str":
return cls.serialize_unicode(data)
return eval(data_type)(data) # nosec # pylint: disable=eval-used | Serialize basic builting data type.
Serializes objects to str, int, float or bool.
Possible kwargs:
- basic_types_serializers dict[str, callable] : If set, use the callable as serializer
- is_xml bool : If set, use xml_basic_types_serializers
:param obj data: Object to be serialized.
:param str data_type: Type of object in the iterable.
:rtype: str, int, float, bool
:return: serialized object | serialize_basic | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_unicode(cls, data):
"""Special handling for serializing unicode strings in Py2.
Encode to UTF-8 if unicode, otherwise handle as a str.
:param str data: Object to be serialized.
:rtype: str
:return: serialized object
"""
try: # If I received an enum, return its value
return data.value
except AttributeError:
pass
return str(data) | Special handling for serializing unicode strings in Py2.
Encode to UTF-8 if unicode, otherwise handle as a str.
:param str data: Object to be serialized.
:rtype: str
:return: serialized object | serialize_unicode | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_iter(self, data, iter_type, div=None, **kwargs):
"""Serialize iterable.
Supported kwargs:
- serialization_ctxt dict : The current entry of _attribute_map, or same format.
serialization_ctxt['type'] should be same as data_type.
- is_xml bool : If set, serialize as XML
:param list data: Object to be serialized.
:param str iter_type: Type of object in the iterable.
:param str div: If set, this str will be used to combine the elements
in the iterable into a combined string. Default is 'None'.
Defaults to False.
:rtype: list, str
:return: serialized iterable
"""
if isinstance(data, str):
raise SerializationError("Refuse str type as a valid iter type.")
serialization_ctxt = kwargs.get("serialization_ctxt", {})
is_xml = kwargs.get("is_xml", False)
serialized = []
for d in data:
try:
serialized.append(self.serialize_data(d, iter_type, **kwargs))
except ValueError as err:
if isinstance(err, SerializationError):
raise
serialized.append(None)
if kwargs.get("do_quote", False):
serialized = ["" if s is None else quote(str(s), safe="") for s in serialized]
if div:
serialized = ["" if s is None else str(s) for s in serialized]
serialized = div.join(serialized)
if "xml" in serialization_ctxt or is_xml:
# XML serialization is more complicated
xml_desc = serialization_ctxt.get("xml", {})
xml_name = xml_desc.get("name")
if not xml_name:
xml_name = serialization_ctxt["key"]
# Create a wrap node if necessary (use the fact that Element and list have "append")
is_wrapped = xml_desc.get("wrapped", False)
node_name = xml_desc.get("itemsName", xml_name)
if is_wrapped:
final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None))
else:
final_result = []
# All list elements to "local_node"
for el in serialized:
if isinstance(el, ET.Element):
el_node = el
else:
el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None))
if el is not None: # Otherwise it writes "None" :-p
el_node.text = str(el)
final_result.append(el_node)
return final_result
return serialized | Serialize iterable.
Supported kwargs:
- serialization_ctxt dict : The current entry of _attribute_map, or same format.
serialization_ctxt['type'] should be same as data_type.
- is_xml bool : If set, serialize as XML
:param list data: Object to be serialized.
:param str iter_type: Type of object in the iterable.
:param str div: If set, this str will be used to combine the elements
in the iterable into a combined string. Default is 'None'.
Defaults to False.
:rtype: list, str
:return: serialized iterable | serialize_iter | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_dict(self, attr, dict_type, **kwargs):
"""Serialize a dictionary of objects.
:param dict attr: Object to be serialized.
:param str dict_type: Type of object in the dictionary.
:rtype: dict
:return: serialized dictionary
"""
serialization_ctxt = kwargs.get("serialization_ctxt", {})
serialized = {}
for key, value in attr.items():
try:
serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs)
except ValueError as err:
if isinstance(err, SerializationError):
raise
serialized[self.serialize_unicode(key)] = None
if "xml" in serialization_ctxt:
# XML serialization is more complicated
xml_desc = serialization_ctxt["xml"]
xml_name = xml_desc["name"]
final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None))
for key, value in serialized.items():
ET.SubElement(final_result, key).text = value
return final_result
return serialized | Serialize a dictionary of objects.
:param dict attr: Object to be serialized.
:param str dict_type: Type of object in the dictionary.
:rtype: dict
:return: serialized dictionary | serialize_dict | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements
"""Serialize a generic object.
This will be handled as a dictionary. If object passed in is not
a basic type (str, int, float, dict, list) it will simply be
cast to str.
:param dict attr: Object to be serialized.
:rtype: dict or str
:return: serialized object
"""
if attr is None:
return None
if isinstance(attr, ET.Element):
return attr
obj_type = type(attr)
if obj_type in self.basic_types:
return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs)
if obj_type is _long_type:
return self.serialize_long(attr)
if obj_type is str:
return self.serialize_unicode(attr)
if obj_type is datetime.datetime:
return self.serialize_iso(attr)
if obj_type is datetime.date:
return self.serialize_date(attr)
if obj_type is datetime.time:
return self.serialize_time(attr)
if obj_type is datetime.timedelta:
return self.serialize_duration(attr)
if obj_type is decimal.Decimal:
return self.serialize_decimal(attr)
# If it's a model or I know this dependency, serialize as a Model
if obj_type in self.dependencies.values() or isinstance(attr, Model):
return self._serialize(attr)
if obj_type == dict:
serialized = {}
for key, value in attr.items():
try:
serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs)
except ValueError:
serialized[self.serialize_unicode(key)] = None
return serialized
if obj_type == list:
serialized = []
for obj in attr:
try:
serialized.append(self.serialize_object(obj, **kwargs))
except ValueError:
pass
return serialized
return str(attr) | Serialize a generic object.
This will be handled as a dictionary. If object passed in is not
a basic type (str, int, float, dict, list) it will simply be
cast to str.
:param dict attr: Object to be serialized.
:rtype: dict or str
:return: serialized object | serialize_object | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize bytearray into base-64 string.
:param str attr: Object to be serialized.
:rtype: str
:return: serialized base64
"""
return b64encode(attr).decode() | Serialize bytearray into base-64 string.
:param str attr: Object to be serialized.
:rtype: str
:return: serialized base64 | serialize_bytearray | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize str into base-64 string.
:param str attr: Object to be serialized.
:rtype: str
:return: serialized base64
"""
encoded = b64encode(attr).decode("ascii")
return encoded.strip("=").replace("+", "-").replace("/", "_") | Serialize str into base-64 string.
:param str attr: Object to be serialized.
:rtype: str
:return: serialized base64 | serialize_base64 | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize Decimal object to float.
:param decimal attr: Object to be serialized.
:rtype: float
:return: serialized decimal
"""
return float(attr) | Serialize Decimal object to float.
:param decimal attr: Object to be serialized.
:rtype: float
:return: serialized decimal | serialize_decimal | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_long(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize long (Py2) or int (Py3).
:param int attr: Object to be serialized.
:rtype: int/long
:return: serialized long
"""
return _long_type(attr) | Serialize long (Py2) or int (Py3).
:param int attr: Object to be serialized.
:rtype: int/long
:return: serialized long | serialize_long | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_date(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize Date object into ISO-8601 formatted string.
:param Date attr: Object to be serialized.
:rtype: str
:return: serialized date
"""
if isinstance(attr, str):
attr = isodate.parse_date(attr)
t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day)
return t | Serialize Date object into ISO-8601 formatted string.
:param Date attr: Object to be serialized.
:rtype: str
:return: serialized date | serialize_date | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_time(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize Time object into ISO-8601 formatted string.
:param datetime.time attr: Object to be serialized.
:rtype: str
:return: serialized time
"""
if isinstance(attr, str):
attr = isodate.parse_time(attr)
t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second)
if attr.microsecond:
t += ".{:02}".format(attr.microsecond)
return t | Serialize Time object into ISO-8601 formatted string.
:param datetime.time attr: Object to be serialized.
:rtype: str
:return: serialized time | serialize_time | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize TimeDelta object into ISO-8601 formatted string.
:param TimeDelta attr: Object to be serialized.
:rtype: str
:return: serialized duration
"""
if isinstance(attr, str):
attr = isodate.parse_duration(attr)
return isodate.duration_isoformat(attr) | Serialize TimeDelta object into ISO-8601 formatted string.
:param TimeDelta attr: Object to be serialized.
:rtype: str
:return: serialized duration | serialize_duration | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize Datetime object into RFC-1123 formatted string.
:param Datetime attr: Object to be serialized.
:rtype: str
:raises: TypeError if format invalid.
:return: serialized rfc
"""
try:
if not attr.tzinfo:
_LOGGER.warning("Datetime with no tzinfo will be considered UTC.")
utc = attr.utctimetuple()
except AttributeError as exc:
raise TypeError("RFC1123 object must be valid Datetime object.") from exc
return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format(
Serializer.days[utc.tm_wday],
utc.tm_mday,
Serializer.months[utc.tm_mon],
utc.tm_year,
utc.tm_hour,
utc.tm_min,
utc.tm_sec,
) | Serialize Datetime object into RFC-1123 formatted string.
:param Datetime attr: Object to be serialized.
:rtype: str
:raises: TypeError if format invalid.
:return: serialized rfc | serialize_rfc | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize Datetime object into ISO-8601 formatted string.
:param Datetime attr: Object to be serialized.
:rtype: str
:raises: SerializationError if format invalid.
:return: serialized iso
"""
if isinstance(attr, str):
attr = isodate.parse_datetime(attr)
try:
if not attr.tzinfo:
_LOGGER.warning("Datetime with no tzinfo will be considered UTC.")
utc = attr.utctimetuple()
if utc.tm_year > 9999 or utc.tm_year < 1:
raise OverflowError("Hit max or min date")
microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0")
if microseconds:
microseconds = "." + microseconds
date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format(
utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec
)
return date + microseconds + "Z"
except (ValueError, OverflowError) as err:
msg = "Unable to serialize datetime object."
raise SerializationError(msg) from err
except AttributeError as err:
msg = "ISO-8601 object must be valid Datetime object."
raise TypeError(msg) from err | Serialize Datetime object into ISO-8601 formatted string.
:param Datetime attr: Object to be serialized.
:rtype: str
:raises: SerializationError if format invalid.
:return: serialized iso | serialize_iso | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument
"""Serialize Datetime object into IntTime format.
This is represented as seconds.
:param Datetime attr: Object to be serialized.
:rtype: int
:raises: SerializationError if format invalid
:return: serialied unix
"""
if isinstance(attr, int):
return attr
try:
if not attr.tzinfo:
_LOGGER.warning("Datetime with no tzinfo will be considered UTC.")
return int(calendar.timegm(attr.utctimetuple()))
except AttributeError as exc:
raise TypeError("Unix time object must be valid Datetime object.") from exc | Serialize Datetime object into IntTime format.
This is represented as seconds.
:param Datetime attr: Object to be serialized.
:rtype: int
:raises: SerializationError if format invalid
:return: serialied unix | serialize_unix | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument
"""Extract the attribute in "data" based on the last part of the JSON path key.
:param str attr: The attribute to extract
:param dict attr_desc: The attribute description
:param dict data: The data to extract from
:rtype: object
:returns: The extracted attribute
"""
key = attr_desc["key"]
dict_keys = _FLATTEN.split(key)
return attribute_key_extractor(dict_keys[-1], None, data) | Extract the attribute in "data" based on the last part of the JSON path key.
:param str attr: The attribute to extract
:param dict attr_desc: The attribute description
:param dict data: The data to extract from
:rtype: object
:returns: The extracted attribute | last_rest_key_extractor | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument
"""Extract the attribute in "data" based on the last part of the JSON path key.
This is the case insensitive version of "last_rest_key_extractor"
:param str attr: The attribute to extract
:param dict attr_desc: The attribute description
:param dict data: The data to extract from
:rtype: object
:returns: The extracted attribute
"""
key = attr_desc["key"]
dict_keys = _FLATTEN.split(key)
return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) | Extract the attribute in "data" based on the last part of the JSON path key.
This is the case insensitive version of "last_rest_key_extractor"
:param str attr: The attribute to extract
:param dict attr_desc: The attribute description
:param dict data: The data to extract from
:rtype: object
:returns: The extracted attribute | last_rest_key_case_insensitive_extractor | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _extract_name_from_internal_type(internal_type):
"""Given an internal type XML description, extract correct XML name with namespace.
:param dict internal_type: An model type
:rtype: tuple
:returns: A tuple XML name + namespace dict
"""
internal_type_xml_map = getattr(internal_type, "_xml_map", {})
xml_name = internal_type_xml_map.get("name", internal_type.__name__)
xml_ns = internal_type_xml_map.get("ns", None)
if xml_ns:
xml_name = "{{{}}}{}".format(xml_ns, xml_name)
return xml_name | Given an internal type XML description, extract correct XML name with namespace.
:param dict internal_type: An model type
:rtype: tuple
:returns: A tuple XML name + namespace dict | _extract_name_from_internal_type | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def __call__(self, target_obj, response_data, content_type=None):
"""Call the deserializer to process a REST response.
:param str target_obj: Target data type to deserialize to.
:param requests.Response response_data: REST response object.
:param str content_type: Swagger "produces" if available.
:raises: DeserializationError if deserialization fails.
:return: Deserialized object.
:rtype: object
"""
data = self._unpack_content(response_data, content_type)
return self._deserialize(target_obj, data) | Call the deserializer to process a REST response.
:param str target_obj: Target data type to deserialize to.
:param requests.Response response_data: REST response object.
:param str content_type: Swagger "produces" if available.
:raises: DeserializationError if deserialization fails.
:return: Deserialized object.
:rtype: object | __call__ | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements
"""Call the deserializer on a model.
Data needs to be already deserialized as JSON or XML ElementTree
:param str target_obj: Target data type to deserialize to.
:param object data: Object to deserialize.
:raises: DeserializationError if deserialization fails.
:return: Deserialized object.
:rtype: object
"""
# This is already a model, go recursive just in case
if hasattr(data, "_attribute_map"):
constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")]
try:
for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access
if attr in constants:
continue
value = getattr(data, attr)
if value is None:
continue
local_type = mapconfig["type"]
internal_data_type = local_type.strip("[]{}")
if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum):
continue
setattr(data, attr, self._deserialize(local_type, value))
return data
except AttributeError:
return
response, class_name = self._classify_target(target_obj, data)
if isinstance(response, str):
return self.deserialize_data(data, response)
if isinstance(response, type) and issubclass(response, Enum):
return self.deserialize_enum(data, response)
if data is None or data is CoreNull:
return data
try:
attributes = response._attribute_map # type: ignore # pylint: disable=protected-access
d_attrs = {}
for attr, attr_desc in attributes.items():
# Check empty string. If it's not empty, someone has a real "additionalProperties"...
if attr == "additional_properties" and attr_desc["key"] == "":
continue
raw_value = None
# Enhance attr_desc with some dynamic data
attr_desc = attr_desc.copy() # Do a copy, do not change the real one
internal_data_type = attr_desc["type"].strip("[]{}")
if internal_data_type in self.dependencies:
attr_desc["internalType"] = self.dependencies[internal_data_type]
for key_extractor in self.key_extractors:
found_value = key_extractor(attr, attr_desc, data)
if found_value is not None:
if raw_value is not None and raw_value != found_value:
msg = (
"Ignoring extracted value '%s' from %s for key '%s'"
" (duplicate extraction, follow extractors order)"
)
_LOGGER.warning(msg, found_value, key_extractor, attr)
continue
raw_value = found_value
value = self.deserialize_data(raw_value, attr_desc["type"])
d_attrs[attr] = value
except (AttributeError, TypeError, KeyError) as err:
msg = "Unable to deserialize to object: " + class_name # type: ignore
raise DeserializationError(msg) from err
additional_properties = self._build_additional_properties(attributes, data)
return self._instantiate_model(response, d_attrs, additional_properties) | Call the deserializer on a model.
Data needs to be already deserialized as JSON or XML ElementTree
:param str target_obj: Target data type to deserialize to.
:param object data: Object to deserialize.
:raises: DeserializationError if deserialization fails.
:return: Deserialized object.
:rtype: object | _deserialize | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _classify_target(self, target, data):
"""Check to see whether the deserialization target object can
be classified into a subclass.
Once classification has been determined, initialize object.
:param str target: The target object type to deserialize to.
:param str/dict data: The response data to deserialize.
:return: The classified target object and its class name.
:rtype: tuple
"""
if target is None:
return None, None
if isinstance(target, str):
try:
target = self.dependencies[target]
except KeyError:
return target, target
try:
target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access
except AttributeError:
pass # Target is not a Model, no classify
return target, target.__class__.__name__ # type: ignore | Check to see whether the deserialization target object can
be classified into a subclass.
Once classification has been determined, initialize object.
:param str target: The target object type to deserialize to.
:param str/dict data: The response data to deserialize.
:return: The classified target object and its class name.
:rtype: tuple | _classify_target | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def failsafe_deserialize(self, target_obj, data, content_type=None):
"""Ignores any errors encountered in deserialization,
and falls back to not deserializing the object. Recommended
for use in error deserialization, as we want to return the
HttpResponseError to users, and not have them deal with
a deserialization error.
:param str target_obj: The target object type to deserialize to.
:param str/dict data: The response data to deserialize.
:param str content_type: Swagger "produces" if available.
:return: Deserialized object.
:rtype: object
"""
try:
return self(target_obj, data, content_type=content_type)
except: # pylint: disable=bare-except
_LOGGER.debug(
"Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True
)
return None | Ignores any errors encountered in deserialization,
and falls back to not deserializing the object. Recommended
for use in error deserialization, as we want to return the
HttpResponseError to users, and not have them deal with
a deserialization error.
:param str target_obj: The target object type to deserialize to.
:param str/dict data: The response data to deserialize.
:param str content_type: Swagger "produces" if available.
:return: Deserialized object.
:rtype: object | failsafe_deserialize | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _unpack_content(raw_data, content_type=None):
"""Extract the correct structure for deserialization.
If raw_data is a PipelineResponse, try to extract the result of RawDeserializer.
if we can't, raise. Your Pipeline should have a RawDeserializer.
If not a pipeline response and raw_data is bytes or string, use content-type
to decode it. If no content-type, try JSON.
If raw_data is something else, bypass all logic and return it directly.
:param obj raw_data: Data to be processed.
:param str content_type: How to parse if raw_data is a string/bytes.
:raises JSONDecodeError: If JSON is requested and parsing is impossible.
:raises UnicodeDecodeError: If bytes is not UTF8
:rtype: object
:return: Unpacked content.
"""
# Assume this is enough to detect a Pipeline Response without importing it
context = getattr(raw_data, "context", {})
if context:
if RawDeserializer.CONTEXT_NAME in context:
return context[RawDeserializer.CONTEXT_NAME]
raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize")
# Assume this is enough to recognize universal_http.ClientResponse without importing it
if hasattr(raw_data, "body"):
return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers)
# Assume this enough to recognize requests.Response without importing it.
if hasattr(raw_data, "_content_consumed"):
return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers)
if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"):
return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore
return raw_data | Extract the correct structure for deserialization.
If raw_data is a PipelineResponse, try to extract the result of RawDeserializer.
if we can't, raise. Your Pipeline should have a RawDeserializer.
If not a pipeline response and raw_data is bytes or string, use content-type
to decode it. If no content-type, try JSON.
If raw_data is something else, bypass all logic and return it directly.
:param obj raw_data: Data to be processed.
:param str content_type: How to parse if raw_data is a string/bytes.
:raises JSONDecodeError: If JSON is requested and parsing is impossible.
:raises UnicodeDecodeError: If bytes is not UTF8
:rtype: object
:return: Unpacked content. | _unpack_content | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _instantiate_model(self, response, attrs, additional_properties=None):
"""Instantiate a response model passing in deserialized args.
:param Response response: The response model class.
:param dict attrs: The deserialized response attributes.
:param dict additional_properties: Additional properties to be set.
:rtype: Response
:return: The instantiated response model.
"""
if callable(response):
subtype = getattr(response, "_subtype_map", {})
try:
readonly = [
k for k, v in response._validation.items() if v.get("readonly") # pylint: disable=protected-access
]
const = [
k for k, v in response._validation.items() if v.get("constant") # pylint: disable=protected-access
]
kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const}
response_obj = response(**kwargs)
for attr in readonly:
setattr(response_obj, attr, attrs.get(attr))
if additional_properties:
response_obj.additional_properties = additional_properties
return response_obj
except TypeError as err:
msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore
raise DeserializationError(msg + str(err)) from err
else:
try:
for attr, value in attrs.items():
setattr(response, attr, value)
return response
except Exception as exp:
msg = "Unable to populate response model. "
msg += "Type: {}, Error: {}".format(type(response), exp)
raise DeserializationError(msg) from exp | Instantiate a response model passing in deserialized args.
:param Response response: The response model class.
:param dict attrs: The deserialized response attributes.
:param dict additional_properties: Additional properties to be set.
:rtype: Response
:return: The instantiated response model. | _instantiate_model | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements
"""Process data for deserialization according to data type.
:param str data: The response string to be deserialized.
:param str data_type: The type to deserialize to.
:raises: DeserializationError if deserialization fails.
:return: Deserialized object.
:rtype: object
"""
if data is None:
return data
try:
if not data_type:
return data
if data_type in self.basic_types.values():
return self.deserialize_basic(data, data_type)
if data_type in self.deserialize_type:
if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())):
return data
is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment
"object",
"[]",
r"{}",
]
if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text:
return None
data_val = self.deserialize_type[data_type](data)
return data_val
iter_type = data_type[0] + data_type[-1]
if iter_type in self.deserialize_type:
return self.deserialize_type[iter_type](data, data_type[1:-1])
obj_type = self.dependencies[data_type]
if issubclass(obj_type, Enum):
if isinstance(data, ET.Element):
data = data.text
return self.deserialize_enum(data, obj_type)
except (ValueError, TypeError, AttributeError) as err:
msg = "Unable to deserialize response data."
msg += " Data: {}, {}".format(data, data_type)
raise DeserializationError(msg) from err
return self._deserialize(obj_type, data) | Process data for deserialization according to data type.
:param str data: The response string to be deserialized.
:param str data_type: The type to deserialize to.
:raises: DeserializationError if deserialization fails.
:return: Deserialized object.
:rtype: object | deserialize_data | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_iter(self, attr, iter_type):
"""Deserialize an iterable.
:param list attr: Iterable to be deserialized.
:param str iter_type: The type of object in the iterable.
:return: Deserialized iterable.
:rtype: list
"""
if attr is None:
return None
if isinstance(attr, ET.Element): # If I receive an element here, get the children
attr = list(attr)
if not isinstance(attr, (list, set)):
raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr)))
return [self.deserialize_data(a, iter_type) for a in attr] | Deserialize an iterable.
:param list attr: Iterable to be deserialized.
:param str iter_type: The type of object in the iterable.
:return: Deserialized iterable.
:rtype: list | deserialize_iter | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_dict(self, attr, dict_type):
"""Deserialize a dictionary.
:param dict/list attr: Dictionary to be deserialized. Also accepts
a list of key, value pairs.
:param str dict_type: The object type of the items in the dictionary.
:return: Deserialized dictionary.
:rtype: dict
"""
if isinstance(attr, list):
return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr}
if isinstance(attr, ET.Element):
# Transform <Key>value</Key> into {"Key": "value"}
attr = {el.tag: el.text for el in attr}
return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} | Deserialize a dictionary.
:param dict/list attr: Dictionary to be deserialized. Also accepts
a list of key, value pairs.
:param str dict_type: The object type of the items in the dictionary.
:return: Deserialized dictionary.
:rtype: dict | deserialize_dict | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements
"""Deserialize a generic object.
This will be handled as a dictionary.
:param dict attr: Dictionary to be deserialized.
:return: Deserialized object.
:rtype: dict
:raises: TypeError if non-builtin datatype encountered.
"""
if attr is None:
return None
if isinstance(attr, ET.Element):
# Do no recurse on XML, just return the tree as-is
return attr
if isinstance(attr, str):
return self.deserialize_basic(attr, "str")
obj_type = type(attr)
if obj_type in self.basic_types:
return self.deserialize_basic(attr, self.basic_types[obj_type])
if obj_type is _long_type:
return self.deserialize_long(attr)
if obj_type == dict:
deserialized = {}
for key, value in attr.items():
try:
deserialized[key] = self.deserialize_object(value, **kwargs)
except ValueError:
deserialized[key] = None
return deserialized
if obj_type == list:
deserialized = []
for obj in attr:
try:
deserialized.append(self.deserialize_object(obj, **kwargs))
except ValueError:
pass
return deserialized
error = "Cannot deserialize generic object with type: "
raise TypeError(error + str(obj_type)) | Deserialize a generic object.
This will be handled as a dictionary.
:param dict attr: Dictionary to be deserialized.
:return: Deserialized object.
:rtype: dict
:raises: TypeError if non-builtin datatype encountered. | deserialize_object | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements
"""Deserialize basic builtin data type from string.
Will attempt to convert to str, int, float and bool.
This function will also accept '1', '0', 'true' and 'false' as
valid bool values.
:param str attr: response string to be deserialized.
:param str data_type: deserialization data type.
:return: Deserialized basic type.
:rtype: str, int, float or bool
:raises: TypeError if string format is not valid.
"""
# If we're here, data is supposed to be a basic type.
# If it's still an XML node, take the text
if isinstance(attr, ET.Element):
attr = attr.text
if not attr:
if data_type == "str":
# None or '', node <a/> is empty string.
return ""
# None or '', node <a/> with a strong type is None.
# Don't try to model "empty bool" or "empty int"
return None
if data_type == "bool":
if attr in [True, False, 1, 0]:
return bool(attr)
if isinstance(attr, str):
if attr.lower() in ["true", "1"]:
return True
if attr.lower() in ["false", "0"]:
return False
raise TypeError("Invalid boolean value: {}".format(attr))
if data_type == "str":
return self.deserialize_unicode(attr)
return eval(data_type)(attr) # nosec # pylint: disable=eval-used | Deserialize basic builtin data type from string.
Will attempt to convert to str, int, float and bool.
This function will also accept '1', '0', 'true' and 'false' as
valid bool values.
:param str attr: response string to be deserialized.
:param str data_type: deserialization data type.
:return: Deserialized basic type.
:rtype: str, int, float or bool
:raises: TypeError if string format is not valid. | deserialize_basic | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_unicode(data):
"""Preserve unicode objects in Python 2, otherwise return data
as a string.
:param str data: response string to be deserialized.
:return: Deserialized string.
:rtype: str or unicode
"""
# We might be here because we have an enum modeled as string,
# and we try to deserialize a partial dict with enum inside
if isinstance(data, Enum):
return data
# Consider this is real string
try:
if isinstance(data, unicode): # type: ignore
return data
except NameError:
return str(data)
return str(data) | Preserve unicode objects in Python 2, otherwise return data
as a string.
:param str data: response string to be deserialized.
:return: Deserialized string.
:rtype: str or unicode | deserialize_unicode | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_enum(data, enum_obj):
"""Deserialize string into enum object.
If the string is not a valid enum value it will be returned as-is
and a warning will be logged.
:param str data: Response string to be deserialized. If this value is
None or invalid it will be returned as-is.
:param Enum enum_obj: Enum object to deserialize to.
:return: Deserialized enum object.
:rtype: Enum
"""
if isinstance(data, enum_obj) or data is None:
return data
if isinstance(data, Enum):
data = data.value
if isinstance(data, int):
# Workaround. We might consider remove it in the future.
try:
return list(enum_obj.__members__.values())[data]
except IndexError as exc:
error = "{!r} is not a valid index for enum {!r}"
raise DeserializationError(error.format(data, enum_obj)) from exc
try:
return enum_obj(str(data))
except ValueError:
for enum_value in enum_obj:
if enum_value.value.lower() == str(data).lower():
return enum_value
# We don't fail anymore for unknown value, we deserialize as a string
_LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj)
return Deserializer.deserialize_unicode(data) | Deserialize string into enum object.
If the string is not a valid enum value it will be returned as-is
and a warning will be logged.
:param str data: Response string to be deserialized. If this value is
None or invalid it will be returned as-is.
:param Enum enum_obj: Enum object to deserialize to.
:return: Deserialized enum object.
:rtype: Enum | deserialize_enum | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_bytearray(attr):
"""Deserialize string into bytearray.
:param str attr: response string to be deserialized.
:return: Deserialized bytearray
:rtype: bytearray
:raises: TypeError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
return bytearray(b64decode(attr)) # type: ignore | Deserialize string into bytearray.
:param str attr: response string to be deserialized.
:return: Deserialized bytearray
:rtype: bytearray
:raises: TypeError if string format invalid. | deserialize_bytearray | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_base64(attr):
"""Deserialize base64 encoded string into string.
:param str attr: response string to be deserialized.
:return: Deserialized base64 string
:rtype: bytearray
:raises: TypeError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore
attr = attr + padding # type: ignore
encoded = attr.replace("-", "+").replace("_", "/")
return b64decode(encoded) | Deserialize base64 encoded string into string.
:param str attr: response string to be deserialized.
:return: Deserialized base64 string
:rtype: bytearray
:raises: TypeError if string format invalid. | deserialize_base64 | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_decimal(attr):
"""Deserialize string into Decimal object.
:param str attr: response string to be deserialized.
:return: Deserialized decimal
:raises: DeserializationError if string format invalid.
:rtype: decimal
"""
if isinstance(attr, ET.Element):
attr = attr.text
try:
return decimal.Decimal(str(attr)) # type: ignore
except decimal.DecimalException as err:
msg = "Invalid decimal {}".format(attr)
raise DeserializationError(msg) from err | Deserialize string into Decimal object.
:param str attr: response string to be deserialized.
:return: Deserialized decimal
:raises: DeserializationError if string format invalid.
:rtype: decimal | deserialize_decimal | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_long(attr):
"""Deserialize string into long (Py2) or int (Py3).
:param str attr: response string to be deserialized.
:return: Deserialized int
:rtype: long or int
:raises: ValueError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
return _long_type(attr) # type: ignore | Deserialize string into long (Py2) or int (Py3).
:param str attr: response string to be deserialized.
:return: Deserialized int
:rtype: long or int
:raises: ValueError if string format invalid. | deserialize_long | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_duration(attr):
"""Deserialize ISO-8601 formatted string into TimeDelta object.
:param str attr: response string to be deserialized.
:return: Deserialized duration
:rtype: TimeDelta
:raises: DeserializationError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
try:
duration = isodate.parse_duration(attr)
except (ValueError, OverflowError, AttributeError) as err:
msg = "Cannot deserialize duration object."
raise DeserializationError(msg) from err
return duration | Deserialize ISO-8601 formatted string into TimeDelta object.
:param str attr: response string to be deserialized.
:return: Deserialized duration
:rtype: TimeDelta
:raises: DeserializationError if string format invalid. | deserialize_duration | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_date(attr):
"""Deserialize ISO-8601 formatted string into Date object.
:param str attr: response string to be deserialized.
:return: Deserialized date
:rtype: Date
:raises: DeserializationError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore
raise DeserializationError("Date must have only digits and -. Received: %s" % attr)
# This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception.
return isodate.parse_date(attr, defaultmonth=0, defaultday=0) | Deserialize ISO-8601 formatted string into Date object.
:param str attr: response string to be deserialized.
:return: Deserialized date
:rtype: Date
:raises: DeserializationError if string format invalid. | deserialize_date | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_time(attr):
"""Deserialize ISO-8601 formatted string into time object.
:param str attr: response string to be deserialized.
:return: Deserialized time
:rtype: datetime.time
:raises: DeserializationError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore
raise DeserializationError("Date must have only digits and -. Received: %s" % attr)
return isodate.parse_time(attr) | Deserialize ISO-8601 formatted string into time object.
:param str attr: response string to be deserialized.
:return: Deserialized time
:rtype: datetime.time
:raises: DeserializationError if string format invalid. | deserialize_time | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_rfc(attr):
"""Deserialize RFC-1123 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:return: Deserialized RFC datetime
:rtype: Datetime
:raises: DeserializationError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
try:
parsed_date = email.utils.parsedate_tz(attr) # type: ignore
date_obj = datetime.datetime(
*parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60))
)
if not date_obj.tzinfo:
date_obj = date_obj.astimezone(tz=TZ_UTC)
except ValueError as err:
msg = "Cannot deserialize to rfc datetime object."
raise DeserializationError(msg) from err
return date_obj | Deserialize RFC-1123 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:return: Deserialized RFC datetime
:rtype: Datetime
:raises: DeserializationError if string format invalid. | deserialize_rfc | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_iso(attr):
"""Deserialize ISO-8601 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:return: Deserialized ISO datetime
:rtype: Datetime
:raises: DeserializationError if string format invalid.
"""
if isinstance(attr, ET.Element):
attr = attr.text
try:
attr = attr.upper() # type: ignore
match = Deserializer.valid_date.match(attr)
if not match:
raise ValueError("Invalid datetime string: " + attr)
check_decimal = attr.split(".")
if len(check_decimal) > 1:
decimal_str = ""
for digit in check_decimal[1]:
if digit.isdigit():
decimal_str += digit
else:
break
if len(decimal_str) > 6:
attr = attr.replace(decimal_str, decimal_str[0:6])
date_obj = isodate.parse_datetime(attr)
test_utc = date_obj.utctimetuple()
if test_utc.tm_year > 9999 or test_utc.tm_year < 1:
raise OverflowError("Hit max or min date")
except (ValueError, OverflowError, AttributeError) as err:
msg = "Cannot deserialize datetime object."
raise DeserializationError(msg) from err
return date_obj | Deserialize ISO-8601 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:return: Deserialized ISO datetime
:rtype: Datetime
:raises: DeserializationError if string format invalid. | deserialize_iso | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def deserialize_unix(attr):
"""Serialize Datetime object into IntTime format.
This is represented as seconds.
:param int attr: Object to be serialized.
:return: Deserialized datetime
:rtype: Datetime
:raises: DeserializationError if format invalid
"""
if isinstance(attr, ET.Element):
attr = int(attr.text) # type: ignore
try:
attr = int(attr)
date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC)
except ValueError as err:
msg = "Cannot deserialize to unix datetime object."
raise DeserializationError(msg) from err
return date_obj | Serialize Datetime object into IntTime format.
This is represented as seconds.
:param int attr: Object to be serialized.
:return: Deserialized datetime
:rtype: Datetime
:raises: DeserializationError if format invalid | deserialize_unix | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_serialization.py | MIT |
def _format_api_version(request: HttpRequest, api_version: str) -> HttpRequest:
"""Returns a request copy that includes an api-version query parameter if one wasn't originally present.
:param request: The HTTP request being sent.
:type request: ~azure.core.rest.HttpRequest
:param str api_version: The service API version that the request should include.
:returns: A copy of the request that includes an api-version query parameter.
:rtype: ~azure.core.rest.HttpRequest
"""
request_copy = deepcopy(request)
params = {"api-version": api_version} # By default, we want to use the client's API version
query = urlparse(request_copy.url).query
if query:
request_copy.url = request_copy.url.partition("?")[0]
existing_params = {p[0]: p[-1] for p in [p.partition("=") for p in query.split("&")]}
params.update(existing_params) # If an api-version was provided, this will overwrite our default
# Reconstruct the query parameters onto the URL
query_params = []
for k, v in params.items():
query_params.append("{}={}".format(k, v))
query = "?" + "&".join(query_params)
request_copy.url = request_copy.url + query
return request_copy | Returns a request copy that includes an api-version query parameter if one wasn't originally present.
:param request: The HTTP request being sent.
:type request: ~azure.core.rest.HttpRequest
:param str api_version: The service API version that the request should include.
:returns: A copy of the request that includes an api-version query parameter.
:rtype: ~azure.core.rest.HttpRequest | _format_api_version | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | MIT |
def begin_download(
self,
certificate_info_object: Union[CertificateInfoObject, JSON, IO[bytes]],
*,
content_type: str = "application/json",
polling: Optional[Literal[False]] = None,
**kwargs: Any,
) -> LROPoller[SecurityDomainObject]:
"""Retrieves the Security Domain from the managed HSM. Calling this endpoint can
be used to activate a provisioned managed HSM resource.
:param certificate_info_object: The Security Domain download operation requires the customer to provide N
certificates (minimum 3 and maximum 10) containing a public key in JWK format. Required in one of the
following types: CertificateInfoObject, JSON, or IO[bytes].
:type certificate_info_object: ~azure.keyvault.securitydomain.models.CertificateInfoObject or
JSON or IO[bytes]
:keyword str content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:keyword bool polling: If set to False, the operation will not poll for completion and calling `.result()` on
the poller will return the security domain object immediately. Default value is None.
:return: An instance of LROPoller that returns SecurityDomainObject. The
SecurityDomainObject is compatible with MutableMapping
:rtype:
~azure.core.polling.LROPoller[~azure.keyvault.securitydomain.models.SecurityDomainObject]
:raises ~azure.core.exceptions.HttpResponseError:
"""
delay = kwargs.pop("polling_interval", self._config.polling_interval)
polling_method = (
SecurityDomainDownloadNoPolling()
if polling is False
else SecurityDomainDownloadPollingMethod(lro_algorithms=[SecurityDomainDownloadPolling()], timeout=delay)
)
return super().begin_download( # type: ignore[return-value]
certificate_info_object,
content_type=content_type,
polling=polling_method,
**kwargs,
) | Retrieves the Security Domain from the managed HSM. Calling this endpoint can
be used to activate a provisioned managed HSM resource.
:param certificate_info_object: The Security Domain download operation requires the customer to provide N
certificates (minimum 3 and maximum 10) containing a public key in JWK format. Required in one of the
following types: CertificateInfoObject, JSON, or IO[bytes].
:type certificate_info_object: ~azure.keyvault.securitydomain.models.CertificateInfoObject or
JSON or IO[bytes]
:keyword str content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:keyword bool polling: If set to False, the operation will not poll for completion and calling `.result()` on
the poller will return the security domain object immediately. Default value is None.
:return: An instance of LROPoller that returns SecurityDomainObject. The
SecurityDomainObject is compatible with MutableMapping
:rtype:
~azure.core.polling.LROPoller[~azure.keyvault.securitydomain.models.SecurityDomainObject]
:raises ~azure.core.exceptions.HttpResponseError: | begin_download | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | MIT |
def begin_upload(
self,
security_domain: Union[SecurityDomainObject, JSON, IO[bytes]],
*,
content_type: str = "application/json",
polling: Optional[Literal[False]] = None,
**kwargs: Any,
) -> LROPoller[SecurityDomainOperationStatus]:
"""Restore the provided Security Domain.
:param security_domain: The Security Domain to be restored. Required in one of the following types:
SecurityDomainObject, JSON, or IO[bytes].
:type security_domain: ~azure.keyvault.securitydomain.models.SecurityDomainObject or JSON or
IO[bytes]
:keyword str content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:keyword bool polling: If set to False, the operation will not poll for completion and calling `.result()` on
the poller will return the initial response immediately. Default value is None.
:return: An instance of LROPoller that returns SecurityDomainOperationStatus. The
SecurityDomainOperationStatus is compatible with MutableMapping
:rtype:
~azure.core.polling.LROPoller[~azure.keyvault.securitydomain.models.SecurityDomainOperationStatus]
:raises ~azure.core.exceptions.HttpResponseError:
"""
delay = kwargs.pop("polling_interval", self._config.polling_interval)
polling_method = (
SecurityDomainUploadNoPolling()
if polling is False
else SecurityDomainUploadPollingMethod(lro_algorithms=[SecurityDomainUploadPolling()], timeout=delay)
)
return super().begin_upload(
security_domain,
content_type=content_type,
polling=polling_method,
**kwargs,
) | Restore the provided Security Domain.
:param security_domain: The Security Domain to be restored. Required in one of the following types:
SecurityDomainObject, JSON, or IO[bytes].
:type security_domain: ~azure.keyvault.securitydomain.models.SecurityDomainObject or JSON or
IO[bytes]
:keyword str content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:keyword bool polling: If set to False, the operation will not poll for completion and calling `.result()` on
the poller will return the initial response immediately. Default value is None.
:return: An instance of LROPoller that returns SecurityDomainOperationStatus. The
SecurityDomainOperationStatus is compatible with MutableMapping
:rtype:
~azure.core.polling.LROPoller[~azure.keyvault.securitydomain.models.SecurityDomainOperationStatus]
:raises ~azure.core.exceptions.HttpResponseError: | begin_upload | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | MIT |
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
"""Runs a network request using the client's existing pipeline.
The request URL can be relative to the vault URL. The service API version used for the request is the same as
the client's unless otherwise specified. This method does not raise if the response is an error; to raise an
exception, call `raise_for_status()` on the returned response object. For more information about how to send
custom requests with this method, see https://aka.ms/azsdk/dpcodegen/python/send_request.
:param request: The network request you want to make.
:type request: ~azure.core.rest.HttpRequest
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
:return: The response of your network call. Does not do error handling on your response.
:rtype: ~azure.core.rest.HttpResponse
"""
request_copy = _format_api_version(request, self.api_version)
path_format_arguments = {
"vaultBaseUrl": _SERIALIZER.url("vault_base_url", self._vault_url, "str", skip_quote=True),
}
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
return self._client.send_request(request_copy, stream=stream, **kwargs) | Runs a network request using the client's existing pipeline.
The request URL can be relative to the vault URL. The service API version used for the request is the same as
the client's unless otherwise specified. This method does not raise if the response is an error; to raise an
exception, call `raise_for_status()` on the returned response object. For more information about how to send
custom requests with this method, see https://aka.ms/azsdk/dpcodegen/python/send_request.
:param request: The network request you want to make.
:type request: ~azure.core.rest.HttpRequest
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
:return: The response of your network call. Does not do error handling on your response.
:rtype: ~azure.core.rest.HttpResponse | send_request | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | MIT |
def patch_sdk():
"""Do not remove from this file.
`patch_sdk` is a last resort escape hatch that allows you to do customizations
you can't accomplish using the techniques described in
https://aka.ms/azsdk/python/dpcodegen/python/customize
""" | Do not remove from this file.
`patch_sdk` is a last resort escape hatch that allows you to do customizations
you can't accomplish using the techniques described in
https://aka.ms/azsdk/python/dpcodegen/python/customize | patch_sdk | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_patch.py | MIT |
def _timedelta_as_isostr(td: timedelta) -> str:
"""Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S'
Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython
:param timedelta td: The timedelta to convert
:rtype: str
:return: ISO8601 version of this timedelta
"""
# Split seconds to larger units
seconds = td.total_seconds()
minutes, seconds = divmod(seconds, 60)
hours, minutes = divmod(minutes, 60)
days, hours = divmod(hours, 24)
days, hours, minutes = list(map(int, (days, hours, minutes)))
seconds = round(seconds, 6)
# Build date
date_str = ""
if days:
date_str = "%sD" % days
if hours or minutes or seconds:
# Build time
time_str = "T"
# Hours
bigger_exists = date_str or hours
if bigger_exists:
time_str += "{:02}H".format(hours)
# Minutes
bigger_exists = bigger_exists or minutes
if bigger_exists:
time_str += "{:02}M".format(minutes)
# Seconds
try:
if seconds.is_integer():
seconds_string = "{:02}".format(int(seconds))
else:
# 9 chars long w/ leading 0, 6 digits after decimal
seconds_string = "%09.6f" % seconds
# Remove trailing zeros
seconds_string = seconds_string.rstrip("0")
except AttributeError: # int.is_integer() raises
seconds_string = "{:02}".format(seconds)
time_str += "{}S".format(seconds_string)
else:
time_str = ""
return "P" + date_str + time_str | Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S'
Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython
:param timedelta td: The timedelta to convert
:rtype: str
:return: ISO8601 version of this timedelta | _timedelta_as_isostr | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime:
"""Deserialize ISO-8601 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:rtype: ~datetime.datetime
:returns: The datetime object from that input
"""
if isinstance(attr, datetime):
# i'm already deserialized
return attr
attr = attr.upper()
match = _VALID_DATE.match(attr)
if not match:
raise ValueError("Invalid datetime string: " + attr)
check_decimal = attr.split(".")
if len(check_decimal) > 1:
decimal_str = ""
for digit in check_decimal[1]:
if digit.isdigit():
decimal_str += digit
else:
break
if len(decimal_str) > 6:
attr = attr.replace(decimal_str, decimal_str[0:6])
date_obj = isodate.parse_datetime(attr)
test_utc = date_obj.utctimetuple()
if test_utc.tm_year > 9999 or test_utc.tm_year < 1:
raise OverflowError("Hit max or min date")
return date_obj | Deserialize ISO-8601 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:rtype: ~datetime.datetime
:returns: The datetime object from that input | _deserialize_datetime | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime:
"""Deserialize RFC7231 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:rtype: ~datetime.datetime
:returns: The datetime object from that input
"""
if isinstance(attr, datetime):
# i'm already deserialized
return attr
match = _VALID_RFC7231.match(attr)
if not match:
raise ValueError("Invalid datetime string: " + attr)
return email.utils.parsedate_to_datetime(attr) | Deserialize RFC7231 formatted string into Datetime object.
:param str attr: response string to be deserialized.
:rtype: ~datetime.datetime
:returns: The datetime object from that input | _deserialize_datetime_rfc7231 | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime:
"""Deserialize unix timestamp into Datetime object.
:param str attr: response string to be deserialized.
:rtype: ~datetime.datetime
:returns: The datetime object from that input
"""
if isinstance(attr, datetime):
# i'm already deserialized
return attr
return datetime.fromtimestamp(attr, TZ_UTC) | Deserialize unix timestamp into Datetime object.
:param str attr: response string to be deserialized.
:rtype: ~datetime.datetime
:returns: The datetime object from that input | _deserialize_datetime_unix_timestamp | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
def _deserialize_date(attr: typing.Union[str, date]) -> date:
"""Deserialize ISO-8601 formatted string into Date object.
:param str attr: response string to be deserialized.
:rtype: date
:returns: The date object from that input
"""
# This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception.
if isinstance(attr, date):
return attr
return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore | Deserialize ISO-8601 formatted string into Date object.
:param str attr: response string to be deserialized.
:rtype: date
:returns: The date object from that input | _deserialize_date | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
def _deserialize_time(attr: typing.Union[str, time]) -> time:
"""Deserialize ISO-8601 formatted string into time object.
:param str attr: response string to be deserialized.
:rtype: datetime.time
:returns: The time object from that input
"""
if isinstance(attr, time):
return attr
return isodate.parse_time(attr) | Deserialize ISO-8601 formatted string into time object.
:param str attr: response string to be deserialized.
:rtype: datetime.time
:returns: The time object from that input | _deserialize_time | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]:
"""Return a dict that can be turned into json using json.dump.
:keyword bool exclude_readonly: Whether to remove the readonly properties.
:returns: A dict JSON compatible object
:rtype: dict
"""
result = {}
readonly_props = []
if exclude_readonly:
readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)]
for k, v in self.items():
if exclude_readonly and k in readonly_props: # pyright: ignore
continue
is_multipart_file_input = False
try:
is_multipart_file_input = next(
rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k
)._is_multipart_file_input
except StopIteration:
pass
result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly)
return result | Return a dict that can be turned into json using json.dump.
:keyword bool exclude_readonly: Whether to remove the readonly properties.
:returns: A dict JSON compatible object
:rtype: dict | as_dict | python | Azure/azure-cli | src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | https://github.com/Azure/azure-cli/blob/master/src/azure-cli/azure/cli/command_modules/keyvault/vendored_sdks/azure_keyvault_securitydomain/_model_base.py | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.