[AutoPR azure-contoso-widgetmanager]-generated-from-SDK Generation - Python-6387262#47301
Open
azure-sdk wants to merge 1 commit into
Open
[AutoPR azure-contoso-widgetmanager]-generated-from-SDK Generation - Python-6387262#47301azure-sdk wants to merge 1 commit into
azure-sdk wants to merge 1 commit into
Conversation
…ager/tspconfig.yaml', API Version: 2022-11-01-preview, SDK Release Type: beta, and CommitSHA: '532545feb236d55064e4fa922f3fa38517857ba8' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6387262 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
azure-sdk
requested review from
danieljurek,
lirenhe,
lmazuel,
msyyc and
scbedd
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This AutoPR introduces a new data-plane Python package, azure-contoso-widgetmanager, generated from the Contoso WidgetManager TypeSpec (API version 2022-11-01-preview). It adds the package’s initial client implementation (sync + async), models/operations, along with generated samples/tests and pipeline wiring for CI.
Changes:
- Added a new
sdk/contosowidgetmanagerservice directory with an SDK package (azure-contoso-widgetmanager) including sync/async clients, operations, and models. - Added generated samples and generated tests scaffolding for Widgets operations.
- Added CI pipeline configuration and TypeSpec source location metadata for regeneration traceability.
Reviewed changes
Copilot reviewed 45 out of 45 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/contosowidgetmanager/ci.yml | Adds CI pipeline definition for the Contoso WidgetManager service directory. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/tsp-location.yaml | Records TypeSpec source repo/path/commit used for generation. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/README.md | Introduces package README with getting-started guidance and examples. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/pyproject.toml | Defines package metadata, dependencies, and setuptools configuration. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/MANIFEST.in | Ensures required files (md, license, py.typed, etc.) are included in the sdist. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/LICENSE | Adds MIT license file for the package. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/dev_requirements.txt | Defines local dev/test requirements for the package. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/CHANGELOG.md | Adds initial changelog entry for version 1.0.0b1. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/_metadata.json | Captures generation metadata (apiVersion, spec commit, emitter version, etc.). |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/apiview-properties.json | Adds APIView cross-language mapping metadata for the generated API surface. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_list_widgets_sample.py | Generated sync sample for list_widgets. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_sample.py | Generated sync sample for get_widget. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_get_widget_operation_status_sample.py | Generated sync sample for operation-status retrieval. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_delete_widget_sample.py | Generated sync sample for delete LRO. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_samples/widgets_create_or_update_widget_sample.py | Generated sync sample for create/update LRO. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/conftest.py | Test proxy + sanitizer setup for recordings. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/testpreparer.py | Test base and PowerShell preparer wiring for sync tests. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/testpreparer_async.py | Test base wiring for async tests. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations.py | Generated sync test skeletons for Widgets operations. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/generated_tests/test_widget_manager_widgets_operations_async.py | Generated async test skeletons for Widgets operations. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/init.py | Sets up the azure namespace package. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/init.py | Sets up the azure.contoso namespace package. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/py.typed | Marks the package as PEP 561 typed. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/init.py | Exposes the sync WidgetManagerClient and __version__. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_version.py | Defines the package version constant. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_client.py | Implements the sync client and send_request. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_configuration.py | Defines sync client configuration and auth policies. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_patch.py | Customization entrypoint for package-level patches. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_utils/init.py | Package init for shared serialization/model utilities. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_utils/model_base.py | Generated model base + (de)serialization helpers used by models. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/_utils/serialization.py | Generated serializer/deserializer implementation used by operations. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/models/init.py | Re-exports models/enums and applies model-level patch hook. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/models/_models.py | Defines generated model types used by the SDK. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/models/_enums.py | Defines generated enums (e.g., OperationState). |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/models/_patch.py | Customization entrypoint for model-level patches. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/operations/init.py | Re-exports operation groups and applies operations-level patch hook. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/operations/_operations.py | Implements sync operations group + request builders and LRO/paging logic. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/operations/_patch.py | Customization entrypoint for operations-level patches. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/init.py | Exposes the async WidgetManagerClient and applies async patch hook. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/_client.py | Implements the async client and send_request. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/_configuration.py | Defines async client configuration and async auth policies. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/_patch.py | Customization entrypoint for async package-level patches. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/operations/init.py | Re-exports async operation groups and applies async operations patch hook. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/operations/_operations.py | Implements async operations group + async LRO/paging logic. |
| sdk/contosowidgetmanager/azure-contoso-widgetmanager/azure/contoso/widgetmanager/aio/operations/_patch.py | Customization entrypoint for async operations-level patches. |
| python -m pip install azure-contoso-widgetmanager | ||
| ``` | ||
|
|
||
| #### Prequisites |
Comment on lines
+50
to
+55
| >>> client = WidgetManagerClient(endpoint='<endpoint>', credential=DefaultAzureCredential()) | ||
| >>> try: | ||
| <!-- write test code here --> | ||
| except HttpResponseError as e: | ||
| print('service responds error: {}'.format(e.response.json())) | ||
|
|
Comment on lines
+33
to
+36
| response = client.widgets.get_widget_operation_status( | ||
| widget_name="name1", | ||
| operation_id="opreation id1", | ||
| ) |
Comment on lines
+1
to
+2
| # Azure Contoso Widgetmanager client library for Python | ||
| <!-- write necessary description of service --> |
Comment on lines
+13
to
+18
| name = "azure-contoso-widgetmanager" | ||
| authors = [ | ||
| { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, | ||
| ] | ||
| description = "Microsoft Corporation Azure Contoso Widgetmanager Client Library for Python" | ||
| license = "MIT" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Configurations: 'specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml', API Version: 2022-11-01-preview, SDK Release Type: beta, and CommitSHA: '532545feb236d55064e4fa922f3fa38517857ba8' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6387262 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. Release plan link: https://azsdk-releaseplan-dashboard-hveph5aqhhcfhtgu.westus-01.azurewebsites.net/?releaseplan=1538 Submitted by: juanospina@microsoft.com
Release Plan Details