diff --git a/scripts/sdk_generate.sh b/scripts/sdk_generate.sh index b69ac3af04c8..927242075db1 100755 --- a/scripts/sdk_generate.sh +++ b/scripts/sdk_generate.sh @@ -8,12 +8,6 @@ export VIRTUAL_ENV PATH="$VIRTUAL_ENV/bin:$PATH" export PATH -# node version degrade -npm install -g n -n 16.15.0 -echo "$PATH" -export PATH="/usr/local/n/versions/node/16.15.0/bin:$PATH" - TEMP_FILE="$TMPDIR/venv-sdk/auto_temp.json" # generate code python -m packaging_tools.sdk_generator "$1" "$TEMP_FILE" 2>&1 diff --git a/sdk/confidentialledger/azure-security-confidentialledger/_meta.json b/sdk/confidentialledger/azure-security-confidentialledger/_meta.json new file mode 100644 index 000000000000..d298ddada1db --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/_meta.json @@ -0,0 +1,20 @@ +{ + "commit": "", + "repository_url": "https://github.com/openapi-env-test/azure-rest-api-specs", + "cadl_src": "confidentialledger/ConfientialLedger", + "@autorest/python": { + "version": "6.1.11", + "resolved": "https://registry.npmjs.org/@autorest/python/-/python-6.1.11.tgz", + "overridden": false + }, + "@azure-tools/cadl-python": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/@azure-tools/cadl-python/-/cadl-python-0.2.5.tgz", + "overridden": false, + "dependencies": { + "@autorest/python": { + "version": "6.1.11" + } + } + } +} \ No newline at end of file diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/__init__.py new file mode 100644 index 000000000000..87e78ffcc463 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/__init__.py @@ -0,0 +1,24 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import ConfidentialLedgerService +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = ["ConfidentialLedgerService"] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_client.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_client.py new file mode 100644 index 000000000000..88297aeaab55 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_client.py @@ -0,0 +1,81 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING + +from azure.core import PipelineClient +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import ConfidentialLedgerServiceConfiguration +from ._operations import ConfidentialLedgerServiceOperationsMixin +from ._serialization import Deserializer, Serializer + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class ConfidentialLedgerService( + ConfidentialLedgerServiceOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """Service client. + + :param ledger_uri: Required. + :type ledger_uri: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + """ + + def __init__(self, ledger_uri: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "{ledgerUri}" + self._config = ConfidentialLedgerServiceConfiguration(ledger_uri=ledger_uri, credential=credential, **kwargs) + self._client = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :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 = deepcopy(request) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, **kwargs) + + def close(self): + # type: () -> None + self._client.close() + + def __enter__(self): + # type: () -> ConfidentialLedgerService + self._client.__enter__() + return self + + def __exit__(self, *exc_details): + # type: (Any) -> None + self._client.__exit__(*exc_details) diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_configuration.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_configuration.py new file mode 100644 index 000000000000..a876d2744fb6 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_configuration.py @@ -0,0 +1,62 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.configuration import Configuration +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class ConfidentialLedgerServiceConfiguration(Configuration): # pylint: disable=too-many-instance-attributes + """Configuration for ConfidentialLedgerService. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param ledger_uri: Required. + :type ledger_uri: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + """ + + def __init__(self, ledger_uri: str, credential: "TokenCredential", **kwargs: Any) -> None: + super(ConfidentialLedgerServiceConfiguration, self).__init__(**kwargs) + if ledger_uri is None: + raise ValueError("Parameter 'ledger_uri' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.ledger_uri = ledger_uri + self.credential = credential + self.credential_scopes = kwargs.pop("credential_scopes", ["https://confidential-ledger.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "security-confidentialledger/{}".format(VERSION)) + self._configure(**kwargs) + + def _configure( + self, **kwargs # type: Any + ): + # type: (...) -> None + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_model_base.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_model_base.py new file mode 100644 index 000000000000..22b1933b6f0f --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_model_base.py @@ -0,0 +1,643 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +import functools +import sys +import logging +import base64 +import re +import isodate +from json import JSONEncoder +import typing +from datetime import datetime, date, time, timedelta +from azure.core.utils._utils import _FixedOffset +from collections.abc import MutableMapping +from azure.core.exceptions import DeserializationError +import copy + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["NULL", "AzureJSONEncoder", "Model", "rest_field", "rest_discriminator"] + + +class _Null(object): + """To create a Falsy object""" + + def __bool__(self): + return False + + __nonzero__ = __bool__ # Python2 compatibility + + +NULL = _Null() +""" +A falsy sentinel object which is supposed to be used to specify attributes +with no data. This gets serialized to `null` on the wire. +""" + + +def _timedelta_as_isostr(td): + # type: (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 + """ + + # 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 + + # 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) + + return "P" + date_str + time_str + + +def _datetime_as_isostr(dt): + # type: (typing.Union[datetime, date, time, timedelta]) -> str + """Converts a datetime.(datetime|date|time|timedelta) object into an ISO 8601 formatted string""" + # First try datetime.datetime + if hasattr(dt, "year") and hasattr(dt, "hour"): + dt = typing.cast(datetime, dt) + # astimezone() fails for naive times in Python 2.7, so make make sure dt is aware (tzinfo is set) + if not dt.tzinfo: + iso_formatted = dt.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = dt.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + try: + dt = typing.cast(typing.Union[date, time], dt) + return dt.isoformat() + # Last, try datetime.timedelta + except AttributeError: + dt = typing.cast(timedelta, dt) + return _timedelta_as_isostr(dt) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc # type: ignore +except ImportError: + TZ_UTC = _FixedOffset(0) # type: ignore + + +def _serialize_bytes(o) -> str: + return base64.b64encode(o).decode() + + +def _serialize_datetime(o): + if hasattr(o, "year") and hasattr(o, "hour"): + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._readonly + except AttributeError: + return False + + +class AzureJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + if isinstance(o, (bytes, bytearray)): + return base64.b64encode(o).decode() + try: + return super(AzureJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o) + try: + # First try datetime.datetime + return _serialize_datetime(o) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(AzureJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + +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 + """ + 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 + + +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 + """ + # 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) + + +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 + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def deserialize_bytes(attr): + return bytes(base64.b64decode(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: deserialize_bytes, +} + + +def _get_model(module_name: str, model_name: str): + module_end = module_name.rsplit(".", 1)[0] + module = sys.modules[module_end] + models = {k: v for k, v in module.__dict__.items() if isinstance(v, type)} + if model_name not in models: + _LOGGER.warning("Can not find model name in models, will not deserialize") + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping): + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: str) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView: + return self._data.keys() + + def values(self) -> typing.ValuesView: + return self._data.values() + + def items(self) -> typing.ItemsView: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: typing.Any, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str) -> typing.Any: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: typing.Any, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o): + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o) + try: + # First try datetime.datetime + return _serialize_datetime(o) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rest_field: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + return _deserialize(rest_field._type, value) if (rest_field and rest_field._is_model) else _serialize(value) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args, **kwargs): + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update({self._attr_to_rest_field[k]._rest_name: _serialize(v) for k, v in kwargs.items()}) + super().__init__(dict_to_pass) + + def copy(self): + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any): + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rest_field in attr_to_rest_field.items(): + rest_field._module = cls.__module__ + if not rest_field._type: + rest_field._type = rest_field._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rest_field._rest_name_input: + rest_field._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = {k: v for k, v in attr_to_rest_field.items()} + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator=None): + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls + + @classmethod + def _get_discriminator(cls) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator: + return v._rest_name + return None + + @classmethod + def _deserialize(cls, data): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator() + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data) + + +def _deserialize(deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], value: typing.Any): + try: + if value is None: + return None + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value) + return deserializer(value) if deserializer else value + except Exception as e: + raise DeserializationError() from e + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, + is_discriminator: bool = False, + readonly: bool = False, + default: typing.Any = _UNSET, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._readonly = readonly + self._is_model = False + self._default = default + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + return _deserialize(self._type, _serialize(item)) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model and not _is_model(value): + obj.__setitem__(self._rest_name, _deserialize(self._type, value)) + obj.__setitem__(self._rest_name, _serialize(value)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + try: + if _is_model(_get_model(self._module, annotation)): + self._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, _get_model(self._module, annotation)) + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ == typing.Literal: + return None + except AttributeError: + pass + + # is it optional? + try: + # right now, assuming we don't have unions, since we're getting rid of the only + # union we used to have in msrest models, which was union of str and enum + if any(a for a in annotation.__args__ if a == type(None)): + + if_obj_deserializer = self._get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except (AttributeError): + pass + + # is it a forward ref / in quotes? + if isinstance(annotation, str) or type(annotation) == typing.ForwardRef: + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if self._module is not None: + annotation = _get_model(self._module, model_name) + + try: + if annotation._name == "Dict": + key_deserializer = self._get_deserialize_callable_from_annotation(annotation.__args__[0]) + value_deserializer = self._get_deserialize_callable_from_annotation(annotation.__args__[1]) + + def _deserialize_dict( + key_deserializer: typing.Optional[typing.Callable], + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return { + _deserialize(key_deserializer, k): _deserialize(value_deserializer, v) for k, v in obj.items() + } + + return functools.partial( + _deserialize_dict, + key_deserializer, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: + if len(annotation.__args__) > 1: + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], obj + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry) for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + self._get_deserialize_callable_from_annotation(dt) for dt in annotation.__args__ + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = self._get_deserialize_callable_from_annotation(annotation.__args__[0]) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + annotation, + deserializer_from_mapping, + obj, + ): + if obj is None: + return obj + try: + return _deserialize(annotation, obj) + except Exception: + pass + return _deserialize(deserializer_from_mapping, obj) + + return functools.partial(_deserialize_default, annotation, _DESERIALIZE_MAPPING.get(annotation)) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, + readonly: bool = False, + default: typing.Any = _UNSET, +) -> typing.Any: + return _RestField(name=name, type=type, readonly=readonly, default=default) + + +def rest_discriminator( + *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/__init__.py new file mode 100644 index 000000000000..ca4191aedb72 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import ConfidentialLedgerServiceOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ConfidentialLedgerServiceOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/_operations.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/_operations.py new file mode 100644 index 000000000000..304d88bb3a7e --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/_operations.py @@ -0,0 +1,1237 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import json +import sys +from typing import Any, Callable, Dict, IO, Iterable, List, Optional, TypeVar, Union, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.pipeline.transport import HttpResponse +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import AzureJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import MixinABC, _format_url_section + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_list_collections_request(*, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/collections" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_enclave_quotes_request(*, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/enclaveQuotes" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_constitution_request(*, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/governance/constitution" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_consortium_members_request(*, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/governance/members" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_list_ledger_entries_request(*, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/transactions" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_ledger_entry_request( + *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/transactions" + + # Construct parameters + if collection_id is not None: + _params["collectionId"] = _SERIALIZER.query("collection_id", collection_id, "str") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_ledger_entry_request( + transaction_id: str, *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/transactions/{transactionId}" + path_format_arguments = { + "transactionId": _SERIALIZER.url("transaction_id", transaction_id, "str"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + if collection_id is not None: + _params["collectionId"] = _SERIALIZER.query("collection_id", collection_id, "str") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_receipt_request(transaction_id: str, *, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/transactions/{transactionId}/receipt" + path_format_arguments = { + "transactionId": _SERIALIZER.url("transaction_id", transaction_id, "str"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_transaction_status_request(transaction_id: str, *, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/transactions/{transactionId}/status" + path_format_arguments = { + "transactionId": _SERIALIZER.url("transaction_id", transaction_id, "str"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_current_ledger_entry_request( + *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/transactions:getCurrentLedgerEntry" + + # Construct parameters + if collection_id is not None: + _params["collectionId"] = _SERIALIZER.query("collection_id", collection_id, "str") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_delete_user_request(user_id: str, *, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/users/{userId}" + path_format_arguments = { + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_get_user_request(user_id: str, *, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/users/{userId}" + path_format_arguments = { + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_create_or_update_user_request(user_id: str, *, api_version: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type = kwargs.pop("content_type", _headers.pop("content-type", None)) # type: Optional[str] + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/app/users/{userId}" + path_format_arguments = { + "userId": _SERIALIZER.url("user_id", user_id, "str"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str", min_length=1) + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +class ConfidentialLedgerServiceOperationsMixin(MixinABC): + @distributed_trace + def list_collections(self, *, api_version: str, **kwargs: Any) -> List[_models.CollectionModel]: + """Retrieves a list of collection ids present in the Confidential Ledger. + + Collection ids are user-created collections of ledger entries. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: list of CollectionModel + :rtype: list[~azure.security.confidentialledger.models.CollectionModel] + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[List[_models.CollectionModel]] + + request = build_list_collections_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace + def get_enclave_quotes( # pylint: disable=inconsistent-return-statements + self, *, api_version: str, **kwargs: Any + ) -> None: + """Gets quotes for all nodes of the Confidential Ledger. + + A quote is an SGX enclave measurement that can be used to verify the validity of a node and its + enclave. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_get_enclave_quotes_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def get_constitution( # pylint: disable=inconsistent-return-statements + self, *, api_version: str, **kwargs: Any + ) -> None: + """Gets the constitution used for governance. + + The constitution is a script that assesses and applies proposals from consortium members. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_get_constitution_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def get_consortium_members( # pylint: disable=inconsistent-return-statements + self, *, api_version: str, **kwargs: Any + ) -> None: + """Gets the consortium members. + + Consortium members can manage the Confidential Ledger. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_get_consortium_members_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def list_ledger_entries(self, *, api_version: str, **kwargs: Any) -> Iterable["_models.LedgerEntry"]: + """Gets ledger entries from a collection corresponding to a range. + + A collection id may optionally be specified. Only entries in the specified (or default) + collection will be returned. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: An iterator like instance of LedgerEntry. The LedgerEntry is compatible with + MutableMapping + :rtype: ~azure.core.paging.ItemPaged[~azure.security.confidentialledger.models.LedgerEntry] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models._models.PagedLedgerEntries] + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + request = build_list_ledger_entries_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + else: + request = HttpRequest("GET", next_link) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + return request + + def extract_data(pipeline_response): + deserialized = _deserialize(_models._models.PagedLedgerEntries, pipeline_response) + list_of_elem = deserialized.entries + if cls: + list_of_elem = cls(list_of_elem) + return deserialized.next_link or None, iter(list_of_elem) + + def get_next(next_link=None): + request = prepare_request(next_link) + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @overload + def create_ledger_entry( # pylint: disable=inconsistent-return-statements + self, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON], + *, + api_version: str, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Writes a ledger entry. + + A collection id may optionally be specified. + + :param body: Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_ledger_entry( # pylint: disable=inconsistent-return-statements + self, + body: IO, + *, + api_version: str, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Writes a ledger entry. + + A collection id may optionally be specified. + + :param body: Required. + :type body: IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_ledger_entry( # pylint: disable=inconsistent-return-statements + self, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON, IO], + *, + api_version: str, + collection_id: Optional[str] = None, + **kwargs: Any + ) -> None: + """Writes a ledger entry. + + A collection id may optionally be specified. + + :param body: Is either a model type or a IO type. Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON or + IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default + value is None. + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[None] + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _content = json.dumps(body, cls=AzureJSONEncoder) + + request = build_create_ledger_entry_request( + api_version=api_version, + collection_id=collection_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + response_headers = {} + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + + if cls: + return cls(pipeline_response, None, response_headers) + + @distributed_trace + def get_ledger_entry( + self, transaction_id: str, *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any + ) -> _models.LedgerEntry: + """Gets the ledger entry at the specified transaction id. A collection id may optionally be + specified to indicate the collection from which to fetch the value. + + Get a LedgerEntry. + + :param transaction_id: Required. + :type transaction_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :return: LedgerEntry. The LedgerEntry is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.LedgerEntry + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.LedgerEntry] + + request = build_get_ledger_entry_request( + transaction_id=transaction_id, + api_version=api_version, + collection_id=collection_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.LedgerEntry, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace + def get_receipt(self, transaction_id: str, *, api_version: str, **kwargs: Any) -> _models.TransactionReceipt: + """Gets a receipt certifying ledger contents at a particular transaction id. + + Runs a custom action on LedgerEntry. + + :param transaction_id: Required. + :type transaction_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: TransactionReceipt. The TransactionReceipt is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.TransactionReceipt + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.TransactionReceipt] + + request = build_get_receipt_request( + transaction_id=transaction_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.TransactionReceipt, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace + def get_transaction_status( + self, transaction_id: str, *, api_version: str, **kwargs: Any + ) -> _models.TransactionStatus: + """Gets a receipt certifying ledger contents at a particular transaction id. + + Runs a custom action on LedgerEntry. + + :param transaction_id: Required. + :type transaction_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: TransactionStatus. The TransactionStatus is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.TransactionStatus + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.TransactionStatus] + + request = build_get_transaction_status_request( + transaction_id=transaction_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.TransactionStatus, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace + def get_current_ledger_entry( + self, *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any + ) -> _models.LedgerEntry: + """Gets the current value available in the ledger. + + Runs a custom action on LedgerEntry. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :return: LedgerEntry. The LedgerEntry is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.LedgerEntry + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.LedgerEntry] + + request = build_get_current_ledger_entry_request( + api_version=api_version, + collection_id=collection_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.LedgerEntry, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace + def delete_user( # pylint: disable=inconsistent-return-statements + self, user_id: str, *, api_version: str, **kwargs: Any + ) -> None: + """Deletes a user from the Confidential Ledger. + + Delete a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_delete_user_request( + user_id=user_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def get_user(self, user_id: str, *, api_version: str, **kwargs: Any) -> _models.LedgerUser: + """Gets a user. + + Get a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: LedgerUser. The LedgerUser is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.LedgerUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.LedgerUser] + + request = build_get_user_request( + user_id=user_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.LedgerUser, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @overload + def create_or_update_user( + self, + user_id: str, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON], + *, + api_version: str, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]: + """Adds a user or updates a user's fields. + + Creates or updates a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :param body: Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: ResourceOkResponse or ResourceCreatedResponse. The ResourceOkResponse is compatible + with MutableMapping + :rtype: ~azure.security.confidentialledger.models.ResourceOkResponse or + ~azure.security.confidentialledger.models.ResourceCreatedResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_or_update_user( + self, + user_id: str, + body: IO, + *, + api_version: str, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]: + """Adds a user or updates a user's fields. + + Creates or updates a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :param body: Required. + :type body: IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: ResourceOkResponse or ResourceCreatedResponse. The ResourceOkResponse is compatible + with MutableMapping + :rtype: ~azure.security.confidentialledger.models.ResourceOkResponse or + ~azure.security.confidentialledger.models.ResourceCreatedResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_or_update_user( + self, + user_id: str, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON, IO], + *, + api_version: str, + **kwargs: Any + ) -> Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]: + """Adds a user or updates a user's fields. + + Creates or updates a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :param body: Is either a model type or a IO type. Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON or + IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword content_type: Default value is None. + :paramtype content_type: str + :return: ResourceOkResponse or ResourceCreatedResponse. The ResourceOkResponse is compatible + with MutableMapping + :rtype: ~azure.security.confidentialledger.models.ResourceOkResponse or + ~azure.security.confidentialledger.models.ResourceCreatedResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("content-type", None)) # type: Optional[str] + cls = kwargs.pop( + "cls", None + ) # type: ClsType[Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]] + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _content = json.dumps(body, cls=AzureJSONEncoder) + + request = build_create_or_update_user_request( + user_id=user_id, + api_version=api_version, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if response.status_code == 200: + deserialized = _deserialize(_models.ResourceOkResponse, response.json()) + + if response.status_code == 201: + deserialized = _deserialize(_models.ResourceCreatedResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/_patch.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +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 + """ diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_patch.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +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 + """ diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_serialization.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_serialization.py new file mode 100644 index 000000000000..7c1dedb5133d --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_serialization.py @@ -0,0 +1,1970 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote # type: ignore +import xml.etree.ElementTree as ET + +import isodate + +from typing import Dict, Any, cast, TYPE_CHECKING + +from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +if TYPE_CHECKING: + from typing import Optional, Union, AnyStr, IO, Mapping + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data, content_type=None): + # type: (Optional[Union[AnyStr, IO]], Optional[str]) -> 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. + """ + 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) + 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: + # 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_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes, headers): + # type: (Optional[Union[AnyStr, IO]], 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" + """ + # 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 + + +try: + basestring # type: ignore + unicode_str = unicode # type: ignore +except NameError: + basestring = str # type: ignore + unicode_str = str # type: ignore + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc # type: ignore +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes=None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param 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. + """ + 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() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(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) + continue + if xml_desc.get("text", False): + serialized.text = new_attr + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) + 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) + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = unicode_str(new_attr) + serialized.append(local_node) + else: # JSON + for k in reversed(keys): + unflattened = {k: new_attr} + new_attr = unflattened + + _new_attr = new_attr + _serialized = serialized + for k in keys: + if k not in _serialized: + _serialized.update(_new_attr) + _new_attr = _new_attr[k] + _serialized = _serialized[k] + except ValueError: + continue + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise_with_traceback(SerializationError, msg, err) + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param 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 + """ + + # Just in case this is a dict + internal_data_type = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type, 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 = [ + 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) + except DeserializationError as err: + raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), err) + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param 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 + """ + 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) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param 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 + """ + 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] + data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] + if not kwargs.get("skip_quote", False): + data = [quote(str(d), safe="") for d in data] + return str(self.serialize_iter(data, internal_data_type, **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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param 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 + """ + 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: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif 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_with_traceback(SerializationError, msg.format(data, data_type), err) + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + 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 data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + 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 + + @classmethod + 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 data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + 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 attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :rtype: list, str + """ + 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: + serialized.append(None) + + 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 + + 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. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + 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: + 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 + + def serialize_object(self, attr, **kwargs): + """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 + """ + 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 unicode_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 + elif 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) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) + return result + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + 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 + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + 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, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + 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_with_traceback(SerializationError, msg, err) + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise_with_traceback(TypeError, msg, err) + + @staticmethod + def serialize_unix(attr, **kwargs): + """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 + """ + 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: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + # https://github.com/Azure/msrest-for-python/issues/197 + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + # https://github.com/Azure/msrest-for-python/issues/197 + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, 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" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +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 + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes=None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + 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. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """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. + """ + # 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(): + 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, basestring): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map + 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 + raise_with_traceback(DeserializationError, msg, err) + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + 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 deseralize. + """ + if target is None: + return None, None + + if isinstance(target, basestring): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ + + 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 deseralize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + 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 raw_data: Data to be processed. + :param 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 + """ + # 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, (basestring, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + 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) + raise DeserializationError(msg + str(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) + + def deserialize_data(self, data, data_type): + """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. + """ + 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 ["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_with_traceback(DeserializationError, msg, err) + else: + return self._deserialize(obj_type, data) + + 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. + :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] + + 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. + :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 value 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()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :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, basestring): + 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 + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """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. + :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 is empty string. + return "" + else: + # None or '', node 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) + elif isinstance(attr, basestring): + if attr.lower() in ["true", "1"]: + return True + elif 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 + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :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): + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + 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. + :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. + # https://github.com/Azure/azure-rest-api-specs/issues/141 + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + 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) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) + attr = attr + padding + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(attr) + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise_with_traceback(DeserializationError, msg, err) + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :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_with_traceback(DeserializationError, msg, err) + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :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): + 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=None, defaultday=None) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :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): + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) + 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_with_traceback(DeserializationError, msg, err) + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() + 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_with_traceback(DeserializationError, msg, err) + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) + try: + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise_with_traceback(DeserializationError, msg, err) + else: + return date_obj diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_vendor.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_vendor.py new file mode 100644 index 000000000000..3bd28975e6ec --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_vendor.py @@ -0,0 +1,37 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import ConfidentialLedgerServiceConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +def _format_url_section(template, **kwargs): + components = template.split("/") + while components: + try: + return template.format(**kwargs) + except KeyError as key: + formatted_components = template.split("/") + components = [c for c in formatted_components if "{}".format(key.args[0]) not in c] + template = "/".join(components) + + +class MixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: ConfidentialLedgerServiceConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_version.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/__init__.py new file mode 100644 index 000000000000..5a450f7abac3 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/__init__.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import ConfidentialLedgerService + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = ["ConfidentialLedgerService"] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_client.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_client.py new file mode 100644 index 000000000000..577d7a6d4f3c --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_client.py @@ -0,0 +1,78 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING + +from azure.core import AsyncPipelineClient +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import ConfidentialLedgerServiceConfiguration +from ._operations import ConfidentialLedgerServiceOperationsMixin + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class ConfidentialLedgerService( + ConfidentialLedgerServiceOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """Service client. + + :param ledger_uri: Required. + :type ledger_uri: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + """ + + def __init__(self, ledger_uri: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "{ledgerUri}" + self._config = ConfidentialLedgerServiceConfiguration(ledger_uri=ledger_uri, credential=credential, **kwargs) + self._client = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :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.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, **kwargs) + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "ConfidentialLedgerService": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_configuration.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_configuration.py new file mode 100644 index 000000000000..51a34ad0d2c9 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_configuration.py @@ -0,0 +1,59 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.configuration import Configuration +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class ConfidentialLedgerServiceConfiguration(Configuration): # pylint: disable=too-many-instance-attributes + """Configuration for ConfidentialLedgerService. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param ledger_uri: Required. + :type ledger_uri: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + """ + + def __init__(self, ledger_uri: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + super(ConfidentialLedgerServiceConfiguration, self).__init__(**kwargs) + if ledger_uri is None: + raise ValueError("Parameter 'ledger_uri' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.ledger_uri = ledger_uri + self.credential = credential + self.credential_scopes = kwargs.pop("credential_scopes", ["https://confidential-ledger.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "security-confidentialledger/{}".format(VERSION)) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/__init__.py new file mode 100644 index 000000000000..ca4191aedb72 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/__init__.py @@ -0,0 +1,19 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import ConfidentialLedgerServiceOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ConfidentialLedgerServiceOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/_operations.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/_operations.py new file mode 100644 index 000000000000..dbe98e7f8dd5 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/_operations.py @@ -0,0 +1,968 @@ +# pylint: disable=too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import json +import sys +from typing import Any, AsyncIterable, Callable, Dict, IO, List, Optional, TypeVar, Union, overload + +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.pipeline.transport import AsyncHttpResponse +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import AzureJSONEncoder, _deserialize +from ..._operations._operations import ( + build_create_ledger_entry_request, + build_create_or_update_user_request, + build_delete_user_request, + build_get_consortium_members_request, + build_get_constitution_request, + build_get_current_ledger_entry_request, + build_get_enclave_quotes_request, + build_get_ledger_entry_request, + build_get_receipt_request, + build_get_transaction_status_request, + build_get_user_request, + build_list_collections_request, + build_list_ledger_entries_request, +) +from .._vendor import MixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class ConfidentialLedgerServiceOperationsMixin(MixinABC): + @distributed_trace_async + async def list_collections(self, *, api_version: str, **kwargs: Any) -> List[_models.CollectionModel]: + """Retrieves a list of collection ids present in the Confidential Ledger. + + Collection ids are user-created collections of ledger entries. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: list of CollectionModel + :rtype: list[~azure.security.confidentialledger.models.CollectionModel] + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[List[_models.CollectionModel]] + + request = build_list_collections_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace_async + async def get_enclave_quotes( # pylint: disable=inconsistent-return-statements + self, *, api_version: str, **kwargs: Any + ) -> None: + """Gets quotes for all nodes of the Confidential Ledger. + + A quote is an SGX enclave measurement that can be used to verify the validity of a node and its + enclave. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_get_enclave_quotes_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def get_constitution( # pylint: disable=inconsistent-return-statements + self, *, api_version: str, **kwargs: Any + ) -> None: + """Gets the constitution used for governance. + + The constitution is a script that assesses and applies proposals from consortium members. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_get_constitution_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def get_consortium_members( # pylint: disable=inconsistent-return-statements + self, *, api_version: str, **kwargs: Any + ) -> None: + """Gets the consortium members. + + Consortium members can manage the Confidential Ledger. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_get_consortium_members_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def list_ledger_entries(self, *, api_version: str, **kwargs: Any) -> AsyncIterable["_models.LedgerEntry"]: + """Gets ledger entries from a collection corresponding to a range. + + A collection id may optionally be specified. Only entries in the specified (or default) + collection will be returned. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: An iterator like instance of LedgerEntry. The LedgerEntry is compatible with + MutableMapping + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.security.confidentialledger.models.LedgerEntry] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models._models.PagedLedgerEntries] + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + request = build_list_ledger_entries_request( + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + else: + request = HttpRequest("GET", next_link) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + return request + + async def extract_data(pipeline_response): + deserialized = _deserialize(_models._models.PagedLedgerEntries, pipeline_response) + list_of_elem = deserialized.entries + if cls: + list_of_elem = cls(list_of_elem) + return deserialized.next_link or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + request = prepare_request(next_link) + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @overload + async def create_ledger_entry( # pylint: disable=inconsistent-return-statements + self, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON], + *, + api_version: str, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Writes a ledger entry. + + A collection id may optionally be specified. + + :param body: Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_ledger_entry( # pylint: disable=inconsistent-return-statements + self, + body: IO, + *, + api_version: str, + collection_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Writes a ledger entry. + + A collection id may optionally be specified. + + :param body: Required. + :type body: IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_ledger_entry( # pylint: disable=inconsistent-return-statements + self, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON, IO], + *, + api_version: str, + collection_id: Optional[str] = None, + **kwargs: Any + ) -> None: + """Writes a ledger entry. + + A collection id may optionally be specified. + + :param body: Is either a model type or a IO type. Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON or + IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :keyword content_type: Body parameter Content-Type. Known values are: application/json. Default + value is None. + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[None] + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _content = json.dumps(body, cls=AzureJSONEncoder) + + request = build_create_ledger_entry_request( + api_version=api_version, + collection_id=collection_id, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + response_headers = {} + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + + if cls: + return cls(pipeline_response, None, response_headers) + + @distributed_trace_async + async def get_ledger_entry( + self, transaction_id: str, *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any + ) -> _models.LedgerEntry: + """Gets the ledger entry at the specified transaction id. A collection id may optionally be + specified to indicate the collection from which to fetch the value. + + Get a LedgerEntry. + + :param transaction_id: Required. + :type transaction_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :return: LedgerEntry. The LedgerEntry is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.LedgerEntry + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.LedgerEntry] + + request = build_get_ledger_entry_request( + transaction_id=transaction_id, + api_version=api_version, + collection_id=collection_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.LedgerEntry, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace_async + async def get_receipt(self, transaction_id: str, *, api_version: str, **kwargs: Any) -> _models.TransactionReceipt: + """Gets a receipt certifying ledger contents at a particular transaction id. + + Runs a custom action on LedgerEntry. + + :param transaction_id: Required. + :type transaction_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: TransactionReceipt. The TransactionReceipt is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.TransactionReceipt + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.TransactionReceipt] + + request = build_get_receipt_request( + transaction_id=transaction_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.TransactionReceipt, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace_async + async def get_transaction_status( + self, transaction_id: str, *, api_version: str, **kwargs: Any + ) -> _models.TransactionStatus: + """Gets a receipt certifying ledger contents at a particular transaction id. + + Runs a custom action on LedgerEntry. + + :param transaction_id: Required. + :type transaction_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: TransactionStatus. The TransactionStatus is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.TransactionStatus + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.TransactionStatus] + + request = build_get_transaction_status_request( + transaction_id=transaction_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.TransactionStatus, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace_async + async def get_current_ledger_entry( + self, *, api_version: str, collection_id: Optional[str] = None, **kwargs: Any + ) -> _models.LedgerEntry: + """Gets the current value available in the ledger. + + Runs a custom action on LedgerEntry. + + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword collection_id: The collection id. Default value is None. + :paramtype collection_id: str + :return: LedgerEntry. The LedgerEntry is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.LedgerEntry + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.LedgerEntry] + + request = build_get_current_ledger_entry_request( + api_version=api_version, + collection_id=collection_id, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.LedgerEntry, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @distributed_trace_async + async def delete_user( # pylint: disable=inconsistent-return-statements + self, user_id: str, *, api_version: str, **kwargs: Any + ) -> None: + """Deletes a user from the Confidential Ledger. + + Delete a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_delete_user_request( + user_id=user_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def get_user(self, user_id: str, *, api_version: str, **kwargs: Any) -> _models.LedgerUser: + """Gets a user. + + Get a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :return: LedgerUser. The LedgerUser is compatible with MutableMapping + :rtype: ~azure.security.confidentialledger.models.LedgerUser + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[_models.LedgerUser] + + request = build_get_user_request( + user_id=user_id, + api_version=api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + deserialized = _deserialize(_models.LedgerUser, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized + + @overload + async def create_or_update_user( + self, + user_id: str, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON], + *, + api_version: str, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]: + """Adds a user or updates a user's fields. + + Creates or updates a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :param body: Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: ResourceOkResponse or ResourceCreatedResponse. The ResourceOkResponse is compatible + with MutableMapping + :rtype: ~azure.security.confidentialledger.models.ResourceOkResponse or + ~azure.security.confidentialledger.models.ResourceCreatedResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_or_update_user( + self, + user_id: str, + body: IO, + *, + api_version: str, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]: + """Adds a user or updates a user's fields. + + Creates or updates a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :param body: Required. + :type body: IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: ResourceOkResponse or ResourceCreatedResponse. The ResourceOkResponse is compatible + with MutableMapping + :rtype: ~azure.security.confidentialledger.models.ResourceOkResponse or + ~azure.security.confidentialledger.models.ResourceCreatedResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_or_update_user( + self, + user_id: str, + body: Union[_models.ConfidentialLedgerCreateLedgerEntryRequest, JSON, IO], + *, + api_version: str, + **kwargs: Any + ) -> Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]: + """Adds a user or updates a user's fields. + + Creates or updates a LedgerUser. + + :param user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :type user_id: str + :param body: Is either a model type or a IO type. Required. + :type body: + ~azure.security.confidentialledger.models.ConfidentialLedgerCreateLedgerEntryRequest or JSON or + IO + :keyword api_version: The API version to use for this operation. Required. + :paramtype api_version: str + :keyword content_type: Default value is None. + :paramtype content_type: str + :return: ResourceOkResponse or ResourceCreatedResponse. The ResourceOkResponse is compatible + with MutableMapping + :rtype: ~azure.security.confidentialledger.models.ResourceOkResponse or + ~azure.security.confidentialledger.models.ResourceCreatedResponse + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("content-type", None)) # type: Optional[str] + cls = kwargs.pop( + "cls", None + ) # type: ClsType[Union[_models.ResourceOkResponse, _models.ResourceCreatedResponse]] + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _content = json.dumps(body, cls=AzureJSONEncoder) + + request = build_create_or_update_user_request( + user_id=user_id, + api_version=api_version, + content_type=content_type, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "ledgerUri": self._serialize.url("self._config.ledger_uri", self._config.ledger_uri, "str"), + } + request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _deserialize(_models.ErrorResponse, response.json()) + raise HttpResponseError(response=response, model=error) + + if response.status_code == 200: + deserialized = _deserialize(_models.ResourceOkResponse, response.json()) + + if response.status_code == 201: + deserialized = _deserialize(_models.ResourceCreatedResponse, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) + + return deserialized diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/_patch.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +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 + """ diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_patch.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +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 + """ diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_vendor.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_vendor.py new file mode 100644 index 000000000000..447a3543ee8b --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/aio/_vendor.py @@ -0,0 +1,26 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import ConfidentialLedgerServiceConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class MixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: ConfidentialLedgerServiceConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/__init__.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/__init__.py new file mode 100644 index 000000000000..da6ba7d4f736 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/__init__.py @@ -0,0 +1,47 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import CollectionModel +from ._models import ConfidentialLedgerCreateLedgerEntryRequest +from ._models import Error +from ._models import ErrorResponse +from ._models import InnerError +from ._models import LedgerEntry +from ._models import LedgerUser +from ._models import ReceiptContents +from ._models import ResourceCreatedResponse +from ._models import ResourceOkResponse +from ._models import TransactionReceipt +from ._models import TransactionStatus + +from ._enums import LedgerQueryState +from ._enums import LedgerUserRole +from ._enums import TransactionState +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "CollectionModel", + "ConfidentialLedgerCreateLedgerEntryRequest", + "Error", + "ErrorResponse", + "InnerError", + "LedgerEntry", + "LedgerUser", + "ReceiptContents", + "ResourceCreatedResponse", + "ResourceOkResponse", + "TransactionReceipt", + "TransactionStatus", + "LedgerQueryState", + "LedgerUserRole", + "TransactionState", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_enums.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_enums.py new file mode 100644 index 000000000000..8aa449509b7a --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_enums.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class LedgerQueryState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """LedgerQueryState.""" + + LOADING = "Loading" + READY = "Ready" + + +class LedgerUserRole(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """LedgerUserRole.""" + + ADMINISTRATOR = "Administrator" + CONTRIBUTOR = "Contributor" + READER = "Reader" + + +class TransactionState(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """TransactionState.""" + + COMMITTED = "Committed" + PENDING = "Pending" diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_models.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_models.py new file mode 100644 index 000000000000..1964e1fcfea7 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_models.py @@ -0,0 +1,476 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import sys +from typing import Any, List, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object + + +class CollectionModel(_model_base.Model): + """Identifier for collections. + + All required parameters must be populated in order to send to Azure. + + :ivar collection_id: Required. + :vartype collection_id: str + """ + + collection_id: str = rest_field(name="collectionId") + """Required. """ + + @overload + def __init__( + self, + *, + collection_id: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class ConfidentialLedgerCreateLedgerEntryRequest(_model_base.Model): + """ConfidentialLedgerCreateLedgerEntryRequest. + + All required parameters must be populated in order to send to Azure. + + :ivar contents: Contents of the ledger entry. Required. + :vartype contents: str + """ + + contents: str = rest_field() + """Contents of the ledger entry. Required. """ + + @overload + def __init__( + self, + *, + contents: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class Error(_model_base.Model): + """The error object. + + All required parameters must be populated in order to send to Azure. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + Required. + :vartype details: list[~azure.security.confidentialledger.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.security.confidentialledger.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required. """ + message: str = rest_field() + """A human-readable representation of the error. Required. """ + target: Optional[str] = rest_field() + """The target of the error. """ + details: List["_models.Error"] = rest_field() + """An array of details about specific errors that led to this reported error. Required. """ + innererror: Optional["_models.InnerError"] = rest_field() + """An object containing more specific information than the current object about the error. """ + + @overload + def __init__( + self, + *, + code: str, + message: str, + details: List["_models.Error"], + target: Optional[str] = None, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class ErrorResponse(_model_base.Model): + """A response containing error details. + + All required parameters must be populated in order to send to Azure. + + :ivar error: The error object. Required. + :vartype error: ~azure.security.confidentialledger.models.Error + """ + + error: "_models.Error" = rest_field() + """The error object. Required. """ + + @overload + def __init__( + self, + *, + error: "_models.Error", + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class InnerError(_model_base.Model): + """An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + + All required parameters must be populated in order to send to Azure. + + :ivar code: One of a server-defined set of error codes. Required. + :vartype code: str + :ivar innererror: Inner error. + :vartype innererror: ~azure.security.confidentialledger.models.InnerError + """ + + code: str = rest_field() + """One of a server-defined set of error codes. Required. """ + innererror: Optional["_models.InnerError"] = rest_field() + """Inner error. """ + + @overload + def __init__( + self, + *, + code: str, + innererror: Optional["_models.InnerError"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class LedgerEntry(_model_base.Model): + """LedgerEntry. + + Variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to Azure. + + :ivar contents: Contents of the ledger entry. Required. + :vartype contents: str + :ivar collection_id: Required. + :vartype collection_id: str + :ivar transaction_id: Required. + :vartype transaction_id: str + """ + + contents: str = rest_field() + """Contents of the ledger entry. Required. """ + collection_id: str = rest_field(name="collectionId", readonly=True) + """Required. """ + transaction_id: str = rest_field(name="transactionId", readonly=True) + """Required. """ + + @overload + def __init__( + self, + *, + contents: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class LedgerUser(_model_base.Model): + """LedgerUser. + + All required parameters must be populated in order to send to Azure. + + :ivar user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :vartype user_id: str + :ivar assigned_role: The user's assigned role. Required. Known values are: "Administrator", + "Contributor", and "Reader". + :vartype assigned_role: str or ~azure.security.confidentialledger.models.LedgerUserRole + """ + + user_id: str = rest_field(name="userId") + """The user id, either an AAD object ID or certificate fingerprint. Required. """ + assigned_role: Union[str, "_models.LedgerUserRole"] = rest_field(name="assignedRole") + """The user's assigned role. Required. Known values are: \"Administrator\", \"Contributor\", and \"Reader\".""" + + @overload + def __init__( + self, + *, + user_id: str, + assigned_role: Union[str, "_models.LedgerUserRole"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class PagedLedgerEntries(_model_base.Model): + """Paginated ledger entries returned in response to a query. + + All required parameters must be populated in order to send to Azure. + + :ivar entries: Array of ledger entries. Required. + :vartype entries: list[~azure.security.confidentialledger.models.LedgerEntry] + :ivar state: State of the ledger query. Required. Known values are: "Loading" and "Ready". + :vartype state: str or ~azure.security.confidentialledger.models.LedgerQueryState + :ivar next_link: Path from which to retrieve the next page of results. + :vartype next_link: str + """ + + entries: List["_models.LedgerEntry"] = rest_field() + """Array of ledger entries. Required. """ + state: Union[str, "_models.LedgerQueryState"] = rest_field() + """State of the ledger query. Required. Known values are: \"Loading\" and \"Ready\".""" + next_link: Optional[str] = rest_field(name="nextLink") + """Path from which to retrieve the next page of results. """ + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class ReceiptContents(_model_base.Model): + """ReceiptContents.""" + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class ResourceCreatedResponse(_model_base.Model): + """A resource was successfully created. + + All required parameters must be populated in order to send to Azure. + + :ivar user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :vartype user_id: str + :ivar assigned_role: The user's assigned role. Required. Known values are: "Administrator", + "Contributor", and "Reader". + :vartype assigned_role: str or ~azure.security.confidentialledger.models.LedgerUserRole + """ + + user_id: str = rest_field(name="userId") + """The user id, either an AAD object ID or certificate fingerprint. Required. """ + assigned_role: Union[str, "_models.LedgerUserRole"] = rest_field(name="assignedRole") + """The user's assigned role. Required. Known values are: \"Administrator\", \"Contributor\", and \"Reader\".""" + + @overload + def __init__( + self, + *, + user_id: str, + assigned_role: Union[str, "_models.LedgerUserRole"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class ResourceOkResponse(_model_base.Model): + """ResourceOkResponse. + + All required parameters must be populated in order to send to Azure. + + :ivar user_id: The user id, either an AAD object ID or certificate fingerprint. Required. + :vartype user_id: str + :ivar assigned_role: The user's assigned role. Required. Known values are: "Administrator", + "Contributor", and "Reader". + :vartype assigned_role: str or ~azure.security.confidentialledger.models.LedgerUserRole + """ + + user_id: str = rest_field(name="userId") + """The user id, either an AAD object ID or certificate fingerprint. Required. """ + assigned_role: Union[str, "_models.LedgerUserRole"] = rest_field(name="assignedRole") + """The user's assigned role. Required. Known values are: \"Administrator\", \"Contributor\", and \"Reader\".""" + + @overload + def __init__( + self, + *, + user_id: str, + assigned_role: Union[str, "_models.LedgerUserRole"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class TransactionReceipt(_model_base.Model): + """A receipt certifying the transaction at the specified id. + + All required parameters must be populated in order to send to Azure. + + :ivar receipt: Required. + :vartype receipt: ~azure.security.confidentialledger.models.ReceiptContents + :ivar state: Required. Known values are: "Loading" and "Ready". + :vartype state: str or ~azure.security.confidentialledger.models.LedgerQueryState + :ivar transaction_id: Required. + :vartype transaction_id: str + """ + + receipt: "_models.ReceiptContents" = rest_field() + """Required. """ + state: Union[str, "_models.LedgerQueryState"] = rest_field() + """Required. Known values are: \"Loading\" and \"Ready\".""" + transaction_id: str = rest_field(name="transactionId") + """Required. """ + + @overload + def __init__( + self, + *, + receipt: "_models.ReceiptContents", + state: Union[str, "_models.LedgerQueryState"], + transaction_id: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class TransactionStatus(_model_base.Model): + """Response returned to a query for the transaction status. + + All required parameters must be populated in order to send to Azure. + + :ivar state: Required. Known values are: "Committed" and "Pending". + :vartype state: str or ~azure.security.confidentialledger.models.TransactionState + :ivar transaction_id: Required. + :vartype transaction_id: str + """ + + state: Union[str, "_models.TransactionState"] = rest_field() + """Required. Known values are: \"Committed\" and \"Pending\".""" + transaction_id: str = rest_field(name="transactionId") + """Required. """ + + @overload + def __init__( + self, + *, + state: Union[str, "_models.TransactionState"], + transaction_id: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + ... + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_patch.py b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +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 + """ diff --git a/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/py.typed b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/azure/security/confidentialledger/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/confidentialledger/azure-security-confidentialledger/setup.py b/sdk/confidentialledger/azure-security-confidentialledger/setup.py new file mode 100644 index 000000000000..3e01b61de0f0 --- /dev/null +++ b/sdk/confidentialledger/azure-security-confidentialledger/setup.py @@ -0,0 +1,30 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-security-confidentialledger" +version = "1.0.0b1" +setup( + name=PACKAGE_NAME, + version=version, + description="azure-security-confidentialledger", + author_email="", + url="", + keywords="azure, azure sdk", + packages=find_packages(), + include_package_data=True, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.24.0", + ], + long_description="""\ + Service client. + """, +) diff --git a/tools/azure-sdk-tools/packaging_tools/generate_utils.py b/tools/azure-sdk-tools/packaging_tools/generate_utils.py index 987fed04a3dc..72d283da5347 100644 --- a/tools/azure-sdk-tools/packaging_tools/generate_utils.py +++ b/tools/azure-sdk-tools/packaging_tools/generate_utils.py @@ -3,6 +3,7 @@ import logging import os import re +import time from azure_devtools.ci_tools.git_tools import get_add_diff_file_list from pathlib import Path @@ -354,6 +355,8 @@ def gen_cadl(cadl_relative_path: str, spec_folder: str) -> Dict[str, Any]: output_path = Path(os.getcwd()) / project_yaml["emitters"][cadl_python]["sdk-folder"] if not output_path.exists(): os.makedirs(output_path) + time.sleep(10) + project_yaml["emitters"][cadl_python].pop("sdk-folder") project_yaml["emitters"][cadl_python]["output-path"] = str(output_path) @@ -376,4 +379,4 @@ def gen_cadl(cadl_relative_path: str, spec_folder: str) -> Dict[str, Any]: # return to original folder os.chdir(origin_path) - return npm_package_verstion \ No newline at end of file + return npm_package_verstion