Flask-Admin से आ रहे हैं

starlette-admin की शुरुआत Flask-Admin की concepts को ASGI ecosystem में port करने से हुई थी, इसलिए migration सीधा रहता है। आप फिर भी एक ModelView subclass करते हैं, उसे class attributes से कॉन्फ़िगर करते हैं, और एक Admin instance पर register करते हैं। ज़्यादातर काम attributes के नाम बदलने और Flask के implicit request context से Starlette के explicit request object पर आने का है।

यह guide Flask-Admin API को attribute-दर-attribute उसके starlette-admin समकक्ष से मैप करती है।

मानसिक मॉडल

सेटअप

from flask import Flask
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView

app = Flask(__name__)
admin = Admin(app, name="My Admin", template_mode="bootstrap4")
admin.add_view(ModelView(Post, db.session))

from starlette.applications import Starlette
from starlette_admin.contrib.sqla import Admin, ModelView

app = Starlette()  # or FastAPI()
admin = Admin(engine, title="My Admin", secret_key="change-me")
admin.add_view(ModelView(Post))
admin.mount_to(app)

यहाँ कोई template_mode switch नहीं है। UI Tabler (Bootstrap 5) उपयोग करता है और डार्क मोड शामिल है। दिखावट बदलने के लिए कस्टम BaseTheme लिखें या templates override करें।

लिस्ट पेज की attributes

फ़ॉर्म attributes

एक्सपोर्ट और इंपोर्ट

class PostView(ModelView):
    can_export = True
    export_types = ["csv", "xlsx"]
    export_max_rows = 10000

class PostView(ModelView):
    exporters = ["csv", "xlsx", "pdf"]
    importers = ["csv", "xlsx"]
    exclude_fields_from_export = ["internal_notes"]

CSV और JSON एक्सपोर्ट डिफ़ॉल्ट रूप से चालू रहते हैं। Row caps अपने-आप लागू होते हैं, और spreadsheet formula escaping exporter की opt-in setting है। इंपोर्ट, जो Flask-Admin देता ही नहीं है, में प्रति-पंक्ति सत्यापन वाला preview step और primary key से existing records के optional अपडेट शामिल हैं। Export और Import देखें।

एक्शन

from flask_admin.actions import action


class PostView(ModelView):
    @action("publish", "Publish", "Publish selected posts?")
    def action_publish(self, ids):
        query = Post.query.filter(Post.id.in_(ids))
        for post in query.all():
            post.published = True

from starlette_admin import ActionSelection, action, flash


class PostView(ModelView):
    actions = ["publish", "delete"]

    @action(
        name="publish",
        text="Publish",
        confirmation="Publish selected posts?",
    )
    async def publish(self, request: Request, selection: ActionSelection) -> None:
        for post in await selection.rows():
            post.published = True
        flash(request, "Posts published")

Handler को raw IDs की जगह एक ActionSelection object मिलता है। वह rows lazily resolve करता है, active filters expose करता है, और जब user pages के पार सभी matching records select करता है तब भी इसी तरह काम करता है। एक्शन confirmation dialog के अंदर कस्टम HTML फ़ॉर्म भी render कर सकते हैं। प्रति-पंक्ति operations के लिए @row_action और @link_row_action custom column formatters की जगह लेते हैं।

अनुमतियाँ और access control

Flask-Admin के can_* class flags starlette-admin में per-request methods बन जाते हैं, इसलिए authorization निर्णय signed-in user पर निर्भर हो सकते हैं।

Flask-Admin में Flask-Login आप ख़ुद integrate करते हैं। starlette-admin ready-made sign-in page वाला एक AuthProvider देता है, और आप login, logout और authenticate methods अपने user store के आधार पर implement करते हैं। OAuthProvider OIDC redirect flows cover करता है। Signed-in user हर जगह request.state.admin_user के रूप में उपलब्ध रहता है।

Model lifecycle हुक

Per-view हुक से आगे, event system किसी एक handler को हर view observe करने देता है। Flask-Admin का कोई समकक्ष नहीं है।

from starlette_admin.events import AdminEvent, AfterCreateContext


async def audit(ctx: AfterCreateContext) -> None: ...


admin.events.on(AdminEvent.AFTER_CREATE, audit)

कस्टम views और index page

इनलाइन मॉडल

class ArticleView(ModelView):
    inline_models = [Comment]

from starlette_admin.contrib.sqla import InlineModelView, ModelView


class CommentInline(InlineModelView):
    model = Comment
    fields = ["author", "body"]


class ArticleView(ModelView):
    inlines = [CommentInline]

Explicit class हर inline model को पूरी ModelView कॉन्फ़िगरेशन surface देता है: field selection, सत्यापन और composite foreign key समर्थन। Inline Forms देखें।

अंतर्राष्ट्रीयकरण

Flask-Admin Flask-Babel और उसके आस-पास के Flask environment पर निर्भर करता है। starlette-admin इसकी जगह एक कॉन्फ़िगरेशन object उपयोग करता है:

from starlette_admin import I18nConfig

admin = Admin(engine, i18n_config=I18nConfig(default_locale="fr"))

Timezone-aware datetime rendering भी इसी तरह चलता है, TimezoneConfig के ज़रिए। अंतर्राष्ट्रीयकरण और Timezones देखें।

बदलने से आपको क्या मिलता है

• एक async स्टैक. FastAPI और Starlette पर नेटिव रूप से चलता है, async SQLAlchemy, Beanie और Tortoise ORM के समर्थन सहित। Flask-Admin synchronous है।
• इनबिल्ट security features. CSRF सुरक्षा, upload filename sanitization, image content verification और export row limits Admin instantiate करते ही चालू हो जाती हैं, और आप exporters पर spreadsheet formula escaping enable कर सकते हैं। Security देखें।
• डेटा इंपोर्ट. Preview step कुछ भी लिखे जाने से पहले हर पंक्ति validate करता है। Flask-Admin में import फ़ीचर है ही नहीं।
• डैशबोर्ड widget system. Templates हाथ से लिखने की जगह Python में index pages और custom views बनाएँ।
• आधुनिक design. सक्रिय रूप से maintained codebase, polished UI, इनबिल्ट डार्क मोड और first-class type hints के साथ।

जिनसे आपको ढलना होगा

• Explicit request objects. कोई ambient request context नहीं होता। हर हुक और permission method को parameter के रूप में request मिलती है।
• Async handlers. हुक और एक्शन coroutines होते हैं, इसलिए blocking calls इनमें न रखें या वह काम thread में move कर दें।
• कोई FileAdmin नहीं. अगर आपका workflow server file system browse करने पर टिका है, तो starlette-admin इसे cover नहीं करता।
• कोई create या edit modal नहीं. फ़ॉर्म popup modals की जगह पूरे pages की तरह render होते हैं।