Move handlers to separate package

Author: p1c2u

openapi_spec_validator/handlers.py

@@ -0,0 +1,11 @@
+from openapi_spec_validator.handlers.file import FileObjectHandler
+try:
+    from openapi_spec_validator.handlers.requests import (
+        UrlRequestsHandler as UrlHandler,
+    )
+except ImportError:
+    from openapi_spec_validator.handlers.urllib import (
+        UrllibHandler as UrlHandler,
+    )
+
+__all__ = ['FileObjectHandler', 'UrlHandler']

openapi_spec_validator/handlers/__init__.py

@@ -0,0 +1,13 @@
+"""OpenAPI spec validator handlers file module."""
+from openapi_spec_validator.loaders import ExtendedSafeLoader
+
+
+class BaseHandler(object):
+    """OpenAPI spec validator base handler."""
+
+    def __init__(self, **options):
+        self.options = options
+
+    @property
+    def loader(self):
+        return self.options.get('loader', ExtendedSafeLoader)

openapi_spec_validator/handlers/base.py

@@ -0,0 +1,26 @@
+"""OpenAPI spec validator handlers file module."""
+from six import StringIO
+from yaml import load
+
+from openapi_spec_validator.handlers.base import BaseHandler
+
+
+class FileObjectHandler(BaseHandler):
+    """OpenAPI spec validator file-like object handler."""
+
+    def __call__(self, f):
+        return load(f, self.loader)
+
+
+class FileHandler(FileObjectHandler):
+    """OpenAPI spec validator file path handler."""
+
+    def __call__(self, f):
+        if isinstance(f, StringIO):
+            return super(FileHandler, self).__call__(f)
+
+        assert f.startswith("file")
+
+        filename = f[7:]
+        with open(filename) as fh:
+            return super(FileHandler, self).__call__(fh)

openapi_spec_validator/handlers/file.py

@@ -0,0 +1,31 @@
+"""OpenAPI spec validator handlers requests module."""
+from __future__ import absolute_import
+import contextlib
+
+from six import StringIO
+from six.moves.urllib.parse import urlparse
+import requests
+
+from openapi_spec_validator.handlers.file import FileHandler
+
+
+class UrlRequestsHandler(FileHandler):
+    """OpenAPI spec validator URL (requests) scheme handler."""
+
+    def __init__(self, *allowed_schemes, **options):
+        super(UrlRequestsHandler, self).__init__(**options)
+        self.allowed_schemes = allowed_schemes
+
+    def __call__(self, url, timeout=1):
+        scheme = urlparse(url).scheme
+        assert scheme in self.allowed_schemes
+
+        if scheme == "file":
+            return super(UrlRequestsHandler, self).__call__(url)
+
+        response = requests.get(url, timeout=timeout)
+        response.raise_for_status()
+
+        data = StringIO(response.text)
+        with contextlib.closing(data) as fh:
+            return super(UrlRequestsHandler, self).__call__(fh)

openapi_spec_validator/handlers/requests.py

@@ -0,0 +1,23 @@
+"""OpenAPI spec validator handlers requests module."""
+import contextlib
+
+from six.moves.urllib.parse import urlparse
+from six.moves.urllib.request import urlopen
+
+from openapi_spec_validator.handlers.file import FileObjectHandler
+
+
+class UrllibHandler(FileObjectHandler):
+    """OpenAPI spec validator URL (urllib) scheme handler."""
+
+    def __init__(self, *allowed_schemes, **options):
+        super(UrllibHandler, self).__init__(**options)
+        self.allowed_schemes = allowed_schemes
+
+    def __call__(self, url, timeout=1):
+        assert urlparse(url).scheme in self.allowed_schemes
+
+        f = urlopen(url, timeout=timeout)
+
+        with contextlib.closing(f) as fh:
+            return super(UrllibHandler, self).__call__(fh)

openapi_spec_validator/handlers/urllib.py

@@ -29,7 +29,6 @@ install_requires =
     PyYAML>=5.1
     six
     pathlib2; python_version<"3.0"
-    requests
 tests_require =
     mock; python_version<"3.0"
     pytest
@@ -47,6 +46,7 @@ exclude =
 
 [options.extras_require]
 dev = pre-commit
+requests = requests
 
 [tool:pytest]
 addopts = -sv --flake8 --junitxml reports/junit.xml --cov openapi_spec_validator --cov-report term-missing --cov-report xml:reports/coverage.xml