rename server to backend

rmorshea · rmorshea · commit 107436638383 · 2022-04-07T20:05:14.000-07:00
diff --git a/docs/app.py b/docs/app.py
@@ -5,8 +5,8 @@
 from sanic import Sanic, response
 
 from idom import component
+from idom.backend.sanic import Options, configure, use_request
 from idom.core.types import ComponentConstructor
-from idom.server.sanic import Options, configure, use_request
 
 from .examples import get_normalized_example_name, load_examples
 
diff --git a/docs/source/guides/getting-started/_examples/run_fastapi.py b/docs/source/guides/getting-started/_examples/run_fastapi.py
@@ -1,7 +1,7 @@
 # :lines: 11-
 
 from idom import run
-from idom.server import fastapi as fastapi_server
+from idom.backend import fastapi as fastapi_server
 
 
 # the run() function is the entry point for examples
@@ -11,7 +11,7 @@
 from fastapi import FastAPI
 
 from idom import component, html
-from idom.server.fastapi import configure
+from idom.backend.fastapi import configure
 
 
 @component
diff --git a/docs/source/guides/getting-started/_examples/run_flask.py b/docs/source/guides/getting-started/_examples/run_flask.py
@@ -1,7 +1,7 @@
 # :lines: 11-
 
 from idom import run
-from idom.server import flask as flask_server
+from idom.backend import flask as flask_server
 
 
 # the run() function is the entry point for examples
@@ -11,7 +11,7 @@
 from flask import Flask
 
 from idom import component, html
-from idom.server.flask import configure
+from idom.backend.flask import configure
 
 
 @component
diff --git a/docs/source/guides/getting-started/_examples/run_sanic.py b/docs/source/guides/getting-started/_examples/run_sanic.py
@@ -1,7 +1,7 @@
 # :lines: 11-
 
 from idom import run
-from idom.server import sanic as sanic_server
+from idom.backend import sanic as sanic_server
 
 
 # the run() function is the entry point for examples
@@ -11,7 +11,7 @@
 from sanic import Sanic
 
 from idom import component, html
-from idom.server.sanic import configure
+from idom.backend.sanic import configure
 
 
 @component
diff --git a/docs/source/guides/getting-started/_examples/run_starlette.py b/docs/source/guides/getting-started/_examples/run_starlette.py
@@ -1,7 +1,7 @@
 # :lines: 11-
 
 from idom import run
-from idom.server import starlette as starlette_server
+from idom.backend import starlette as starlette_server
 
 
 # the run() function is the entry point for examples
@@ -11,7 +11,7 @@
 from starlette.applications import Starlette
 
 from idom import component, html
-from idom.server.starlette import configure
+from idom.backend.starlette import configure
 
 
 @component
diff --git a/docs/source/guides/getting-started/_examples/run_tornado.py b/docs/source/guides/getting-started/_examples/run_tornado.py
@@ -1,7 +1,7 @@
 # :lines: 11-
 
 from idom import run
-from idom.server import tornado as tornado_server
+from idom.backend import tornado as tornado_server
 
 
 # the run() function is the entry point for examples
@@ -12,7 +12,7 @@
 import tornado.web
 
 from idom import component, html
-from idom.server.tornado import configure
+from idom.backend.tornado import configure
 
 
 @component
diff --git a/docs/source/guides/getting-started/_static/embed-idom-view/main.py b/docs/source/guides/getting-started/_static/embed-idom-view/main.py
@@ -2,7 +2,7 @@
 from sanic.response import file
 
 from idom import component, html
-from idom.server.sanic import Options, configure
+from idom.backend.sanic import Options, configure
 
 
 app = Sanic("MyApp")
diff --git a/docs/source/guides/getting-started/index.rst b/docs/source/guides/getting-started/index.rst
@@ -106,9 +106,9 @@ Section 2: Running IDOM
 
 Once you've :ref:`installed IDOM <Installing IDOM>`, you'll want to learn how to run an
 application. Throughout most of the examples in this documentation, you'll see the
-:func:`~idom.server.utils.run` function used. While it's convenient tool for development
-it shouldn't be used in production settings - it's slow, and could leak secrets through
-debug log messages.
+:func:`~idom.backend.utils.run` function used. While it's convenient tool for
+development it shouldn't be used in production settings - it's slow, and could leak
+secrets through debug log messages.
 
 .. idom:: _examples/hello_world
 
diff --git a/docs/source/guides/getting-started/running-idom.rst b/docs/source/guides/getting-started/running-idom.rst
@@ -1,7 +1,7 @@
 Running IDOM
 ============
 
