تنزيل canonicalwebteam.flask base - canonicalwebteam.flask base Source Code

canonicalwebteam.flask base

كود الذكاء الاصطناعي

2.0.0: Merge pull request #72 from canonical

تنزيل

قاعدة قارورة WebTeam Canonical

تمديد Flask الذي يطبق التكوينات الشائعة على جميع تطبيقات Flask الخاصة بـ WebTeam.

الاستخدام

 from canonicalwebteam . flask_base . app import FlaskBase

app = FlaskBase ( __name__ , "app.name" )

أو:

 from canonicalwebteam . flask_base . app import FlaskBase

app = FlaskBase (
    __name__ ,
    "app.name" ,
    template_404 = "404.html" ,
    template_500 = "500.html" ,
    favicon_url = "/static/favicon.ico" ,
)

التنمية المحلية

للتنمية المحلية ، من الأفضل اختبار هذه الوحدة مع أحد مشاريع موقع الويب لدينا مثل ubuntu.com. لمزيد من المعلومات ، اتبع هذا الدليل (داخلي فقط).

سمات

Proxyfix

يتضمن FlaskBase ProxyFix لتجنب تجريد SSL على إعادة التوجيه.

إعادة التوجيه والمسارات المحذوفة

يستخدم FlaskBase مراسلات yaml للسماح بسهولة تكوين عمليات إعادة التوجيه وإرجاع الاستجابات المحذوفة ، من خلال إنشاء redirects.yaml ، permanent-redirects.yaml والتحذف. deleted.yaml في دليل جذر الموقع.

قوالب الخطأ

يمكن لـ FlaskBase استخدام القوالب اختياريًا لإنشاء استجابات الخطأ 404 و 500 :

 app = FlaskBase (
    __name__ ,
    "app.name" ,
    template_404 = "404.html" ,
    template_500 = "500.html" ,
)

سيؤدي ذلك إلى EG http://localhost/non-existent-path بإعادة حالة 404 مع محتويات templates/404.html .

إعادة توجيه /favicon.ico

يمكن أن توفر FlaskBase اختياريًا إعادة توجيه للمسارات التي تم الاستعلام عنها بشكل شائع /favicon.ico ، /robots.txt و /humans.txt إلى مواقع معقولة:

 from canonicalwebteam . flask_base . app import FlaskBase

app = FlaskBase (
    __name__ ,
    "app.name" ,
    template_404 = "404.html" ,
    template_500 = "500.html" ,
    favicon_url = "/static/favicon.ico" ,
    robots_url = "/static/robots.txt" ,
    humans_url = "/static/humans.txt"
)

سيؤدي ذلك إلى eg http://localhost/favicon.ico إعادة توجيه 302 إلى http://localhost/static/favicon.ico .

واضحة الخلايا المائلة

يقوم تلقائيًا بمسح جميع القطع المقطوعة من جميع الطرق.

مساعدين Jinja2

يمكنك الحصول على اثنين من مساعدي Jinja2 لاستخدامها في القوالب الخاصة بك من القاعدة القميص:

now وظيفة تخرج التاريخ الحالي في التنسيق الذي تم تمريره - {{ now('%Y') }} -> YYYY
versioned_static هي وظيفة تقوم بصمات الأصابع التي تم تمريرها - {{ versioned_static('asset.js') }} -> static/asset?v=asset-hash

رؤوس HTTP

تحصل على الرؤوس التالية تلقائيًا:

X-Content-Type-Options: NOSNIFF
Permissions-Policy: interest-cohort=()
X-Frame-Options: SAMEORIGIN ، والذي يمكن exclude_xframe_options_header
Cache-Control if response.cache_control.* لم يتم تعيينه ووفقًا لإصدار الأصول الثابتة (انظر versioned_static أعلاه)

`security.txt` و `robots.txt` و `humans.txt`

إذا قمت بإنشاء security.txt أو robots.txt أو humans.txt في جذر مشروعك ، فسيتم تقديمها على /.well-known/security.txt nownload/security.txt و /robots.txt و /humans.txt على التوالي.

`/_status/check` نقطة النهاية

يضيف تلقائيًا نقطة النهاية /_status/check التي يتم استخدامها بواسطة آثار المحتوى لفحص الصحة الخلفية أو على سبيل المثال بواسطة K8s للتحقق من حالة القرون.