sc-oa 0.7.0.12__py3-none-any.whl → 0.7.0.14__py3-none-any.whl

sphinxcontrib/openapi/utils.py

@@ -1,137 +1,137 @@
-"""
-    sphinxcontrib.openapi.utils
-    ---------------------------
-
-    Common functionality shared across the various renderers.
-
-    :copyright: (c) 2016, Ihor Kalnytskyi.
-    :license: BSD, see LICENSE for details.
-"""
-
-from __future__ import unicode_literals
-
-import collections
-import collections.abc
-
-from contextlib import closing
-import jsonschema
-import yaml
-try:
-    from m2r2 import convert as convert_markdown
-except ImportError:
-    convert_markdown = None
-
-from urllib.parse import urlsplit
-from urllib.request import urlopen
-
-import os.path
-
-
-class OpenApiRefResolver(jsonschema.RefResolver):
-    """
-    Overrides resolve_remote to support both YAML and JSON
-    OpenAPI schemas.
-    """
-
-    try:
-        import requests
-        _requests = requests
-    except ImportError:
-        _requests = None
-
-    def resolve_remote(self, uri):
-        scheme, _, path, _, _ = urlsplit(uri)
-        _, extension = os.path.splitext(path)
-
-        if extension not in [".yml", ".yaml"] or scheme in self.handlers:
-            return super(OpenApiRefResolver, self).resolve_remote(uri)
-
-        if scheme in [u"http", u"https"] and self._requests:
-            response = self._requests.get(uri)
-            result = yaml.safe_load(response)
-        else:
-            # Otherwise, pass off to urllib and assume utf-8
-            with closing(urlopen(uri)) as url:
-                response = url.read().decode("utf-8")
-                result = yaml.safe_load(response)
-
-        if self.cache_remote:
-            self.store[uri] = result
-        return result
-
-
-def _resolve_refs(uri, spec):
-    """Resolve JSON references in a given dictionary.
-
-    OpenAPI spec may contain JSON references to its nodes or external
-    sources, so any attempt to rely that there's some expected attribute
-    in the spec may fail. So we need to resolve JSON references before
-    we use it (i.e. replace with referenced object). For details see:
-
-        https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02
-
-    The input spec is modified in-place despite being returned from
-    the function.
-    """
-
-    resolver = OpenApiRefResolver(uri, spec)
-
-    def _do_resolve(node):
-        if isinstance(node, collections.abc.Mapping) and '$ref' in node:
-            ref = node['$ref']
-            with resolver.resolving(node['$ref']) as resolved:
-                ret = _do_resolve(resolved)  # might have recursive references
-            # Restore the $ref in case we want to
-            # separate the entities in the document
-            if isinstance(ret, collections.abc.Mapping):
-                ret['$entity_ref'] = ref
-            return ret
-        elif isinstance(node, collections.abc.Mapping):
-            for k, v in node.items():
-                node[k] = _do_resolve(v)
-        elif isinstance(node, (list, tuple)):
-            for i in range(len(node)):
-                node[i] = _do_resolve(node[i])
-        return node
-
-    return _do_resolve(spec)
-
-
-def normalize_spec(spec, **options):
-    # OpenAPI spec may contain JSON references, so we need resolve them
-    # before we access the actual values trying to build an httpdomain
-    # markup. Since JSON references may be relative, it's crucial to
-    # pass a document URI in order to properly resolve them.
-    spec = _resolve_refs(options.get('uri', ''), spec)
-
-    # OpenAPI spec may contain common endpoint's parameters top-level.
-    # In order to do not place if-s around the code to handle special
-    # cases, let's normalize the spec and push common parameters inside
-    # endpoints definitions.
-    for endpoint in spec['paths'].values():
-        parameters = endpoint.pop('parameters', [])
-        for method in endpoint.values():
-            method.setdefault('parameters', [])
-            method['parameters'].extend(parameters)
-
-
-def _conv_md(s):
-    try:
-        return convert_markdown(s)
-    except Exception:
-        return s
-
-
-def get_text_converter(options):
-    """Decide on a text converter for prose."""
-    if 'format' in options:
-        if options['format'] == 'markdown':
-            if convert_markdown is None:
-                raise ValueError(
-                    "Markdown conversion isn't available, "
-                    "install the [markdown] extra."
-                )
-            return _conv_md
-
-    # No conversion needed.
-    return lambda s: s
+"""
+    sphinxcontrib.openapi.utils
+    ---------------------------
+
+    Common functionality shared across the various renderers.
+
+    :copyright: (c) 2016, Ihor Kalnytskyi.
+    :license: BSD, see LICENSE for details.
+"""
+
+from __future__ import unicode_literals
+
+import collections
+import collections.abc
+
+from contextlib import closing
+import jsonschema
+import yaml
+try:
+    from m2r2 import convert as convert_markdown
+except ImportError:
+    convert_markdown = None
+
+from urllib.parse import urlsplit
+from urllib.request import urlopen
+
+import os.path
+
+
+class OpenApiRefResolver(jsonschema.RefResolver):
+    """
+    Overrides resolve_remote to support both YAML and JSON
+    OpenAPI schemas.
+    """
+
+    try:
+        import requests
+        _requests = requests
+    except ImportError:
+        _requests = None
+
+    def resolve_remote(self, uri):
+        scheme, _, path, _, _ = urlsplit(uri)
+        _, extension = os.path.splitext(path)
+
+        if extension not in [".yml", ".yaml"] or scheme in self.handlers:
+            return super(OpenApiRefResolver, self).resolve_remote(uri)
+
+        if scheme in [u"http", u"https"] and self._requests:
+            response = self._requests.get(uri)
+            result = yaml.safe_load(response)
+        else:
+            # Otherwise, pass off to urllib and assume utf-8
+            with closing(urlopen(uri)) as url:
+                response = url.read().decode("utf-8")
+                result = yaml.safe_load(response)
+
+        if self.cache_remote:
+            self.store[uri] = result
+        return result
+
+
+def _resolve_refs(uri, spec):
+    """Resolve JSON references in a given dictionary.
+
+    OpenAPI spec may contain JSON references to its nodes or external
+    sources, so any attempt to rely that there's some expected attribute
+    in the spec may fail. So we need to resolve JSON references before
+    we use it (i.e. replace with referenced object). For details see:
+
+        https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02
+
+    The input spec is modified in-place despite being returned from
+    the function.
+    """
+
+    resolver = OpenApiRefResolver(uri, spec)
+
+    def _do_resolve(node):
+        if isinstance(node, collections.abc.Mapping) and '$ref' in node:
+            ref = node['$ref']
+            with resolver.resolving(node['$ref']) as resolved:
+                ret = _do_resolve(resolved)  # might have recursive references
+            # Restore the $ref in case we want to
+            # separate the entities in the document
+            if isinstance(ret, collections.abc.Mapping):
+                ret['$entity_ref'] = ref
+            return ret
+        elif isinstance(node, collections.abc.Mapping):
+            for k, v in node.items():
+                node[k] = _do_resolve(v)
+        elif isinstance(node, (list, tuple)):
+            for i in range(len(node)):
+                node[i] = _do_resolve(node[i])
+        return node
+
+    return _do_resolve(spec)
+
+
+def normalize_spec(spec, **options):
+    # OpenAPI spec may contain JSON references, so we need resolve them
+    # before we access the actual values trying to build an httpdomain
+    # markup. Since JSON references may be relative, it's crucial to
+    # pass a document URI in order to properly resolve them.
+    spec = _resolve_refs(options.get('uri', ''), spec)
+
+    # OpenAPI spec may contain common endpoint's parameters top-level.
+    # In order to do not place if-s around the code to handle special
+    # cases, let's normalize the spec and push common parameters inside
+    # endpoints definitions.
+    for endpoint in spec['paths'].values():
+        parameters = endpoint.pop('parameters', [])
+        for method in endpoint.values():
+            method.setdefault('parameters', [])
+            method['parameters'].extend(parameters)
+
+
+def _conv_md(s):
+    try:
+        return convert_markdown(s)
+    except Exception:
+        return s
+
+
+def get_text_converter(options):
+    """Decide on a text converter for prose."""
+    if 'format' in options:
+        if options['format'] == 'markdown':
+            if convert_markdown is None:
+                raise ValueError(
+                    "Markdown conversion isn't available, "
+                    "install the [markdown] extra."
+                )
+            return _conv_md
+
+    # No conversion needed.
+    return lambda s: s

