Merge pull request #172 from p1c2u/refactor/shortcuts-refactor-and-va…

…lidators-explicit-usage

Shortcuts refactor and validators explicit usage

README.rst

@@ -90,16 +90,6 @@ By default, OpenAPI spec version is detected. To validate spec:
         ...
     OpenAPIValidationError: 'info' is a required property
     
-In order to explicitly validate a:
-
-* Swagger / OpenAPI 2.0 spec, import ``validate_v2_spec``
-* OpenAPI 3.0 spec, import ``validate_v30_spec`` 
-* OpenAPI 3.1 spec, import ``validate_v31_spec`` 
-
-instead of ``validate_spec``.
-
-You can also explicitly import ``validate_v3_spec`` which is a shortcut to the latest v3 release.
-
 Add ``spec_url`` to validate spec with relative files:
 
 .. code:: python
@@ -117,13 +107,17 @@ You can also validate spec from url:
 
 In order to explicitly validate a:
 
-* Swagger / OpenAPI 2.0 spec url, import ``validate_v2_spec_url``
-* OpenAPI 3.0 spec url, import ``validate_v30_spec_url`` 
-* OpenAPI 3.1 spec url, import ``validate_v31_spec_url`` 
+* Swagger / OpenAPI 2.0 spec, import ``openapi_v2_spec_validator``
+* OpenAPI 3.0 spec, import ``openapi_v30_spec_validator`` 
+* OpenAPI 3.1 spec, import ``openapi_v31_spec_validator`` 
+
+and pass the validator to ``validate_spec`` or ``validate_spec_url`` function:
+
+.. code:: python
 
-instead of ``validate_spec_url``.
+    validate_spec(spec_dict, validator=openapi_v31_spec_validator)
 
-You can also explicitly import ``validate_v3_spec_url`` which is a shortcut to the latest v3 release.
+You can also explicitly import ``openapi_v3_spec_validator`` which is a shortcut to the latest v3 release.
 
 If you want to iterate through validation errors:
 

openapi_spec_validator/__init__.py

@@ -1,8 +1,7 @@
 from jsonschema_spec.handlers import default_handlers
 
-from openapi_spec_validator.shortcuts import validate_spec_factory
-from openapi_spec_validator.shortcuts import validate_spec_url_factory
-from openapi_spec_validator.validation import openapi_spec_validator_proxy
+from openapi_spec_validator.shortcuts import validate_spec
+from openapi_spec_validator.shortcuts import validate_spec_url
 from openapi_spec_validator.validation import openapi_v2_spec_validator
 from openapi_spec_validator.validation import openapi_v3_spec_validator
 from openapi_spec_validator.validation import openapi_v30_spec_validator
@@ -19,31 +18,6 @@
     "openapi_v3_spec_validator",
     "openapi_v30_spec_validator",
     "openapi_v31_spec_validator",
-    "validate_v2_spec",
-    "validate_v3_spec",
-    "validate_v30_spec",
-    "validate_v31_spec",
     "validate_spec",
-    "validate_v2_spec_url",
-    "validate_v3_spec_url",
-    "validate_v30_spec_url",
-    "validate_v31_spec_url",
     "validate_spec_url",
 ]
-
-# shortcuts
-validate_v2_spec = validate_spec_factory(openapi_v2_spec_validator)
-validate_v2_spec_url = validate_spec_url_factory(openapi_v2_spec_validator)
-
-validate_v30_spec = validate_spec_factory(openapi_v30_spec_validator)
-validate_v30_spec_url = validate_spec_url_factory(openapi_v30_spec_validator)
-
-validate_v31_spec = validate_spec_factory(openapi_v31_spec_validator)
-validate_v31_spec_url = validate_spec_url_factory(openapi_v31_spec_validator)
-
-validate_spec = validate_spec_factory(openapi_spec_validator_proxy)
-validate_spec_url = validate_spec_url_factory(openapi_spec_validator_proxy)
-
-# aliases to the latest v3 version
-validate_v3_spec = validate_v31_spec
-validate_v3_spec_url = validate_v31_spec_url

openapi_spec_validator/shortcuts.py

@@ -1,28 +1,25 @@
 """OpenAPI spec validator shortcuts module."""
 from typing import Any
-from typing import Callable
 from typing import Hashable
 from typing import Mapping
 
 from jsonschema_spec.handlers import all_urls_handler
 
+from openapi_spec_validator.validation import openapi_spec_validator_proxy
 from openapi_spec_validator.validation.protocols import SupportsValidation
 
 
