Skip to content

SSR

Http class to create an emuleo app

Arguments

pages: dict[str, Path] Dictionary of routes and their corresponding pages server: dict[str, Path] Dictionary of routes and their corresponding server files static: dict[str, Path] Dictionary of routes and their corresponding static files scripts: dict[str, Path] Dictionary of routes and their corresponding scripts styles: dict[str, Path] Dictionary of routes and their corresponding styles

Attributes:

Name Type Description
pages dict[str, Path]

Dictionary of routes and their corresponding pages
server dict[str, Path]

Dictionary of routes and their corresponding server files
static dict[str, Path]

Dictionary of routes and their corresponding static files
scripts dict[str, Path]

Dictionary of routes and their corresponding scripts
styles dict[str, Path]

Dictionary of routes and their corresponding styles
Source code in emuleo/http.py 
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
class SSR:
    """
    Http class to create an emuleo app

    Arguments
    ---------
    pages: dict[str, Path]
        Dictionary of routes and their corresponding pages
    server: dict[str, Path]
        Dictionary of routes and their corresponding server files
    static: dict[str, Path]
        Dictionary of routes and their corresponding static files
    scripts: dict[str, Path]
        Dictionary of routes and their corresponding scripts
    styles: dict[str, Path]
        Dictionary of routes and their corresponding styles

    Attributes
    ----------
    pages: dict[str, Path]
        Dictionary of routes and their corresponding pages
    server: dict[str, Path]
        Dictionary of routes and their corresponding server files
    static: dict[str, Path]
        Dictionary of routes and their corresponding static files
    scripts: dict[str, Path]
        Dictionary of routes and their corresponding scripts
    styles: dict[str, Path]
        Dictionary of routes and their corresponding styles
    """

    def __init__(
        self,
        pages: dict[str, Path],
        server: dict[str, Path],
        static: dict[str, Path],
        scripts: dict[str, Path],
        styles: dict[str, Path],
    ) -> None:
        self.pages = pages
        self.server = server
        self.static = static
        self.scripts = scripts
        self.styles = styles

    async def __call__(
        self,
        scope: dict[str, t.Any],
        receive: Callable[..., t.Any],
        send: Callable[..., t.Any],
    ) -> None:
        """
        The main function of the app

        Arguments
        ---------
        scope: dict[str, typing.Any]
            The scope of the request
        receive: collections.abc.Callable[..., t.Any]
            The receive function
        send: collections.abc.Callable[..., t.Any]
            The send function

        Returns
        -------
        None

        Raises
        ------
        Exception
            If an error occurs

        Notes
        -----
        This function is called by uvicorn
        """
        assert scope["type"] == "http"
        console.print(
            f"[#0EA5E9]🔗 {scope['client'][0]}:{scope['client'][1]} {scope['method']} {scope['path']}[/#0EA5E9]",
        )
        route: str = scope["path"]
        try:
            if route.startswith("/static"):
                body = self.serve_static(route)
                if body:
                    await send_response(
                        200,
                        body[0],
                        [[b"content-type", body[1].encode() if body else b"text/html"]],
                        send,
                    )
                    emulog("success", scope, 200)
                else:
                    await self.render_not_found(send)
                    emulog("fail", scope, 404)
            elif route == "/favicon.ico":
                favicon = self.serve_static("/static/favicon.ico")
                if favicon:
                    await send_response(
                        200,
                        favicon[0],
                        [
                            [
                                b"content-type",
                                favicon[1].encode() if favicon else b"text/html",
                            ]
                        ],
                        send,
                    )
                    emulog("success", scope, 200)
                else:
                    await self.render_not_found(send)
                    emulog("fail", scope, 404)
            elif route.startswith("/scripts"):
                body = await self.serve_script(route)  # type: ignore[assignment]
                if body:
                    await send_response(
                        200, body, [[b"content-type", b"text/javascript"]], send
                    )
                    emulog("success", scope, 200)
                else:
                    await self.render_not_found(send)
                    emulog("fail", scope, 404)
            elif route.startswith("/styles"):
                body = await self.serve_styles(route)  # type: ignore[assignment]
                if body:
                    await send_response(
                        200, body, [[b"content-type", b"text/css"]], send
                    )
                    emulog("success", scope, 200)
                else:
                    await self.render_not_found(send)
                    emulog("fail", scope, 404)
            else:
                try:
                    body = return_template(self.pages[route])  # type: ignore[assignment]
                    status = 200
                    headers: list[list[str | bytes]] = [[b"content-type", b"text/html"]]
                    if self.server.get(route):
                        mod = await load_server(self.server[route])
                        if mod:
                            data = await get_load_data(mod, await receive())
                            if data and body and isinstance(body, str):
                                body = render_template(body, data.body)
                                if isinstance(body, Exception):
                                    await self.render_error(send)
                                    raise body
                                status = data.status
                                headers: list[list[str | bytes]] = data.headers  # type: ignore[no-redef]
                            else:
                                await self.render_error(send)
                            emulog("fail", scope, 500)
                        else:
                            await self.render_error(send)
                            emulog("fail", scope, 500)
                    if body:
                        await send_response(status, body, headers, send)
                        emulog("success", scope, status)
                    else:
                        await self.render_not_found(send)
                    emulog("fail", scope, 404)
                except KeyError:
                    await self.render_not_found(send)
                    emulog("fail", scope, 404)
        except Exception:
            await self.render_error(send)
            emulog("fail", scope, 500)
            console.print_exception()

    async def run(
        self,
        host: str = "localhost",
        port: int = 8000,
        dev: bool = False,
        reload_dirs: list[Path] = [],
    ) -> None:
        """
        Run the app

        Arguments
        ---------
        host: str
            The host of the app
        port: int
            The port of the app
        dev: bool
            Whether to run in development mode
        reload_dirs: list[Path]
            The directories to reload

        Returns
        -------
        None
        """
        config = uvicorn.Config(
            self,
            host=host,
            port=port,
            reload=dev,
            log_level="critical",
            reload_dirs=[path.as_posix() for path in reload_dirs],
        )
        server = uvicorn.Server(config)
        try:
            console.print(
                f"[#8B5CF6 bold]✅ Server running at http://{host}:{port}[/#8B5CF6 bold]",
                (f"[#D97706 bold]🚀 dev mode: {dev}[/#D97706 bold]\n"),
            )
            await server.serve()
        except KeyboardInterrupt:
            console.print("[#8B5CF6 bold]\n🛑 Server stopped[/#8B5CF6 bold]\n")
        except Exception as e:
            console.print(f"[#FF0000 bold]🚨 {e}[/#FF0000 bold]\n")

    def serve_static(
        self, route: str
    ) -> tuple[bytes, str] | tuple[bytes, t.Literal["text/plain"]] | None:
        """
        Serve the static files

        Arguments
        ---------
        route: str
            The route to the static file

        Returns
        -------
        tuple[bytes, str] | tuple[bytes, t.Literal["text/plain"]] | None
            The static file or None
        """
        try:
            with open(self.static[route.replace("/static", "")], "rb") as file:
                mime_type, _ = mimetypes.guess_type(
                    self.static[route.replace("/static", "")]
                )
                if mime_type:
                    return file.read(), mime_type
                return file.read(), "text/plain"
        except (FileNotFoundError, KeyError):
            return None

    async def render_not_found(self, send: Callable[..., t.Any]) -> None:
        """
        Render the 404 page

        Arguments
        ---------
        send: collections.abc.Callable[..., t.Any]
            The send function

        Returns
        -------
        None
        """
        try:
            body = return_template(self.pages["/404"])
            await send_response(
                404,
                body if body else "404 Not Found",
                [[b"content-type", b"text/html"]],
                send,
            )
        except KeyError:
            await send_response(
                404, "404 Not Found", [[b"content-type", b"text/html"]], send
            )

    async def render_error(self, send: Callable[..., t.Any]) -> None:
        """
        Render the 500 page

        Arguments
        ---------
        send: collections.abc.Callable[..., t.Any]
            The send function

        Returns
        -------
        None
        """
        try:
            body = return_template(self.pages.get("/500") or self.pages["/500"])
            await send_response(
                500,
                body if body else "500 Internal Server Error",
                [[b"content-type", b"text/html"]],
                send,
            )
        except KeyError:
            await send_response(
                500,
                "500 Internal Server Error",
                [[b"content-type", b"text/html"]],
                send,
            )

    async def serve_script(self, route: str) -> str | None:
        """
        Serve the scripts

        Arguments
        ---------
        route: str
            The route to the script

        Returns
        -------
        str | None
            The script or None
        """
        try:
            with open(self.scripts[route.replace("/scripts", "")], "r") as file:
                return file.read()
        except (FileNotFoundError, KeyError):
            return None

    async def serve_styles(self, route: str) -> str | None:
        """
        Serve the styles

        Arguments
        ---------
        route: str
            The route to the style

        Returns
        -------
        str | None
            The style or None
        """
        try:
            with open(self.styles[route.replace("/styles", "")], "r") as file:
                return file.read()
        except (FileNotFoundError, KeyError):
            return None