sc_oa-0.7.0.12-py3.9-nspkg.pth

@@ -1 +0,0 @@
-import sys, types, os;has_mfs = sys.version_info > (3, 5);p = os.path.join(sys._getframe(1).f_locals['sitedir'], *('sphinxcontrib',));importlib = has_mfs and __import__('importlib.util');has_mfs and __import__('importlib.machinery');m = has_mfs and sys.modules.setdefault('sphinxcontrib', importlib.util.module_from_spec(importlib.machinery.PathFinder.find_spec('sphinxcontrib', [os.path.dirname(p)])));m = m or sys.modules.setdefault('sphinxcontrib', types.ModuleType('sphinxcontrib'));mp = (m or []) and m.__dict__.setdefault('__path__',[]);(p not in mp) and mp.append(p)

sc_oa-0.7.0.12.dist-info/RECORD

@@ -1,27 +0,0 @@
-sc_oa-0.7.0.12-py3.9-nspkg.pth,sha256=YYcv3GPokof0Lzq3hZHkJIlfNzBys5lF7Lt7JGRAP04,575
-sphinxcontrib/openapi/__init__.py,sha256=LmtCBI-dTDmiKvrCSmg5YCzv0au6VCiNuZbULg0LvAs,3168
-sphinxcontrib/openapi/__main__.py,sha256=CeXNtxW1vYEwojIlVxlMhoXz2qIxsCbJp58JEIoo5Js,2522
-sphinxcontrib/openapi/_lib2to3.py,sha256=4LDmNmnGKTfXeq9TbVR0YXbwjYhFwq89zGA6XOtYgts,14002
-sphinxcontrib/openapi/directive.py,sha256=FRZ2JgOekkNK-ltpkNjTDkEpJdkZa5PyXCisHsBa9bU,2117
-sphinxcontrib/openapi/openapi20.py,sha256=zkwCm4aeZLMFNLM-uzj6UJQ4rHtFPdc95Airl3tpd78,9247
-sphinxcontrib/openapi/openapi30.py,sha256=87VlE9zRATOBIWjHczlspIMaGUQ7m3E86Qw7YGuQV7k,29113
-sphinxcontrib/openapi/schema_utils.py,sha256=mI6_4-b8b9j8dane9rHM5y9-Pe7yJgFuLQCBzQWLn3k,4583
-sphinxcontrib/openapi/utils.py,sha256=XGgO2HH6iYlPmn7jP-p36vlKxa50QM4TMnCg8I7-g-g,4480
-sphinxcontrib/openapi/locale/openapi.pot,sha256=69Ry6f7i1NPPE8AxGBBjAJNlK2klcWDbW01Z4eZeTtw,3999
-sphinxcontrib/openapi/locale/es_ES/LC_MESSAGES/openapi.mo,sha256=qdW6yFaSVB_BsexvwM33U8X12yoHikgaI8N7a4U_gI4,1919
-sphinxcontrib/openapi/locale/es_ES/LC_MESSAGES/openapi.po,sha256=FuLzvZ9-I-2CQ9nQTh4VhZ23FqlzYdD-SqMUPujpUUE,4527
-sphinxcontrib/openapi/locale/fr_FR/LC_MESSAGES/openapi.mo,sha256=YS2uZZZ4bHpDXJmShv33NZhtIWcir9-qERusNDR-vqY,1956
-sphinxcontrib/openapi/locale/fr_FR/LC_MESSAGES/openapi.po,sha256=wRkEX1USVUETXnFMXPFo_OH8NjVZJGymMn13E5a2iBo,4570
-sphinxcontrib/openapi/renderers/__init__.py,sha256=76shdyGAuHpJ9Gy3y0MQP1hyT3OMI6uTSrnRMYHwklI,426
-sphinxcontrib/openapi/renderers/_description.py,sha256=1J_e_4nl4wMT2dGkYdNbdQH80UuBJsNNQPq5axlcswM,728
-sphinxcontrib/openapi/renderers/_httpdomain.py,sha256=vLpVQts97dRUzLi4lrPcD1UzGG7dBiPWgnPzbeIozdk,25166
-sphinxcontrib/openapi/renderers/_httpdomain_old.py,sha256=4rbrX_zAaobYgwAI0veDSDhjPNWX4iIJJz9Sp-bKxcg,2691
-sphinxcontrib/openapi/renderers/_model.py,sha256=vvvHjwxT7pmOWS48FpjdHJWihtc0Lm3u2dhqR_pkKVs,15119
-sphinxcontrib/openapi/renderers/_toc.py,sha256=vY0giwCeyoBejkhEDD0Ok_vGCtZKobICnb1CK7vhDJQ,1526
-sphinxcontrib/openapi/renderers/abc.py,sha256=CuIda0iT0jdEUd2OBGQdq4VcHl2XWKoCAayYztKAzOA,1531
-sc_oa-0.7.0.12.dist-info/LICENSE,sha256=tgm4r1GgqXjKU6uEH1LIWT7ncoq7S56ZbuxNW-F94iU,1342
-sc_oa-0.7.0.12.dist-info/METADATA,sha256=PPj5AjcyVI5s7-ZQQnD0j7WexB89MQ0s9oyAsyIH6wk,1312
-sc_oa-0.7.0.12.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
-sc_oa-0.7.0.12.dist-info/namespace_packages.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sc_oa-0.7.0.12.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sc_oa-0.7.0.12.dist-info/RECORD,,

sc_oa-0.7.0.12.dist-info/namespace_packages.txt

@@ -1 +0,0 @@
-sphinxcontrib