Using TABLE_REGISTRY to automatically add tables to admin

[BrianLYS]

class DatabaseController(Controller):
    """DatabaseController."""

    path = "/"

    # mounting Piccolo Admin
    @asgi("/admin/", is_mount=True)
    async def admin(self: "DatabaseController", scope: "Scope", receive: "Receive", send: "Send") -> None:
        """Piccolo Admin."""
        # TODO: See if I can use APP_CONFIG.table_classes instead of adding tables manually
        # await create_admin(tables=[APP_CONFIG.table_classes])(scope, receive, send)
        await create_admin(
            tables=TABLE_REGISTRY
            # tables=[
            #     Task,
            #     BaseUser,
            #     SessionsBase,
            #     # Domain
            #     # Customer,
            #     # Invoice,
            #     # Status,
            #     # Label,
            #     # Priority,
            #     # InvoiceItem,
            #     # InvoiceToLabel,
            #     # # Organisation
            #     # Project,
            #     # Workspace,
            #     # Organisation,
            #     # OrganisationFile,
            #     # # Pages
            #     # PageNode,
            #     # page_config,
            # ],
        )(
            scope,
            receive,
            send,
        )

Recently the amount of tables that i have to add to the admin has started to get pretty large and I realised that I can use from piccolo.table import TABLE_REGISTRY instead to do this instead of manually adding like in the docs.

Is there ever a reason to not do this because I realise that the docs don't talk about doing this.

[dantownsend]

@BrianLYS Yes, using TABLE_REGISTRY should work OK.

The only downside is it literally pulls in every table (including things like Migration which you might not want, but it's not a huge deal).

Another solution, if using Piccolo Apps, is to do something like:

from my_app.piccolo_app import APP_CONFIG as APP_CONFIG_1
from my_other_app.piccolo_app import APP_CONFIG as APP_CONFIG_2

create_admin(tables=[*APP_CONFIG_1, *APP_CONFIG_2])

[BrianLYS]

Amazing thank you for the help!
Previously I wasn't able to get APP_CONFIG method to work, the '*' fixed it for me.

from domain.finance.piccolo_app import APP_CONFIG as APP_CONFIG_FINANCE
from domain.organisations.piccolo_app import APP_CONFIG as APP_CONFIG_ORGANISATIONS
from domain.pages.piccolo_app import APP_CONFIG as APP_CONFIG_PAGES
from domain.tasks.piccolo_app import APP_CONFIG as APP_CONFIG_TASKS

class DatabaseController(Controller):
    """DatabaseController."""

    path = "/"

    # mounting Piccolo Admin
    @asgi("/admin/", is_mount=True)
    async def admin(self: "DatabaseController", scope: "Scope", receive: "Receive", send: "Send") -> None:
        """Piccolo Admin."""
        # Alt: Use `piccolo.table import TABLE_REGISTRY` and place `TABLE_REGISTRY` in the tables[] to get all
        await create_admin(
            tables=[
                *APP_CONFIG_FINANCE.table_classes,
                *APP_CONFIG_TASKS.table_classes,
                *APP_CONFIG_ORGANISATIONS.table_classes,
                *APP_CONFIG_PAGES.table_classes,
            ],
        )(
            scope,
            receive,
            send,
        )