ใช้ dotenv ในการพัฒนา

การพิมพ์ export สำหรับตัวแปรสิบตัวทุกครั้งที่เริ่มเซสชันทั้งน่าเบื่อและลืมได้ง่าย ไฟล์ .env ช่วยแก้ปัญหานี้สำหรับการทำงานภายในเครื่อง

ไฟล์ .env เป็นข้อความธรรมดาที่มีบรรทัดในรูป KEY=ค่า ไฟล์นี้อยู่ที่โฟลเดอร์รากของโครงการและป้อนตัวแปรให้โดยอัตโนมัติ

แพ็กเกจ python-dotenv จะอ่านไฟล์นั้นและโหลดแต่ละบรรทัดเข้าสู่สภาพแวดล้อมให้คุณ

เรียกใช้ load_dotenv ตั้งแต่ช่วงต้น ก่อนอ่านการตั้งค่าใด ๆ เพื่อให้ os.environ มีค่าจากไฟล์อยู่แล้ว

Flask รุ่นใหม่จะโหลด .env และ .flaskenv โดยอัตโนมัติเมื่อมี python-dotenv ติดตั้งอยู่ ดังนั้น flask run จึงทำงานได้ทันที

ใส่ตัวเลือกเฉพาะของ Flask เช่น FLASK_APP ไว้ใน .flaskenv และเก็บข้อมูลลับจริงไว้ใน .env แทน

เพิ่ม .env ลงใน .gitignore เพื่อไม่ให้ข้อมูลลับภายในเครื่องของคุณถูกส่งไปยังคลังโค้ดโดยไม่ตั้งใจ

คอมมิตไฟล์ .env.example ที่แสดงคีย์ที่จำเป็นพร้อมค่าว่างหรือค่าตัวอย่าง เพื่อให้เพื่อนร่วมทีมทราบว่าต้องตั้งค่าอะไร

ตามค่าเริ่มต้น load_dotenv จะไม่เขียนทับตัวแปรที่ตั้งไว้ในสภาพแวดล้อมจริงอยู่แล้ว ซึ่งช่วยรักษาความปลอดภัยของระบบใช้งานจริง

ให้ถือว่า .env เป็นเพียงความสะดวกสำหรับการพัฒนาเท่านั้น ในสภาพแวดล้อมใช้งานจริง ให้แพลตฟอร์มเป็นผู้ใส่ตัวแปรสภาพแวดล้อมจริงแทน

ไฟล์ .env รองรับความคิดเห็นที่ขึ้นต้นด้วย # และการใส่เครื่องหมายคำพูดครอบค่าที่มีช่องว่าง คล้ายกับรูปแบบการตั้งค่าขนาดเล็ก

คุณจัดเก็บการตั้งค่าในเครื่องไว้ในไฟล์ .env โหลดไฟล์ด้วย python-dotenv เพิ่มไฟล์ลงใน gitignore และแบ่งปันตัวอย่างที่ปลอดภัยแล้ว 🧪