# --------------------------------------------------------------------------
#
# 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.
#
# --------------------------------------------------------------------------
import logging
from typing import Generic, TypeVar, List, Union, Any
from azure.core.pipeline import (
AbstractContextManager,
PipelineRequest,
PipelineResponse,
PipelineContext,
)
from azure.core.pipeline.policies import HTTPPolicy, SansIOHTTPPolicy
HTTPResponseType = TypeVar("HTTPResponseType")
HTTPRequestType = TypeVar("HTTPRequestType")
HttpTransportType = TypeVar("HttpTransportType")
_LOGGER = logging.getLogger(__name__)
PoliciesType = List[Union[HTTPPolicy, SansIOHTTPPolicy]]
def _await_result(func, *args, **kwargs):
"""If func returns an awaitable, raise that this runner can't handle it."""
result = func(*args, **kwargs)
if hasattr(result, "__await__"):
raise TypeError(
"Policy {} returned awaitable object in non-async pipeline.".format(func)
)
return result
class _SansIOHTTPPolicyRunner(HTTPPolicy, Generic[HTTPRequestType, HTTPResponseType]):
"""Sync implementation of the SansIO policy.
Modifies the request and sends to the next policy in the chain.
:param policy: A SansIO policy.
:type policy: ~azure.core.pipeline.policies.SansIOHTTPPolicy
"""
def __init__(self, policy):
# type: (SansIOHTTPPolicy) -> None
super(_SansIOHTTPPolicyRunner, self).__init__()
self._policy = policy
def send(self, request):
# type: (PipelineRequest) -> PipelineResponse
"""Modifies the request and sends to the next policy in the chain.
:param request: The PipelineRequest object.
:type request: ~azure.core.pipeline.PipelineRequest
:return: The PipelineResponse object.
:rtype: ~azure.core.pipeline.PipelineResponse
"""
_await_result(self._policy.on_request, request)
try:
response = self.next.send(request)
except Exception: # pylint: disable=broad-except
if not _await_result(self._policy.on_exception, request):
raise
else:
_await_result(self._policy.on_response, request, response)
return response
class _TransportRunner(HTTPPolicy):
"""Transport runner.
Uses specified HTTP transport type to send request and returns response.
:param sender: The Http Transport instance.
"""
def __init__(self, sender):
# type: (HttpTransportType) -> None
super(_TransportRunner, self).__init__()
self._sender = sender
def send(self, request):
"""HTTP transport send method.
:param request: The PipelineRequest object.
:type request: ~azure.core.pipeline.PipelineRequest
:return: The PipelineResponse object.
:rtype: ~azure.core.pipeline.PipelineResponse
"""
return PipelineResponse(
request.http_request,
self._sender.send(request.http_request, **request.context.options),
context=request.context,
)
[docs]class Pipeline(AbstractContextManager, Generic[HTTPRequestType, HTTPResponseType]):
"""A pipeline implementation.
This is implemented as a context manager, that will activate the context
of the HTTP sender. The transport is the last node in the pipeline.
:param transport: The Http Transport instance
:param list policies: List of configured policies.
.. admonition:: Example:
.. literalinclude:: ../samples/test_example_sync.py
:start-after: [START build_pipeline]
:end-before: [END build_pipeline]
:language: python
:dedent: 4
:caption: Builds the pipeline for synchronous transport.
"""
def __init__(self, transport, policies=None):
# type: (HttpTransportType, PoliciesType) -> None
self._impl_policies = [] # type: List[HTTPPolicy]
self._transport = transport # type: ignore
for policy in policies or []:
if isinstance(policy, SansIOHTTPPolicy):
self._impl_policies.append(_SansIOHTTPPolicyRunner(policy))
elif policy:
self._impl_policies.append(policy)
for index in range(len(self._impl_policies) - 1):
self._impl_policies[index].next = self._impl_policies[index + 1]
if self._impl_policies:
self._impl_policies[-1].next = _TransportRunner(self._transport)
def __enter__(self):
# type: () -> Pipeline
self._transport.__enter__() # type: ignore
return self
def __exit__(self, *exc_details): # pylint: disable=arguments-differ
self._transport.__exit__(*exc_details)
@staticmethod
def _prepare_multipart_mixed_request(request):
# type: (HTTPRequestType) -> None
"""Will execute the multipart policies.
Does nothing if "set_multipart_mixed" was never called.
"""
multipart_mixed_info = request.multipart_mixed_info # type: ignore
if not multipart_mixed_info:
return
requests = multipart_mixed_info[0] # type: List[HTTPRequestType]
policies = multipart_mixed_info[1] # type: List[SansIOHTTPPolicy]
# Apply on_requests concurrently to all requests
import concurrent.futures
def prepare_requests(req):
context = PipelineContext(None)
pipeline_request = PipelineRequest(req, context)
for policy in policies:
_await_result(policy.on_request, pipeline_request)
with concurrent.futures.ThreadPoolExecutor() as executor:
# List comprehension to raise exceptions if happened
[ # pylint: disable=expression-not-assigned
_ for _ in executor.map(prepare_requests, requests)
]
[docs] def run(self, request, **kwargs):
# type: (HTTPRequestType, Any) -> PipelineResponse
"""Runs the HTTP Request through the chained policies.
:param request: The HTTP request object.
:type request: ~azure.core.pipeline.transport.HttpRequest
:return: The PipelineResponse object
:rtype: ~azure.core.pipeline.PipelineResponse
"""
self._prepare_multipart_mixed_request(request)
request.prepare_multipart_body() # type: ignore
context = PipelineContext(self._transport, **kwargs)
pipeline_request = PipelineRequest(
request, context
) # type: PipelineRequest[HTTPRequestType]
first_node = (
self._impl_policies[0]
if self._impl_policies
else _TransportRunner(self._transport)
)
return first_node.send(pipeline_request) # type: ignore