From d4edabd298ea81c15bc4e015595cc6962192f019 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Wed, 5 Aug 2020 11:24:25 -0400 Subject: [PATCH] rename ApiVersion -> TextAnalyticsApiVersion, clean up code --- .../azure-ai-textanalytics/README.md | 2 +- .../azure/ai/textanalytics/__init__.py | 4 +- .../azure/ai/textanalytics/_base_client.py | 4 +- .../azure/ai/textanalytics/_multiapi.py | 42 ------------------- .../textanalytics/_text_analytics_client.py | 2 +- .../textanalytics/aio/_base_client_async.py | 4 +- .../aio/_text_analytics_client_async.py | 2 +- ...yze_sentiment_with_opinion_mining_async.py | 1 - .../sample_recognize_pii_entities_async.py | 1 - ...e_analyze_sentiment_with_opinion_mining.py | 2 +- .../samples/sample_recognize_pii_entities.py | 2 +- .../tests/test_analyze_sentiment.py | 4 +- .../tests/test_analyze_sentiment_async.py | 4 +- .../tests/test_multiapi.py | 6 +-- .../tests/test_multiapi_async.py | 6 +-- .../test_recognize_pii_entities_async.py | 1 - 16 files changed, 21 insertions(+), 66 deletions(-) delete mode 100644 sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_multiapi.py diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md index e516f007bde5..f81459900466 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/README.md +++ b/sdk/textanalytics/azure-ai-textanalytics/README.md @@ -304,7 +304,7 @@ Social Security Numbers, bank account information, credit card numbers, and more ```python from azure.core.credentials import AzureKeyCredential -from azure.ai.textanalytics import TextAnalyticsClient, ApiVersion +from azure.ai.textanalytics import TextAnalyticsClient credential = AzureKeyCredential("") endpoint="https://.api.cognitive.microsoft.com/" diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/__init__.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/__init__.py index bde288eb0cf6..476f9842a066 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/__init__.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/__init__.py @@ -6,7 +6,7 @@ from ._text_analytics_client import TextAnalyticsClient from ._version import VERSION -from ._base_client import ApiVersion +from ._base_client import TextAnalyticsApiVersion from ._models import ( DetectLanguageInput, TextDocumentInput, @@ -34,7 +34,7 @@ ) __all__ = [ - 'ApiVersion', + 'TextAnalyticsApiVersion', 'TextAnalyticsClient', 'DetectLanguageInput', 'TextDocumentInput', diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_base_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_base_client.py index 7f12d85dac71..c269772d87ff 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_base_client.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_base_client.py @@ -10,7 +10,7 @@ from ._policies import TextAnalyticsResponseHookPolicy from ._user_agent import USER_AGENT -class ApiVersion(str, Enum): +class TextAnalyticsApiVersion(str, Enum): """Text Analytics API versions supported by this package""" #: this is the default version @@ -36,7 +36,7 @@ def __init__(self, endpoint, credential, **kwargs): self._client = _TextAnalyticsClient( endpoint=endpoint, credential=credential, - api_version=kwargs.pop("api_version", ApiVersion.V3_1_PREVIEW_1), + api_version=kwargs.pop("api_version", TextAnalyticsApiVersion.V3_1_PREVIEW_1), sdk_moniker=USER_AGENT, authentication_policy=_authentication_policy(credential), custom_hook_policy=TextAnalyticsResponseHookPolicy(**kwargs), diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_multiapi.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_multiapi.py deleted file mode 100644 index 3d29a0c06583..000000000000 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_multiapi.py +++ /dev/null @@ -1,42 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ -from enum import Enum -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from typing import Union - - -class ApiVersion(str, Enum): - """Text Analytics API versions supported by this package""" - - #: this is the default version - V3_1_PREVIEW_1 = "v3.1-preview.1" - V3_0 = "v3.0" - - -def load_generated_api(api_version, aio=False): - try: - # api_version could be a string; map it to an instance of ApiVersion - # (this is a no-op if it's already an instance of ApiVersion) - api_version = ApiVersion(api_version) - except ValueError: - # api_version is unknown to ApiVersion - raise NotImplementedError( - "This package doesn't support API version '{}'. ".format(api_version) - + "Supported versions: {}".format(", ".join(v.value for v in ApiVersion)) - ) - - if api_version == ApiVersion.V3_1_PREVIEW_1: - if aio: - from ._generated.v3_1_preview_1.aio import TextAnalyticsClient - else: - from ._generated.v3_1_preview_1 import TextAnalyticsClient # type: ignore - elif api_version == ApiVersion.V3_0: - if aio: - from ._generated.v3_0.aio import TextAnalyticsClient # type: ignore - else: - from ._generated.v3_0 import TextAnalyticsClient # type: ignore - return TextAnalyticsClient diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py index 37417886a6e3..814a6531be01 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py @@ -65,7 +65,7 @@ class TextAnalyticsClient(TextAnalyticsClientBase): Defaults to "en". :keyword api_version: The API version of the service to use for requests. It defaults to the latest service version. Setting to an older version may result in reduced feature compatibility. - :paramtype api_version: str or ~azure.ai.textanalytics.ApiVersion + :paramtype api_version: str or ~azure.ai.textanalytics.TextAnalyticsApiVersion .. admonition:: Example: diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_base_client_async.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_base_client_async.py index 63f289e810ac..45c9a4d17027 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_base_client_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_base_client_async.py @@ -9,7 +9,7 @@ from .._generated.aio import TextAnalyticsClient as _TextAnalyticsClient from .._policies import TextAnalyticsResponseHookPolicy from .._user_agent import USER_AGENT -from .._base_client import ApiVersion +from .._base_client import TextAnalyticsApiVersion def _authentication_policy(credential): @@ -31,7 +31,7 @@ def __init__(self, endpoint, credential, **kwargs): self._client = _TextAnalyticsClient( endpoint=endpoint, credential=credential, - api_version=kwargs.pop("api_version", ApiVersion.V3_1_PREVIEW_1), + api_version=kwargs.pop("api_version", TextAnalyticsApiVersion.V3_1_PREVIEW_1), sdk_moniker=USER_AGENT, authentication_policy=_authentication_policy(credential), custom_hook_policy=TextAnalyticsResponseHookPolicy(**kwargs), diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py index bc47f1045701..1e1450f669ce 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py @@ -66,7 +66,7 @@ class TextAnalyticsClient(AsyncTextAnalyticsClientBase): Defaults to "en". :keyword api_version: The API version of the service to use for requests. It defaults to the latest service version. Setting to an older version may result in reduced feature compatibility. - :paramtype api_version: str or ~azure.ai.textanalytics.ApiVersion + :paramtype api_version: str or ~azure.ai.textanalytics.TextAnalyticsApiVersion .. admonition:: Example: diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_sentiment_with_opinion_mining_async.py b/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_sentiment_with_opinion_mining_async.py index df1fefb9ddca..338432cb9530 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_sentiment_with_opinion_mining_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_sentiment_with_opinion_mining_async.py @@ -34,7 +34,6 @@ class AnalyzeSentimentWithOpinionMiningSampleAsync(object): async def analyze_sentiment_with_opinion_mining(self): from azure.core.credentials import AzureKeyCredential from azure.ai.textanalytics.aio import TextAnalyticsClient - from azure.ai.textanalytics import ApiVersion endpoint = os.environ["AZURE_TEXT_ANALYTICS_ENDPOINT"] key = os.environ["AZURE_TEXT_ANALYTICS_KEY"] diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_pii_entities_async.py b/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_pii_entities_async.py index c664f8a3b152..2d5bfbdb98d9 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_pii_entities_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_pii_entities_async.py @@ -30,7 +30,6 @@ class RecognizePiiEntitiesSampleAsync(object): async def recognize_pii_entities_async(self): # [START recognize_pii_entities_async] from azure.core.credentials import AzureKeyCredential - from azure.ai.textanalytics import ApiVersion from azure.ai.textanalytics.aio import TextAnalyticsClient endpoint = os.environ["AZURE_TEXT_ANALYTICS_ENDPOINT"] diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_sentiment_with_opinion_mining.py b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_sentiment_with_opinion_mining.py index c250297c4674..1b2924134bef 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_sentiment_with_opinion_mining.py +++ b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_sentiment_with_opinion_mining.py @@ -32,7 +32,7 @@ class AnalyzeSentimentWithOpinionMiningSample(object): def sample_analyze_sentiment_with_opinion_mining(self): from azure.core.credentials import AzureKeyCredential - from azure.ai.textanalytics import TextAnalyticsClient, ApiVersion + from azure.ai.textanalytics import TextAnalyticsClient endpoint = os.environ["AZURE_TEXT_ANALYTICS_ENDPOINT"] key = os.environ["AZURE_TEXT_ANALYTICS_KEY"] diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_pii_entities.py b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_pii_entities.py index 1f909158e776..49f527763b46 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_pii_entities.py +++ b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_pii_entities.py @@ -29,7 +29,7 @@ class RecognizePiiEntitiesSample(object): def recognize_pii_entities(self): # [START recognize_pii_entities] from azure.core.credentials import AzureKeyCredential - from azure.ai.textanalytics import TextAnalyticsClient, ApiVersion + from azure.ai.textanalytics import TextAnalyticsClient endpoint = os.environ["AZURE_TEXT_ANALYTICS_ENDPOINT"] key = os.environ["AZURE_TEXT_ANALYTICS_KEY"] diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment.py index d4eeb38ad21c..01b5f41f8f2a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment.py @@ -16,7 +16,7 @@ TextAnalyticsClient, TextDocumentInput, VERSION, - ApiVersion + TextAnalyticsApiVersion ) # pre-apply the client_cls positional argument so it needn't be explicitly passed below @@ -659,7 +659,7 @@ def test_opinion_mining_no_mined_opinions(self, client): assert not document.sentences[0].mined_opinions @GlobalTextAnalyticsAccountPreparer() - @TextAnalyticsClientPreparer(client_kwargs={"api_version": ApiVersion.V3_0}) + @TextAnalyticsClientPreparer(client_kwargs={"api_version": TextAnalyticsApiVersion.V3_0}) def test_opinion_mining_v3(self, client): with pytest.raises(NotImplementedError) as excinfo: client.analyze_sentiment(["will fail"], show_opinion_mining=True) diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment_async.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment_async.py index 151623705308..d4d276461981 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_analyze_sentiment_async.py @@ -17,7 +17,7 @@ VERSION, DetectLanguageInput, TextDocumentInput, - ApiVersion + TextAnalyticsApiVersion ) from testcase import GlobalTextAnalyticsAccountPreparer @@ -675,7 +675,7 @@ async def test_opinion_mining_no_mined_opinions(self, client): assert not document.sentences[0].mined_opinions @GlobalTextAnalyticsAccountPreparer() - @TextAnalyticsClientPreparer(client_kwargs={"api_version": ApiVersion.V3_0}) + @TextAnalyticsClientPreparer(client_kwargs={"api_version": TextAnalyticsApiVersion.V3_0}) async def test_opinion_mining_v3(self, client): with pytest.raises(NotImplementedError) as excinfo: await client.analyze_sentiment(["will fail"], show_opinion_mining=True) diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi.py index bd4ec13abde5..71ce8fae6d23 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi.py @@ -5,7 +5,7 @@ # ------------------------------------ import functools from azure.core.credentials import AzureKeyCredential -from azure.ai.textanalytics import TextAnalyticsClient, ApiVersion +from azure.ai.textanalytics import TextAnalyticsClient, TextAnalyticsApiVersion from testcase import TextAnalyticsTest, GlobalTextAnalyticsAccountPreparer from testcase import TextAnalyticsClientPreparer as _TextAnalyticsClientPreparer @@ -19,11 +19,11 @@ def test_default_api_version(self, client): assert "v3.1-preview.1" in client._client._client._base_url @GlobalTextAnalyticsAccountPreparer() - @TextAnalyticsClientPreparer(client_kwargs={"api_version": ApiVersion.V3_0}) + @TextAnalyticsClientPreparer(client_kwargs={"api_version": TextAnalyticsApiVersion.V3_0}) def test_v3_0_api_version(self, client): assert "v3.0" in client._client._client._base_url @GlobalTextAnalyticsAccountPreparer() - @TextAnalyticsClientPreparer(client_kwargs={"api_version": ApiVersion.V3_1_PREVIEW_1}) + @TextAnalyticsClientPreparer(client_kwargs={"api_version": TextAnalyticsApiVersion.V3_1_PREVIEW_1}) def test_v3_1_preview_1_api_version(self, client): assert "v3.1-preview.1" in client._client._client._base_url \ No newline at end of file diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi_async.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi_async.py index 1e56ad93d590..f42a5430ffd5 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_multiapi_async.py @@ -4,7 +4,7 @@ # Licensed under the MIT License. # ------------------------------------ import functools -from azure.ai.textanalytics import ApiVersion +from azure.ai.textanalytics import TextAnalyticsApiVersion from azure.ai.textanalytics.aio import TextAnalyticsClient from testcase import TextAnalyticsTest, GlobalTextAnalyticsAccountPreparer from testcase import TextAnalyticsClientPreparer as _TextAnalyticsClientPreparer @@ -19,11 +19,11 @@ def test_default_api_version(self, client): assert "v3.1-preview.1" in client._client._client._base_url @GlobalTextAnalyticsAccountPreparer() - @TextAnalyticsClientPreparer(client_kwargs={"api_version": ApiVersion.V3_0}) + @TextAnalyticsClientPreparer(client_kwargs={"api_version": TextAnalyticsApiVersion.V3_0}) def test_v3_0_api_version(self, client): assert "v3.0" in client._client._client._base_url @GlobalTextAnalyticsAccountPreparer() - @TextAnalyticsClientPreparer(client_kwargs={"api_version": ApiVersion.V3_1_PREVIEW_1}) + @TextAnalyticsClientPreparer(client_kwargs={"api_version": TextAnalyticsApiVersion.V3_1_PREVIEW_1}) def test_v3_1_preview_1_api_version(self, client): assert "v3.1-preview.1" in client._client._client._base_url \ No newline at end of file diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_pii_entities_async.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_pii_entities_async.py index e53e57bc0488..03dda64b557c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_pii_entities_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_pii_entities_async.py @@ -17,7 +17,6 @@ from azure.ai.textanalytics import ( TextDocumentInput, VERSION, - ApiVersion ) # pre-apply the client_cls positional argument so it needn't be explicitly passed below