Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# --------------------------------------------------------------------------
2#
3# Copyright (c) Microsoft Corporation. All rights reserved.
4#
5# The MIT License (MIT)
6#
7# Permission is hereby granted, free of charge, to any person obtaining a copy
8# of this software and associated documentation files (the ""Software""), to
9# deal in the Software without restriction, including without limitation the
10# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11# sell copies of the Software, and to permit persons to whom the Software is
12# furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included in
15# all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23# IN THE SOFTWARE.
24#
25# --------------------------------------------------------------------------
26import abc
28from typing import Generic, TypeVar
29from .. import PipelineRequest, PipelineResponse
31AsyncHTTPResponseType = TypeVar("AsyncHTTPResponseType")
32HTTPResponseType = TypeVar("HTTPResponseType")
33HTTPRequestType = TypeVar("HTTPRequestType")
36class AsyncHTTPPolicy(abc.ABC, Generic[HTTPRequestType, AsyncHTTPResponseType]):
37 """An async HTTP policy ABC.
39 Use with an asynchronous pipeline.
40 """
42 next: "AsyncHTTPPolicy[HTTPRequestType, AsyncHTTPResponseType]"
43 """Pointer to the next policy or a transport (wrapped as a policy). Will be set at pipeline creation."""
45 @abc.abstractmethod
46 async def send(
47 self, request: PipelineRequest[HTTPRequestType]
48 ) -> PipelineResponse[HTTPRequestType, AsyncHTTPResponseType]:
49 """Abstract send method for a asynchronous pipeline. Mutates the request.
51 Context content is dependent on the HttpTransport.
53 :param request: The pipeline request object.
54 :type request: ~azure.core.pipeline.PipelineRequest
55 :return: The pipeline response object.
56 :rtype: ~azure.core.pipeline.PipelineResponse
57 """