ฉันจะจัดระเบียบซอร์สโค้ด Python ได้อย่างไร [ปิด]

ฉันกำลังเริ่มต้นกับ Python (ถึงเวลาแล้วที่ฉันจะยิงมัน) และฉันกำลังมองหาแนวทางปฏิบัติที่ดีที่สุด

โครงการแรกของฉันคือคิวที่เรียกใช้การทดสอบบรรทัดคำสั่งในหลายเธรด ฉันเริ่มได้main.pyไฟล์ที่ยาวมากและฉันต้องการแยกไฟล์ออก โดยทั่วไปฉันกำลังมองหา: โปรแกรมเมอร์ python จะจัดระเบียบไฟล์ซอร์สหลายไฟล์ได้อย่างไร มีโครงสร้างเฉพาะที่เหมาะกับคุณหรือไม่?

คำถามเฉพาะของฉัน ได้แก่ :

1. แต่ละคลาสควรอยู่ในไฟล์แยกกันหรือไม่?
2. ฉันจะจัดการทดสอบหน่วยที่เกี่ยวข้องกับซอร์สโค้ดได้อย่างไร
3. ฉันควรใส่ข้อคิดเห็นเกี่ยวกับเอกสารไว้ที่ใดโดยเฉพาะสำหรับการดำเนินการบรรทัดคำสั่ง
4. หากฉันใช้หลายไดเรกทอรีฉันจะนำเข้าคลาสระหว่างพวกเขาได้อย่างไร

ฉันอาจจะสามารถวาดบางส่วนของข้อสรุปของตัวเองที่นี่โดยการทดลองและข้อผิดพลาด แต่ผมอยากจะเริ่มต้นจากสิ่งที่ดี

บทความเอริคชี้จะเป็นที่น่ากลัวเพราะมันมีรายละเอียดของการจัดขนาดใหญ่ฐานรหัสหลาม

หากคุณมาที่นี่จาก Google และกำลังพยายามหาวิธีแยกไฟล์ต้นฉบับขนาดใหญ่หนึ่งไฟล์ออกเป็นไฟล์หลายไฟล์ที่จัดการได้มากขึ้นฉันจะสรุปกระบวนการโดยย่อ

สมมติว่าคุณมีทุกอย่างในไฟล์ที่เรียกว่าmain.py:

• สร้างซอร์สไฟล์อื่นในโฟลเดอร์เดียวกัน (ขอเรียกเราว่าutils.pyเป็นตัวอย่างนี้)
• ย้ายคลาสฟังก์ชันคำสั่งและอื่น ๆ ที่คุณต้องการจากmain.pyเข้าไปutils.py
• ในการmain.pyเพิ่มบรรทัดเดียวที่ด้านบน:import utils

แนวคิดสิ่งนี้คือการสร้างโมดูลใหม่ที่เรียกว่าutilsในซอร์สไฟล์อื่น จากนั้นคุณสามารถนำเข้าได้ทุกที่ที่ต้องการ

วิธีที่คุณควรจัดระเบียบโค้ดและการทดสอบนั้นเหมือนกับที่คุณทำกับภาษา OO ทุกประการ

คำตอบจากวิธีที่ฉันทำ อาจไม่ถูกต้อง แต่ใช้ได้กับฉัน

1. ขึ้นอยู่กับวิธีการแยกฟังก์ชันการทำงานของคุณ สำหรับแอป python หลักของฉันฉันมี 1 ไฟล์ที่มีคลาสสำหรับจุดเข้าใช้งานจากนั้นแพ็กเกจของบิตการทำงานที่แตกต่างกัน
2. ฉันใช้ PyDev สำหรับ eclipse และจัดระเบียบเหมือนที่ฉันทำกับ Java

>  Workspace
>     |
>     |-Src
>     |   |-Package1
>     |   |-Package2
>     |   |-main.py
>     |-Test
>         |-TestPackage1
>         |-TestPackage2

3. ใช้ DocString ทุกที่เพื่อติดตามทุกสิ่ง
4. หลังจากตรวจสอบให้แน่ใจว่า__init__.pyไฟล์ที่เกี่ยวข้องอยู่ในโฟลเดอร์ มันเป็นเพียงกรณีง่ายๆของfrom module import class