-The simplest way to run IDOM is with the :func:`~idom.server.utils.run` function. This
+The simplest way to run IDOM is with the :func:`~idom.backend.utils.run` function. This
 is the method you'll see used throughout this documentation. However, this executes your
 application using a development server which is great for testing, but probably not what
 if you're :ref:`deploying in production <Running IDOM in Production>`. Below are some
@@ -20,10 +20,10 @@ will follow a pattern similar to the following:
 
 .. code-block::
 
-    from my_chosen_server import Application
+    from my_chosen_backend import Application
 
     from idom import component, html
-    from idom.server.my_chosen_server import configure
+    from idom.backend.my_chosen_backend import configure
 
 
     @component
@@ -151,17 +151,17 @@ respective ``configure()`` functions in the following way:
 
 .. code-block::
 
-    from idom.server.<implementation> import configure, Options
+    from idom.backend.<implementation> import configure, Options
 
     configure(app, MyComponent, Options(...))
 
-To learn more read about the options for your chosen server ``<implementation>``:
+To learn more read about the options for your chosen backend ``<implementation>``:
 
-- :class:`idom.server.fastapi.Options`
-- :class:`idom.server.flask.Options`
-- :class:`idom.server.sanic.Options`
-- :class:`idom.server.starlette.Options`
-- :class:`idom.server.tornado.Options`
+- :class:`idom.backend.fastapi.Options`
+- :class:`idom.backend.flask.Options`
+- :class:`idom.backend.sanic.Options`
+- :class:`idom.backend.starlette.Options`
+- :class:`idom.backend.tornado.Options`
 
 
 Embed in an Existing Webpage
diff --git a/scripts/live_docs.py b/scripts/live_docs.py
@@ -14,7 +14,7 @@
 )
 
 from docs.app import IDOM_MODEL_SERVER_URL_PREFIX, Example, make_app, reload_examples
-from idom.server.sanic import Options, configure, serve_development_app
+from idom.backend.sanic import Options, configure, serve_development_app
 from idom.testing import clear_idom_web_modules_dir
 
 
diff --git a/src/idom/__init__.py b/src/idom/__init__.py
@@ -1,4 +1,5 @@
-from . import config, html, logging, sample, server, types, web
+from . import backend, config, html, logging, sample, types, web
+from .backend.utils import run
 from .core import hooks
 from .core.component import component
 from .core.events import event
@@ -15,7 +16,6 @@
 from .core.layout import Layout
 from .core.serve import Stop
 from .core.vdom import vdom
-from .server.utils import run
 from .utils import Ref, html_to_vdom
 from .widgets import hotswap
 
@@ -37,7 +37,7 @@
     "Ref",
     "run",
     "sample",
-    "server",
+    "backend",
     "Stop",
     "types",
     "use_callback",
diff --git a/src/idom/backend/__init__.py b/src/idom/backend/__init__.py
diff --git a/src/idom/backend/_asgi.py b/src/idom/backend/_asgi.py
diff --git a/src/idom/backend/default.py b/src/idom/backend/default.py
diff --git a/src/idom/backend/fastapi.py b/src/idom/backend/fastapi.py
diff --git a/src/idom/backend/flask.py b/src/idom/backend/flask.py
@@ -25,11 +25,11 @@
 from werkzeug.serving import BaseWSGIServer, make_server
 
 import idom
+from idom.backend.types import Location
 from idom.core.hooks import Context, create_context, use_context
 from idom.core.layout import LayoutEvent, LayoutUpdate
 from idom.core.serve import serve_json_patch
 from idom.core.types import ComponentType, RootComponentConstructor
-from idom.server.types import Location
 from idom.utils import Ref
 
 from .utils import safe_client_build_dir_path, safe_web_modules_dir_path
diff --git a/src/idom/backend/sanic.py b/src/idom/backend/sanic.py
@@ -14,6 +14,7 @@
 from sanic_cors import CORS
 from websockets.legacy.protocol import WebSocketCommonProtocol
 
+from idom.backend.types import Location
 from idom.core.hooks import Context, create_context, use_context
 from idom.core.layout import Layout, LayoutEvent
 from idom.core.serve import (
@@ -24,7 +25,6 @@
     serve_json_patch,
 )
 from idom.core.types import RootComponentConstructor
-from idom.server.types import Location
 
 from ._asgi import serve_development_asgi
 from .utils import safe_client_build_dir_path, safe_web_modules_dir_path
diff --git a/src/idom/backend/starlette.py b/src/idom/backend/starlette.py
@@ -12,6 +12,7 @@
 from starlette.types import Receive, Scope, Send
 from starlette.websockets import WebSocket, WebSocketDisconnect
 
+from idom.backend.types import Location
 from idom.config import IDOM_WEB_MODULES_DIR
 from idom.core.hooks import Context, create_context, use_context
 from idom.core.layout import Layout, LayoutEvent
