sc-oa 0.7.0.13__py3-none-any.whl → 0.7.0.15__py3-none-any.whl

{sc_oa-0.7.0.13.dist-info → sc_oa-0.7.0.15.dist-info}/METADATA

@@ -1,17 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sc-oa
-Version: 0.7.0.13
+Version: 0.7.0.15
 Summary: Fork of the OpenAPI (fka Swagger) spec renderer for Sphinx
 Home-page: https://github.com/olivier-heurtier/sphinxcontrib-openapi/tree/mymaster
 Author: Ihor Kalnytskyi
-Requires-Dist: sphinx <7.0
-Requires-Dist: sphinxcontrib-httpdomain
-Requires-Dist: PyYAML
-Requires-Dist: jsonschema
-Requires-Dist: m2r2
-Requires-Dist: picobox
-Requires-Dist: deepmerge
-
 Olivier Heurtier
 Author-email: ihor@kalnytskyi.com
 License: BSD
@@ -28,15 +20,18 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Extension
 Requires-Python: >=3.8
 License-File: LICENSE
-Requires-Dist: sphinx<7.0
+Requires-Dist: sphinx
 Requires-Dist: sphinxcontrib-httpdomain
 Requires-Dist: PyYAML
 Requires-Dist: jsonschema
 Requires-Dist: m2r2
 Requires-Dist: picobox
 Requires-Dist: deepmerge
+Requires-Dist: setuptools
+Dynamic: license-file

{sc_oa-0.7.0.13.dist-info → sc_oa-0.7.0.15.dist-info}/RECORD

@@ -1,10 +1,11 @@
-sc_oa-0.7.0.13-py3.9-nspkg.pth,sha256=YYcv3GPokof0Lzq3hZHkJIlfNzBys5lF7Lt7JGRAP04,575
-sphinxcontrib/openapi/__init__.py,sha256=LmtCBI-dTDmiKvrCSmg5YCzv0au6VCiNuZbULg0LvAs,3168
+sc_oa-0.7.0.15.dist-info/licenses/LICENSE,sha256=tgm4r1GgqXjKU6uEH1LIWT7ncoq7S56ZbuxNW-F94iU,1342
+sphinxcontrib/__init__.py,sha256=lT1-9KgirBnjSt96Te_iPODBQdpXXnxmZa8yMD8-TYw,269
+sphinxcontrib/openapi/__init__.py,sha256=U1Y6TAHjvJ4fky2prU1k_Vs9YtROsZq3RlBQPDgYOLY,3181
 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=n92psjyd29EHfaz1a8AtUJhuSD7U3tBAGSrUnTl6bqM,29804
+sphinxcontrib/openapi/openapi30.py,sha256=PfXQ7N2fPz2GtWAcvwatDv2l7X5o8npblLLaGXxvbyA,29881
 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
@@ -16,12 +17,10 @@ sphinxcontrib/openapi/renderers/__init__.py,sha256=76shdyGAuHpJ9Gy3y0MQP1hyT3OMI
 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=z2R07XVlk5h5YwGbdqFDo2Oe6cFmvADMeV6eebms0hw,15520
+sphinxcontrib/openapi/renderers/_model.py,sha256=Cb6eYXU7tVuDbwVnnECkyjKWw5lgWzFKVLpEY-yK1Z0,15867
 sphinxcontrib/openapi/renderers/_toc.py,sha256=vY0giwCeyoBejkhEDD0Ok_vGCtZKobICnb1CK7vhDJQ,1526
 sphinxcontrib/openapi/renderers/abc.py,sha256=CuIda0iT0jdEUd2OBGQdq4VcHl2XWKoCAayYztKAzOA,1531
-sc_oa-0.7.0.13.dist-info/LICENSE,sha256=tgm4r1GgqXjKU6uEH1LIWT7ncoq7S56ZbuxNW-F94iU,1342
-sc_oa-0.7.0.13.dist-info/METADATA,sha256=wIXidbNIwAyaEzfzXxAkBoRbqyCZjDBBUzdO3hvuobg,1499
-sc_oa-0.7.0.13.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-sc_oa-0.7.0.13.dist-info/namespace_packages.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sc_oa-0.7.0.13.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sc_oa-0.7.0.13.dist-info/RECORD,,
+sc_oa-0.7.0.15.dist-info/METADATA,sha256=LrAexuL3wY6he4XhL0NwuxHsow_wQ5vv6V-X-JFd7z4,1405
+sc_oa-0.7.0.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sc_oa-0.7.0.15.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sc_oa-0.7.0.15.dist-info/RECORD,,

