Skip to content

SSG

SSG class to create a static site generator

Arguments

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

Attributes:

Name Type Description
pages dict[str, Path]

Dictionary of routes and their corresponding pages
static Path

The static directory
scripts Path

The scripts directory
styles Path

The styles directory
server dict[str, Path]

Dictionary of routes and their corresponding server files
Source code in vivid/http.py 
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
class SSG:
    """
    SSG class to create a static site generator

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

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

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

    async def get_templates_with_data(
        self,
    ) -> AsyncGenerator[dict[str, tuple[Path, dict[str, t.Any] | None]], None]:
        """
        Get the templates with their corresponding data

        Arguments
        ---------
        None

        Yields
        ------
        dict[str, tuple[Path, dict[str, typing.Any] | None]]
            The templates with their corresponding data
        """
        for page in self.pages:
            if page == "/404" or page == "/500":
                yield {page: (self.pages[page], None)}
            else:
                if self.server.get(page):
                    mod = await load_server(self.server[page])
                    if mod:
                        data = await get_static_load_data(mod)
                        if data:
                            yield {page: (self.pages[page], data.body)}
                        else:
                            yield {page: (self.pages[page], None)}
                    else:
                        yield {page: (self.pages[page], None)}
                else:
                    yield {page: (self.pages[page], None)}

    async def build(self, dest: Path) -> None:
        """
        Build the static site

        Arguments
        ---------
        dest: Path
            The destination directory

        Returns
        -------
        None
        """
        console.print(f"[#8B5CF6 bold]🔨 Building to {dest.as_posix()}[/#8B5CF6 bold]\n")
        async for pageAndData in self.get_templates_with_data():
            for page, (template, data) in pageAndData.items():
                body = return_template(template)
                if body:
                    if data:
                        _body = render_template(body, data)
                        if isinstance(_body, Exception):
                            raise _body
                        try:
                            create_file_from_route(page, _body, dest)
                            console.print(f"[#0EA5E9]✅ {page} created[/#0EA5E9]")
                        except Exception:
                            console.print_exception()
                    else:
                        try:
                            console.print(f"[#0EA5E9]✅ {page} created[/#0EA5E9]")
                            create_file_from_route(page, body, dest)
                        except Exception:
                            console.print_exception()
        try:
            console.print("[#8B5CF6 bold]🔨 Copying static files[/#8B5CF6 bold]")
            copy_static_files_to(self.static, dest / "static")
        except Exception:
            console.print_exception()
        finally:
            console.print("[#0EA5E9 bold]✅ Copied static[/#0EA5E9 bold]")
        try:
            console.print("[#8B5CF6 bold]🔨 Copying scripts[/#8B5CF6 bold]")
            copy_static_files_to(self.scripts, dest / "scripts")
        except Exception:
            console.print_exception()
        finally:
            console.print("[#0EA5E9 bold]✅ Copied scripts[/#0EA5E9 bold]")
        try:
            console.print("[#8B5CF6 bold]🔨 Copying styles[/#8B5CF6 bold]")
            copy_static_files_to(self.styles, dest / "styles")
        except Exception:
            console.print_exception()
        finally:
            console.print("[#0EA5E9 bold]✅ Copied styles[/#0EA5E9 bold]")
        console.print("[#8B5CF6 bold]\n✅ Build complete\n[/#8B5CF6 bold]")
        console.print("[#FACC15 bold]âš  Make sure to fix the srcs and hrefs of scripts and stlyes[/#FACC15 bold]")

build(dest) async

Build the static site

Arguments

dest: Path The destination directory

Returns:

Type Description
None
Source code in vivid/http.py 
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
async def build(self, dest: Path) -> None:
    """
    Build the static site

    Arguments
    ---------
    dest: Path
        The destination directory

    Returns
    -------
    None
    """
    console.print(f"[#8B5CF6 bold]🔨 Building to {dest.as_posix()}[/#8B5CF6 bold]\n")
    async for pageAndData in self.get_templates_with_data():
        for page, (template, data) in pageAndData.items():
            body = return_template(template)
            if body:
                if data:
                    _body = render_template(body, data)
                    if isinstance(_body, Exception):
                        raise _body
                    try:
                        create_file_from_route(page, _body, dest)
                        console.print(f"[#0EA5E9]✅ {page} created[/#0EA5E9]")
                    except Exception:
                        console.print_exception()
                else:
                    try:
                        console.print(f"[#0EA5E9]✅ {page} created[/#0EA5E9]")
                        create_file_from_route(page, body, dest)
                    except Exception:
                        console.print_exception()
    try:
        console.print("[#8B5CF6 bold]🔨 Copying static files[/#8B5CF6 bold]")
        copy_static_files_to(self.static, dest / "static")
    except Exception:
        console.print_exception()
    finally:
        console.print("[#0EA5E9 bold]✅ Copied static[/#0EA5E9 bold]")
    try:
        console.print("[#8B5CF6 bold]🔨 Copying scripts[/#8B5CF6 bold]")
        copy_static_files_to(self.scripts, dest / "scripts")
    except Exception:
        console.print_exception()
    finally:
        console.print("[#0EA5E9 bold]✅ Copied scripts[/#0EA5E9 bold]")
    try:
        console.print("[#8B5CF6 bold]🔨 Copying styles[/#8B5CF6 bold]")
        copy_static_files_to(self.styles, dest / "styles")
    except Exception:
        console.print_exception()
    finally:
        console.print("[#0EA5E9 bold]✅ Copied styles[/#0EA5E9 bold]")
    console.print("[#8B5CF6 bold]\n✅ Build complete\n[/#8B5CF6 bold]")
    console.print("[#FACC15 bold]âš  Make sure to fix the srcs and hrefs of scripts and stlyes[/#FACC15 bold]")

get_templates_with_data() async

Get the templates with their corresponding data

Arguments

None

Yields:

Type Description
dict[str, tuple[Path, dict[str, Any] | None]]

The templates with their corresponding data
Source code in vivid/http.py 
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
async def get_templates_with_data(
    self,
) -> AsyncGenerator[dict[str, tuple[Path, dict[str, t.Any] | None]], None]:
    """
    Get the templates with their corresponding data

    Arguments
    ---------
    None

    Yields
    ------
    dict[str, tuple[Path, dict[str, typing.Any] | None]]
        The templates with their corresponding data
    """
    for page in self.pages:
        if page == "/404" or page == "/500":
            yield {page: (self.pages[page], None)}
        else:
            if self.server.get(page):
                mod = await load_server(self.server[page])
                if mod:
                    data = await get_static_load_data(mod)
                    if data:
                        yield {page: (self.pages[page], data.body)}
                    else:
                        yield {page: (self.pages[page], None)}
                else:
                    yield {page: (self.pages[page], None)}
            else:
                yield {page: (self.pages[page], None)}