__call__(scope, receive, send) async

The main function of the app

Arguments

scope: dict[str, typing.Any] The scope of the request receive: collections.abc.Callable[..., t.Any] The receive function send: collections.abc.Callable[..., t.Any] The send function

Returns:

Type Description
None

Raises:

Type Description
Exception

If an error occurs
Notes

This function is called by uvicorn

Source code in emuleo/http.py 
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
async def __call__(
    self,
    scope: dict[str, t.Any],
    receive: Callable[..., t.Any],
    send: Callable[..., t.Any],
) -> None:
    """
    The main function of the app

    Arguments
    ---------
    scope: dict[str, typing.Any]
        The scope of the request
    receive: collections.abc.Callable[..., t.Any]
        The receive function
    send: collections.abc.Callable[..., t.Any]
        The send function

    Returns
    -------
    None

    Raises
    ------
    Exception
        If an error occurs

    Notes
    -----
    This function is called by uvicorn
    """
    assert scope["type"] == "http"
    console.print(
        f"[#0EA5E9]🔗 {scope['client'][0]}:{scope['client'][1]} {scope['method']} {scope['path']}[/#0EA5E9]",
    )
    route: str = scope["path"]
    try:
        if route.startswith("/static"):
            body = self.serve_static(route)
            if body:
                await send_response(
                    200,
                    body[0],
                    [[b"content-type", body[1].encode() if body else b"text/html"]],
                    send,
                )
                emulog("success", scope, 200)
            else:
                await self.render_not_found(send)
                emulog("fail", scope, 404)
        elif route == "/favicon.ico":
            favicon = self.serve_static("/static/favicon.ico")
            if favicon:
                await send_response(
                    200,
                    favicon[0],
                    [
                        [
                            b"content-type",
                            favicon[1].encode() if favicon else b"text/html",
                        ]
                    ],
                    send,
                )
                emulog("success", scope, 200)
            else:
                await self.render_not_found(send)
                emulog("fail", scope, 404)
        elif route.startswith("/scripts"):
            body = await self.serve_script(route)  # type: ignore[assignment]
            if body:
                await send_response(
                    200, body, [[b"content-type", b"text/javascript"]], send
                )
                emulog("success", scope, 200)
            else:
                await self.render_not_found(send)
                emulog("fail", scope, 404)
        elif route.startswith("/styles"):
            body = await self.serve_styles(route)  # type: ignore[assignment]
            if body:
                await send_response(
                    200, body, [[b"content-type", b"text/css"]], send
                )
                emulog("success", scope, 200)
            else:
                await self.render_not_found(send)
                emulog("fail", scope, 404)
        else:
            try:
                body = return_template(self.pages[route])  # type: ignore[assignment]
                status = 200
                headers: list[list[str | bytes]] = [[b"content-type", b"text/html"]]
                if self.server.get(route):
                    mod = await load_server(self.server[route])
                    if mod:
                        data = await get_load_data(mod, await receive())
                        if data and body and isinstance(body, str):
                            body = render_template(body, data.body)
                            if isinstance(body, Exception):
                                await self.render_error(send)
                                raise body
                            status = data.status
                            headers: list[list[str | bytes]] = data.headers  # type: ignore[no-redef]
                        else:
                            await self.render_error(send)
                        emulog("fail", scope, 500)
                    else:
                        await self.render_error(send)
                        emulog("fail", scope, 500)
                if body:
                    await send_response(status, body, headers, send)
                    emulog("success", scope, status)
                else:
                    await self.render_not_found(send)
                emulog("fail", scope, 404)
            except KeyError:
                await self.render_not_found(send)
                emulog("fail", scope, 404)
    except Exception:
        await self.render_error(send)
        emulog("fail", scope, 500)
        console.print_exception()

