Skip to content

Commit 595bed4

Browse files
committed
remove references to idom.server
1 parent 5004ca7 commit 595bed4

File tree

5 files changed

+12
-18
lines changed

5 files changed

+12
-18
lines changed

src/idom/backend/fastapi.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@
66

77

88
serve_development_app = starlette.serve_development_app
9-
"""Alias for :func:`idom.server.starlette.serve_development_app`"""
9+
"""Alias for :func:`idom.backend.starlette.serve_development_app`"""
1010

1111
# see: https://github.com/idom-team/flake8-idom-hooks/issues/12
1212
use_location = starlette.use_location # noqa: ROH101
13-
"""Alias for :func:`idom.server.starlette.use_location`"""
13+
"""Alias for :func:`idom.backend.starlette.use_location`"""
1414

1515
# see: https://github.com/idom-team/flake8-idom-hooks/issues/12
1616
use_scope = starlette.use_scope # noqa: ROH101
17-
"""Alias for :func:`idom.server.starlette.use_scope`"""
17+
"""Alias for :func:`idom.backend.starlette.use_scope`"""
1818

1919
# see: https://github.com/idom-team/flake8-idom-hooks/issues/12
2020
use_websocket = starlette.use_websocket # noqa: ROH101
21-
"""Alias for :func:`idom.server.starlette.use_websocket`"""
21+
"""Alias for :func:`idom.backend.starlette.use_websocket`"""
2222

2323
Options = starlette.Options
24-
"""Alias for :class:`idom.server.starlette.Options`"""
24+
"""Alias for :class:`idom.backend.starlette.Options`"""
2525

2626
configure = starlette.configure
27-
"""Alias for :class:`idom.server.starlette.configure`"""
27+
"""Alias for :class:`idom.backend.starlette.configure`"""
2828

2929

3030
def create_development_app() -> FastAPI:

src/idom/backend/flask.py

+3-5
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,12 @@
4545
def configure(
4646
app: Flask, component: RootComponentConstructor, options: Options | None = None
4747
) -> None:
48-
"""Return a :class:`FlaskServer` where each client has its own state.
49-
50-
Implements the :class:`~idom.server.proto.ServerFactory` protocol
48+
"""Confiure a Flask application to use IDOM.
5149
5250
Parameters:
53-
constructor: A component constructor
51+
app: An application instance
52+
component: A component constructor
5453
options: Options for configuring server behavior
55-
app: An application instance (otherwise a default instance is created)
5654
"""
5755
options = options or Options()
5856
blueprint = Blueprint("idom", __name__, url_prefix=options.url_prefix)

src/idom/backend/starlette.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ def configure(
4040
constructor: RootComponentConstructor,
4141
options: Options | None = None,
4242
) -> None:
43-
"""Return a :class:`StarletteServer` where each client has its own state.
44-
45-
Implements the :class:`~idom.server.proto.ServerFactory` protocol
43+
"""Configure a Starlette application to use IDOM.
4644
4745
Parameters:
4846
app: An application instance

src/idom/backend/tornado.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,7 @@ def configure(
3636
component: ComponentConstructor,
3737
options: Options | None = None,
3838
) -> None:
39-
"""Return a :class:`TornadoServer` where each client has its own state.
40-
41-
Implements the :class:`~idom.server.proto.ServerFactory` protocol
39+
"""Configure a Tornado application to use IDOM.
4240
4341
Parameters:
4442
app: A tornado ``Application`` instance.

src/idom/backend/utils.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def run(
4040
"Change this before deploying in production!"
4141
)
4242

43-
implementation = implementation or import_module("idom.server.default")
43+
implementation = implementation or import_module("idom.backend.default")
4444

4545
app = implementation.create_development_app()
4646
implementation.configure(app, component)

0 commit comments

Comments
 (0)