Make openapi optional and lazy (#253)

Author: blink1073

README.md

@@ -14,6 +14,14 @@ accommodate creating JupyterLab-like applications from a more limited scope.
 
 `pip install jupyterlab_server`
 
+To include optional `openapi` dependencies, use:
+
+`pip install jupyterlab_server[openapi]`
+
+To include optional `pytest_plugin` dependencies, use:
+
+`pip install jupyterlab_server[test]`
+
 ## Usage
 
 See the full documentation for [API docs](https://jupyterlab-server.readthedocs.io/en/stable/api/index.html) and [REST endpoint descriptions](https://jupyterlab-server.readthedocs.io/en/stable/api/rest.html).

docs/source/api/index.rst

@@ -14,3 +14,4 @@ JupyterLab Server API Reference:
     handlers
     process
     rest
+    spec

docs/source/api/spec.rst

@@ -0,0 +1,14 @@
+=============
+OpenAPI Specs
+=============
+
+Module: :mod:`jupyterlab_server.spec`
+=====================================
+
+.. automodule:: jupyterlab_server.spec
+
+.. currentmodule:: jupyterlab_server.spec
+
+.. autofunction:: get_openapi_spec
+
+.. autofunction:: get_openapi_spec_dict

jupyterlab_server/__init__.py

@@ -4,7 +4,7 @@
 from .app import LabServerApp
 from .licenses_app import LicensesApp
 from .handlers import add_handlers, LabHandler, LabConfig
-from .spec import openapi_spec, openapi_spec_dict
+from .spec import get_openapi_spec, get_openapi_spec_dict
 from .translation_utils import translator
 from .workspaces_app import WorkspaceExportApp, WorkspaceImportApp, WorkspaceListApp
 from .workspaces_handler import slugify, WORKSPACE_EXTENSION

jupyterlab_server/spec.py

@@ -1,11 +1,19 @@
 import os
 from pathlib import Path
 
-from ruamel.yaml import YAML
-from openapi_core import create_spec
-
 HERE = Path(os.path.dirname(__file__)).resolve()
-path = HERE / 'rest-api.yml'
-yaml = YAML(typ='safe')
-openapi_spec_dict = yaml.load(path.read_text(encoding='utf-8'))
-openapi_spec = create_spec(openapi_spec_dict)
+
+
+def get_openapi_spec():
+    """Get the OpenAPI spec object."""
+    from openapi_core import create_spec
+    openapi_spec_dict = get_openapi_spec_dict()
+    return create_spec(openapi_spec_dict)
+
+
+def get_openapi_spec_dict():
+    """Get the OpenAPI spec as a dictionary."""
+    from ruamel.yaml import YAML
+    path = HERE / 'rest-api.yml'
+    yaml = YAML(typ='safe')
+    return yaml.load(path.read_text(encoding='utf-8'))

jupyterlab_server/test_utils.py

@@ -15,7 +15,7 @@
 import requests
 import tornado
 
-from jupyterlab_server.spec import openapi_spec
+from jupyterlab_server.spec import get_openapi_spec
 
 
 HERE = Path(os.path.dirname(__file__)).resolve()
@@ -95,6 +95,7 @@ def wrap_response(response):
 
 def validate_request(response):
     """Validate an API request"""
+    openapi_spec = get_openapi_spec()
     validator = RequestValidator(openapi_spec)
     request = wrap_request(response.request, openapi_spec)
     result = validator.validate(request)

setup.cfg

@@ -32,10 +32,9 @@ install_requires =
     jinja2>=3.0.3
     json5
     jsonschema>=3.0.1
-    openapi_core>=0.14.2
     packaging
     requests
-    ruamel.yaml
+
     jupyter_server~=1.8
 
 [options.extras_require]
@@ -49,6 +48,11 @@ test =
     strict-rfc3339
     wheel
     openapi-spec-validator<0.5
+    openapi_core>=0.14.2
+    ruamel.yaml
+openapi =
+    openapi_core>=0.14.2
+    ruamel.yaml
 
 [options.packages.find]
 exclude =