render_error(send) async

Render the 500 page

Arguments

send: collections.abc.Callable[..., t.Any] The send function

Returns:

Type Description
None
Source code in emuleo/http.py 
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
async def render_error(self, send: Callable[..., t.Any]) -> None:
    """
    Render the 500 page

    Arguments
    ---------
    send: collections.abc.Callable[..., t.Any]
        The send function

    Returns
    -------
    None
    """
    try:
        body = return_template(self.pages.get("/500") or self.pages["/500"])
        await send_response(
            500,
            body if body else "500 Internal Server Error",
            [[b"content-type", b"text/html"]],
            send,
        )
    except KeyError:
        await send_response(
            500,
            "500 Internal Server Error",
            [[b"content-type", b"text/html"]],
            send,
        )

render_not_found(send) async

Render the 404 page

Arguments

send: collections.abc.Callable[..., t.Any] The send function

Returns:

Type Description
None
Source code in emuleo/http.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
async def render_not_found(self, send: Callable[..., t.Any]) -> None:
    """
    Render the 404 page

    Arguments
    ---------
    send: collections.abc.Callable[..., t.Any]
        The send function

    Returns
    -------
    None
    """
    try:
        body = return_template(self.pages["/404"])
        await send_response(
            404,
            body if body else "404 Not Found",
            [[b"content-type", b"text/html"]],
            send,
        )
    except KeyError:
        await send_response(
            404, "404 Not Found", [[b"content-type", b"text/html"]], send
        )