-def validate_spec_factory(
-    validator: SupportsValidation,
-) -> Callable[[Mapping[Hashable, Any], str], None]:
-    def validate(spec: Mapping[Hashable, Any], spec_url: str = "") -> None:
-        return validator.validate(spec, spec_url=spec_url)
+def validate_spec(
+    spec: Mapping[Hashable, Any],
+    spec_url: str = "",
+    validator: SupportsValidation = openapi_spec_validator_proxy,
+) -> None:
+    return validator.validate(spec, spec_url=spec_url)
 
-    return validate
 
-
-def validate_spec_url_factory(
-    validator: SupportsValidation,
-) -> Callable[[str], None]:
-    def validate(spec_url: str) -> None:
-        spec = all_urls_handler(spec_url)
-        return validator.validate(spec, spec_url=spec_url)
-
-    return validate
+def validate_spec_url(
+    spec_url: str,
+    validator: SupportsValidation = openapi_spec_validator_proxy,
+) -> None:
+    spec = all_urls_handler(spec_url)
+    return validator.validate(spec, spec_url=spec_url)

openapi_spec_validator/validation/proxies.py

@@ -11,7 +11,6 @@
 
 
 class DetectValidatorProxy:
-
     def __init__(self, choices: Mapping[Tuple[str, str], SpecValidator]):
         self.choices = choices
 

tests/integration/test_shortcuts.py

@@ -3,13 +3,7 @@
 from openapi_spec_validator import openapi_v2_spec_validator
 from openapi_spec_validator import openapi_v30_spec_validator
 from openapi_spec_validator import validate_spec
-from openapi_spec_validator import validate_spec_factory
 from openapi_spec_validator import validate_spec_url
-from openapi_spec_validator import validate_spec_url_factory
-from openapi_spec_validator import validate_v2_spec
-from openapi_spec_validator import validate_v2_spec_url
-from openapi_spec_validator import validate_v30_spec
-from openapi_spec_validator import validate_v30_spec_url
 from openapi_spec_validator.validation.exceptions import OpenAPIValidationError
 from openapi_spec_validator.validation.exceptions import ValidatorDetectError
 
@@ -50,9 +44,7 @@ def test_valid(self, factory, spec_file):
         spec_url = factory.spec_file_url(spec_path)
 
         validate_spec(spec)
-        validate_v2_spec(spec)
-
-        validate_spec_factory(openapi_v2_spec_validator)(spec, spec_url)
+        validate_spec(spec, validator=openapi_v2_spec_validator)
 
     @pytest.mark.parametrize(
         "spec_file",
@@ -65,7 +57,7 @@ def test_falied(self, factory, spec_file):
         spec = factory.spec_from_file(spec_path)
 
         with pytest.raises(OpenAPIValidationError):
-            validate_v2_spec(spec)
+            validate_spec(spec, validator=openapi_v2_spec_validator)
 
 
 class TestLocalValidatev30Spec:
@@ -87,9 +79,8 @@ def test_valid(self, factory, spec_file):
         spec_url = factory.spec_file_url(spec_path)
 
         validate_spec(spec)
-        validate_v30_spec(spec)
-
-        validate_spec_factory(openapi_v30_spec_validator)(spec, spec_url)
+        validate_spec(spec, spec_url=spec_url)
+        validate_spec(spec, validator=openapi_v30_spec_validator)
 
     @pytest.mark.parametrize(
         "spec_file",
@@ -102,7 +93,7 @@ def test_falied(self, factory, spec_file):
         spec = factory.spec_from_file(spec_path)
 
         with pytest.raises(OpenAPIValidationError):
-            validate_v30_spec(spec)
+            validate_spec(spec, validator=openapi_v30_spec_validator)
 
 
 @pytest.mark.network
@@ -130,9 +121,7 @@ def test_valid(self, spec_file):
         spec_url = self.remote_test_suite_file_path(spec_file)
 
         validate_spec_url(spec_url)
-        validate_v2_spec_url(spec_url)
-
-        validate_spec_url_factory(openapi_v2_spec_validator)(spec_url)
+        validate_spec_url(spec_url, validator=openapi_v2_spec_validator)
 
 
 @pytest.mark.network
@@ -160,6 +149,4 @@ def test_valid(self, spec_file):
         spec_url = self.remote_test_suite_file_path(spec_file)
 
         validate_spec_url(spec_url)
-        validate_v30_spec_url(spec_url)
-
-        validate_spec_url_factory(openapi_v30_spec_validator)(spec_url)
+        validate_spec_url(spec_url, validator=openapi_v30_spec_validator)