Refactor: Extract validation logic into shared utility function

Created azure.core._version_validation module with a shared validate_version() function to eliminate code duplication across all SDK modules. Updated all user agent files to use this centralized validation.

Co-authored-by: slister1001 <[email protected]>

Author: Copilot

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_user_agent.py

@@ -5,9 +5,9 @@
 # -------------------------------------------------------------------------
 
 from ._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 USER_AGENT = "python-appconfiguration-provider/{}".format(VERSION)

sdk/containerregistry/azure-containerregistry/azure/containerregistry/_user_agent.py

@@ -5,9 +5,9 @@
 # ------------------------------------
 
 from ._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 USER_AGENT = f"azure-containerregistry/{VERSION}"

sdk/core/azure-core/azure/core/_version_validation.py

@@ -0,0 +1,39 @@
+# --------------------------------------------------------------------------
+#
+# 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.
+#
+# --------------------------------------------------------------------------
+"""Utilities for validating SDK versions."""
+
+
+def validate_version(version):
+    """Validate that a version string is valid and not empty.
+    
+    This prevents unauthorized SDK usage by ensuring the VERSION is properly set.
+    
+    :param version: The version string to validate
+    :type version: str
+    :raises ValueError: If the version is None, empty, or contains only whitespace
+    """
+    if not version or not isinstance(version, str) or not version.strip():
+        raise ValueError("Invalid SDK version: version must be a non-empty string")

sdk/core/azure-core/azure/core/pipeline/policies/_universal.py

@@ -40,6 +40,7 @@
 
 from azure.core import __version__ as azcore_version
 from azure.core.exceptions import DecodeError
+from azure.core._version_validation import validate_version
 
 from azure.core.pipeline import PipelineRequest, PipelineResponse
 from ._base import SansIOHTTPPolicy
@@ -209,8 +210,7 @@ def __init__(self, base_user_agent: Optional[str] = None, **kwargs: Any) -> None
         application_id: Optional[str] = kwargs.pop("user_agent", None)
 
         # Validate that azcore_version is not empty or None to prevent unauthorized SDK usage
-        if not azcore_version or not isinstance(azcore_version, str) or not azcore_version.strip():
-            raise ValueError("Invalid SDK version: version must be a non-empty string")
+        validate_version(azcore_version)
 
         sdk_moniker: str = kwargs.pop("sdk_moniker", "core/{}".format(azcore_version))
 

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_user_agent.py

@@ -5,10 +5,10 @@
 from typing import Iterator
 
 from azure.ai.evaluation._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 
 class UserAgentSingleton:

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_user_agent.py

@@ -4,9 +4,9 @@
 # ------------------------------------
 
 from ._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 USER_AGENT = f"ai-formrecognizer/{VERSION}"

sdk/identity/azure-identity/azure/identity/_internal/user_agent.py

@@ -5,9 +5,9 @@
 import platform
 
 from .._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 USER_AGENT = "azsdk-python-identity/{} Python/{} ({})".format(VERSION, platform.python_version(), platform.platform())

sdk/ml/azure-ai-ml/azure/ai/ml/_user_agent.py

@@ -2,9 +2,9 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # ---------------------------------------------------------
 from azure.ai.ml._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 USER_AGENT = "{}/{}".format("azure-ai-ml", VERSION)

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_user_agent.py

@@ -4,9 +4,9 @@
 # ------------------------------------
 
 from ._version import VERSION
+from azure.core._version_validation import validate_version
 
 # Validate that VERSION is not empty or None to prevent unauthorized SDK usage
-if not VERSION or not isinstance(VERSION, str) or not VERSION.strip():
-    raise ValueError("Invalid SDK version: version must be a non-empty string")
+validate_version(VERSION)
 
 USER_AGENT = f"ai-textanalytics/{VERSION}"