run(host='localhost', port=8000, dev=False, reload_dirs=[]) async

Run the app

Arguments

host: str The host of the app port: int The port of the app dev: bool Whether to run in development mode reload_dirs: list[Path] The directories to reload

Returns:

Type Description
None
Source code in emuleo/http.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
async def run(
    self,
    host: str = "localhost",
    port: int = 8000,
    dev: bool = False,
    reload_dirs: list[Path] = [],
) -> None:
    """
    Run the app

    Arguments
    ---------
    host: str
        The host of the app
    port: int
        The port of the app
    dev: bool
        Whether to run in development mode
    reload_dirs: list[Path]
        The directories to reload

    Returns
    -------
    None
    """
    config = uvicorn.Config(
        self,
        host=host,
        port=port,
        reload=dev,
        log_level="critical",
        reload_dirs=[path.as_posix() for path in reload_dirs],
    )
    server = uvicorn.Server(config)
    try:
        console.print(
            f"[#8B5CF6 bold]✅ Server running at http://{host}:{port}[/#8B5CF6 bold]",
            (f"[#D97706 bold]🚀 dev mode: {dev}[/#D97706 bold]\n"),
        )
        await server.serve()
    except KeyboardInterrupt:
        console.print("[#8B5CF6 bold]\n🛑 Server stopped[/#8B5CF6 bold]\n")
    except Exception as e:
        console.print(f"[#FF0000 bold]🚨 {e}[/#FF0000 bold]\n")

serve_script(route) async

Serve the scripts

Arguments

route: str The route to the script

Returns:

Type Description
str | None

The script or None
Source code in emuleo/http.py 
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
async def serve_script(self, route: str) -> str | None:
    """
    Serve the scripts

    Arguments
    ---------
    route: str
        The route to the script

    Returns
    -------
    str | None
        The script or None
    """
    try:
        with open(self.scripts[route.replace("/scripts", "")], "r") as file:
            return file.read()
    except (FileNotFoundError, KeyError):
        return None

serve_static(route)

Serve the static files

Arguments

route: str The route to the static file

Returns:

Type Description
tuple[bytes, str] | tuple[bytes, Literal['text/plain']] | None

The static file or None
Source code in emuleo/http.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def serve_static(
    self, route: str
) -> tuple[bytes, str] | tuple[bytes, t.Literal["text/plain"]] | None:
    """
    Serve the static files

    Arguments
    ---------
    route: str
        The route to the static file

    Returns
    -------
    tuple[bytes, str] | tuple[bytes, t.Literal["text/plain"]] | None
        The static file or None
    """
    try:
        with open(self.static[route.replace("/static", "")], "rb") as file:
            mime_type, _ = mimetypes.guess_type(
                self.static[route.replace("/static", "")]
            )
            if mime_type:
                return file.read(), mime_type
            return file.read(), "text/plain"
    except (FileNotFoundError, KeyError):
        return None

serve_styles(route) async

Serve the styles

Arguments

route: str The route to the style

Returns:

Type Description
str | None

The style or None
Source code in emuleo/http.py 
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
async def serve_styles(self, route: str) -> str | None:
    """
    Serve the styles

    Arguments
    ---------
    route: str
        The route to the style

    Returns
    -------
    str | None
        The style or None
    """
    try:
        with open(self.styles[route.replace("/styles", "")], "r") as file:
            return file.read()
    except (FileNotFoundError, KeyError):
        return None