canonicalwebteam.flask base Download - canonicalwebteam.flask base Source Source Download

canonicalwebteam.flask base

โค้ดแหล่งที่มา AI

2.0.0: Merge pull request #72 from canonical

ดาวน์โหลด

ฐานขวด Webteam Canonical

ส่วนขยายของขวดที่ใช้การกำหนดค่าทั่วไปกับแอพ 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-responses เพื่อให้สามารถกำหนดค่าการเปลี่ยนเส้นทางได้ง่ายและกลับมาของการตอบสนองที่ถูกลบโดยการสร้าง redirects.yaml , permanent-redirects.yaml และ deleted.yaml ถาวรในไดเรกทอรีรากไซต์

เทมเพลตข้อผิดพลาด

FlaskBase สามารถเลือกใช้เทมเพลตเพื่อสร้างการตอบกลับข้อผิดพลาด 404 และ 500 :

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

สิ่งนี้จะนำไปสู่เช่น 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"
)

สิ่งนี้จะนำไปสู่เช่น http://localhost/favicon.ico การส่งกลับ 302 การเปลี่ยนเส้นทางไปยัง http://localhost/static/favicon.ico

เฉือนที่ชัดเจนต่อท้าย

ล้างสแลชต่อท้ายทั้งหมดจากทุกเส้นทางโดยอัตโนมัติ

ผู้ช่วย Jinja2

คุณได้รับผู้ช่วย Jinja2 สองคนที่จะใช้ในเทมเพลตของคุณจาก Flask-Base:

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 decorator
Cache-Control ถ้า response.cache_control.* ไม่ได้ตั้งค่าและตามเวอร์ชันสินทรัพย์แบบคงที่ (ดู versioned_static ด้านบน)

`security.txt` , `robots.txt` และ `humans.txt`

หากคุณสร้าง security.txt , robots.txt หรือ humans.txt ในรูทของโครงการของคุณสิ่งเหล่านี้จะถูกเสิร์ฟที่ /.well-known/security.txt , /robots.txt และ /humans.txt ตามลำดับ