@@ -22,7 +23,6 @@
     serve_json_patch,
 )
 from idom.core.types import RootComponentConstructor
-from idom.server.types import Location
 
 from ._asgi import serve_development_asgi
 from .utils import CLIENT_BUILD_DIR, safe_client_build_dir_path
diff --git a/src/idom/backend/tornado.py b/src/idom/backend/tornado.py
@@ -16,12 +16,12 @@
 from tornado.websocket import WebSocketHandler
 from tornado.wsgi import WSGIContainer
 
+from idom.backend.types import Location
 from idom.config import IDOM_WEB_MODULES_DIR
 from idom.core.hooks import Context, create_context, use_context
 from idom.core.layout import Layout, LayoutEvent
 from idom.core.serve import VdomJsonPatch, serve_json_patch
 from idom.core.types import ComponentConstructor
-from idom.server.types import Location
 
 from .utils import CLIENT_BUILD_DIR, safe_client_build_dir_path
 
diff --git a/src/idom/backend/types.py b/src/idom/backend/types.py
diff --git a/src/idom/backend/utils.py b/src/idom/backend/utils.py
diff --git a/src/idom/testing/server.py b/src/idom/testing/server.py
@@ -7,9 +7,9 @@
 from typing import Any, Optional, Tuple, Type, Union
 from urllib.parse import urlencode, urlunparse
 
-from idom.server import default as default_server
-from idom.server.types import ServerImplementation
-from idom.server.utils import find_available_port
+from idom.backend import default as default_server
+from idom.backend.types import ServerImplementation
+from idom.backend.utils import find_available_port
 from idom.widgets import hotswap
 
 from .logs import LogAssertionError, capture_idom_logs, list_logged_exceptions
diff --git a/src/idom/types.py b/src/idom/types.py
@@ -4,6 +4,7 @@
 - :mod:`idom.server.types`
 """
 
+from .backend.types import Location, ServerImplementation
 from .core.hooks import Context
 from .core.types import (
     ComponentConstructor,
@@ -23,7 +24,6 @@
     VdomDict,
     VdomJson,
 )
-from .server.types import Location, ServerImplementation
 
 
 __all__ = [
diff --git a/temp.py b/temp.py
@@ -1,5 +1,5 @@
 from idom import component, html, run
-from idom.server import starlette as server
+from idom.backend import starlette as server
 
 
 @component
diff --git a/tests/test_server/test_common.py b/tests/test_server/test_common.py
@@ -4,9 +4,9 @@
 
 import idom
 from idom import html
-from idom.server import default as default_implementation
-from idom.server.types import Location
-from idom.server.utils import all_implementations
+from idom.backend import default as default_implementation
+from idom.backend.types import Location
+from idom.backend.utils import all_implementations
 from idom.testing import DisplayFixture, ServerFixture, poll
 
 
diff --git a/tests/test_server/test_utils.py b/tests/test_server/test_utils.py
@@ -6,11 +6,11 @@
 import pytest
 from playwright.async_api import Page
 
+from idom.backend import flask as flask_implementation
+from idom.backend.utils import find_available_port
+from idom.backend.utils import run as sync_run
+from idom.backend.utils import traversal_safe_path
 from idom.sample import SampleApp as SampleApp
-from idom.server import flask as flask_implementation
-from idom.server.utils import find_available_port
-from idom.server.utils import run as sync_run
-from idom.server.utils import traversal_safe_path
 from tests.tooling.loop import open_event_loop
 
 
diff --git a/tests/test_testing.py b/tests/test_testing.py
@@ -4,9 +4,9 @@
 import pytest
 
 from idom import testing
+from idom.backend import starlette as starlette_implementation
 from idom.logging import ROOT_LOGGER
 from idom.sample import SampleApp as SampleApp
-from idom.server import starlette as starlette_implementation
 
 
 def test_assert_idom_logged_does_not_supress_errors():
diff --git a/tests/test_web/test_module.py b/tests/test_web/test_module.py
@@ -4,7 +4,7 @@
 from sanic import Sanic
 
 import idom
-from idom.server import sanic as sanic_implementation
+from idom.backend import sanic as sanic_implementation
 from idom.testing import (
     DisplayFixture,
     ServerFixture,

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`from docs.app import IDOM_MODEL_SERVER_URL_PREFIX, Example, make_app, reload_examples`
`17`		`-from idom.server.sanic import Options, configure, serve_development_app`
	`17`	`+from idom.backend.sanic import Options, configure, serve_development_app`
`18`	`18`	`from idom.testing import clear_idom_web_modules_dir`
`19`	`19`
`20`	`20`