[Corehttp] Add code snippets to docstrings (#33207)

Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

sdk/core/corehttp/corehttp/runtime/_pipeline_client.py

@@ -62,6 +62,15 @@ class PipelineClient(PipelineClientBase, Generic[HTTPRequestType, HTTPResponseTy
 
     :ivar pipeline: The Pipeline object associated with the client.
     :vartype pipeline: ~corehttp.runtime.pipeline.Pipeline or None
+
+    .. admonition:: Example:
+
+        .. literalinclude:: ../samples/sample_pipeline_client.py
+            :start-after: [START build_pipeline_client]
+            :end-before: [END build_pipeline_client]
+            :language: python
+            :dedent: 4
+            :caption: Builds the pipeline client.
     """
 
     def __init__(

sdk/core/corehttp/corehttp/runtime/_pipeline_client_async.py

@@ -141,6 +141,15 @@ class AsyncPipelineClient(
 
     :ivar pipeline: The Pipeline object associated with the client.
     :vartype pipeline: ~corehttp.runtime.pipeline.Pipeline or None
+
+    .. admonition:: Example:
+
+        .. literalinclude:: ../samples/sample_async_pipeline_client.py
+            :start-after: [START build_async_pipeline_client]
+            :end-before: [END build_async_pipeline_client]
+            :language: python
+            :dedent: 4
+            :caption: Builds the async pipeline client.
     """
 
     def __init__(

sdk/core/corehttp/samples/sample_async_pipeline_client.py

@@ -23,30 +23,43 @@
     SansIOHTTPPolicy,
     HeadersPolicy,
     UserAgentPolicy,
-    ContentDecodePolicy,
     AsyncRetryPolicy,
-    NetworkTraceLoggingPolicy,
 )
 
 
-async def run():
+async def sample_pipeline_client():
+    # [START build_async_pipeline_client]
+    from corehttp.runtime import AsyncPipelineClient
+    from corehttp.rest import HttpRequest, AsyncHttpResponse
+    from corehttp.runtime.policies import (
+        AsyncHTTPPolicy,
+        SansIOHTTPPolicy,
+        HeadersPolicy,
+        UserAgentPolicy,
+        AsyncRetryPolicy,
+    )
+
     policies: Iterable[Union[AsyncHTTPPolicy, SansIOHTTPPolicy]] = [
         HeadersPolicy(),
         UserAgentPolicy("myuseragent"),
-        ContentDecodePolicy(),
         AsyncRetryPolicy(),
-        NetworkTraceLoggingPolicy(),
     ]
     client: AsyncPipelineClient[HttpRequest, AsyncHttpResponse] = AsyncPipelineClient(
         "https://bing.com", policies=policies
     )
     request = HttpRequest("GET", "https://bing.com")
     async with client:
         response = await client.send_request(request)
+        # [END build_async_pipeline_client]
+
         pipeline_response = await client.pipeline.run(request)
         print(response)
         print(pipeline_response)
 
 
+async def main():
+    await sample_pipeline_client()
+
+
 if __name__ == "__main__":
-    asyncio.run(run())
+    asyncio.run(main())

sdk/core/corehttp/samples/sample_pipeline_client.py

@@ -15,28 +15,34 @@
 """
 
 from typing import Iterable, Union
-from corehttp.runtime import PipelineClient
-from corehttp.rest import HttpRequest, HttpResponse
-from corehttp.runtime.policies import (
-    HTTPPolicy,
-    SansIOHTTPPolicy,
-    HeadersPolicy,
-    UserAgentPolicy,
-    ContentDecodePolicy,
-    RetryPolicy,
-    NetworkTraceLoggingPolicy,
-)
-
-policies: Iterable[Union[HTTPPolicy, SansIOHTTPPolicy]] = [
-    HeadersPolicy(),
-    UserAgentPolicy("myuseragent"),
-    ContentDecodePolicy(),
-    RetryPolicy(),
-    NetworkTraceLoggingPolicy(),
-]
-
-client: PipelineClient[HttpRequest, HttpResponse] = PipelineClient("https://bing.com", policies=policies)
-request = HttpRequest("GET", "https://bing.com")
-response = client.send_request(request)
-pipeline_response = client.pipeline.run(request)
-print(response)
+
+
+def sample_pipeline_client():
+    # [START build_pipeline_client]
+    from corehttp.runtime import PipelineClient
+    from corehttp.rest import HttpRequest, HttpResponse
+    from corehttp.runtime.policies import (
+        HTTPPolicy,
+        SansIOHTTPPolicy,
+        HeadersPolicy,
+        UserAgentPolicy,
+        RetryPolicy,
+    )
+
+    policies: Iterable[Union[HTTPPolicy, SansIOHTTPPolicy]] = [
+        HeadersPolicy(),
+        UserAgentPolicy("myuseragent"),
+        RetryPolicy(),
+    ]
+
+    client: PipelineClient[HttpRequest, HttpResponse] = PipelineClient("https://bing.com", policies=policies)
+    request = HttpRequest("GET", "https://bing.com")
+    response = client.send_request(request)
+    # [END build_pipeline_client]
+
+    pipeline_response = client.pipeline.run(request)
+    print(response)
+
+
+if __name__ == "__main__":
+    sample_pipeline_client()