{sc_oa-0.7.0.13.dist-info → sc_oa-0.7.0.15.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sphinxcontrib/__init__.py

@@ -0,0 +1,10 @@
+"""
+    sphinxcontrib
+    ~~~~~~~~~~~~~
+
+    This package is a namespace package that contains all extensions
+    distributed in the ``sphinx-contrib`` distribution.
+
+    :copyright: (c) 2016 by Igor Kalnitsky.
+    :license: BSD, see LICENSE for details.
+"""

sphinxcontrib/openapi/__init__.py

@@ -1,4 +1,4 @@
-"""
+"""get_distribution
     sphinxcontrib.openapi
     ---------------------
 
@@ -10,15 +10,15 @@
 """
 
 import os
-from pkg_resources import get_distribution, DistributionNotFound
+from importlib.metadata import distribution, PackageNotFoundError
 from sphinxcontrib.openapi import renderers, directive
 from sphinx.domains import Domain
 import yaml
 from docutils import nodes
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    __version__ = distribution(__name__).version
+except PackageNotFoundError:
     # package is not installed
     __version__ = None
 

sphinxcontrib/openapi/openapi30.py

@@ -144,7 +144,8 @@ def _parse_schema(schema, method):
                             del example[k]
                 ret = collections.OrderedDict(example)
                 # XXX should be True to be compliant with OpenAPI
-                if schema.get('additionalProperties', False) and '...' not in example:
+                if (schema.get('additionalProperties', False) or 'type' not in schema) and \
+                        '...' not in example:
                     # materialize in the example the fact that additional properties can be added
                     ret['...'] = '...'
                 return ret
@@ -160,7 +161,7 @@ def _parse_schema(schema, method):
                 results.append((name, result))
 
         # XXX should be True to be compliant with OpenAPI
-        if schema.get('additionalProperties', False):
+        if schema.get('additionalProperties', False) or 'type' not in schema:
             # materialize in the example the fact that additional properties can be added
             results.append(("...", "..."))
 

sphinxcontrib/openapi/renderers/_model.py

@@ -245,9 +245,7 @@ def _process_one(prefix, schema, mandatory, entities, convert):
 
 
 def _build(name, schema, entities, convert, options):
-    if 'type' not in schema:
-        schema['type'] = 'object'
-    if schema.get('type', '') not in ['object', 'array']:
+    if 'type' in schema and schema['type'] not in ['object', 'array']:
         return ''
 
     yield ''
@@ -257,27 +255,32 @@ def _build(name, schema, entities, convert, options):
     yield options['header'] * len(name)
     yield ''
     D = _get_description(schema, convert)
+    if 'type' not in schema and not (set(['oneOf', 'allOf', 'anyOf']) & schema.keys()):
+        D += '\n' + _('Any type of content is accepted (number, string or object).')
     if D:
         yield D
         yield ''
-    yield '.. list-table:: ' + name
-    yield '    :header-rows: 1'
-    yield '    :widths: 25 25 45 15'
-    yield '    :class: longtable'
-    yield ''
-    yield '    * - ' + _('Attribute')
-    yield '      - ' + _('Type')
-    yield '      - ' + _('Description')
-    yield '      - ' + _('Required')
-
-    for item in _process_one([], schema, False, entities, convert):
-        if str(item[0]):
-            yield '    * - ``' + str(item[0]) + '``'
-        else:
-            yield '    * - ' + _('N/A')
-        yield '      - ' + textwrap.indent(str(item[1]), '        ').lstrip()
-        yield '      - ' + textwrap.indent(str(item[2]), '        ').lstrip()
-        yield '      - ' + _('Yes') if item[3] else '      -'
+    if 'type' not in schema and not (set(['oneOf', 'allOf', 'anyOf']) & schema.keys()):
+        pass
+    else:
+        yield '.. list-table:: ' + name
+        yield '    :header-rows: 1'
+        yield '    :widths: 25 25 45 15'
+        yield '    :class: longtable'
+        yield ''
+        yield '    * - ' + _('Attribute')
+        yield '      - ' + _('Type')
+        yield '      - ' + _('Description')
+        yield '      - ' + _('Required')
+
+        for item in _process_one([], schema, False, entities, convert):
+            if str(item[0]):
+                yield '    * - ``' + str(item[0]) + '``'
+            else:
+                yield '    * - ' + _('N/A')
+            yield '      - ' + textwrap.indent(str(item[1]), '        ').lstrip()
+            yield '      - ' + textwrap.indent(str(item[2]), '        ').lstrip()
+            yield '      - ' + _('Yes') if item[3] else '      -'
 
     if 'example' in schema or 'examples' in schema:
         N = 1
@@ -289,7 +292,8 @@ def _build(name, schema, entities, convert, options):
             N += 1
             # validate the example against this schema
             try:
-                validate(instance=ex, schema=schema)
+                if 'type' in schema:
+                    validate(instance=ex, schema=schema)
                 yield ''
                 yield '.. code-block:: json'
                 yield ''

sc_oa-0.7.0.13-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.13.dist-info/namespace_packages.txt

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