home

หน้าแรก
 Computer >> บทช่วยสอนคอมพิวเตอร์ >  >> การเขียนโปรแกรม >> Python

Convention โครงสร้าง Python Module/Package (PEP 8 / Community Standard)

อ้างอิง samplemod โครงสร้างมาตรฐานที่ยอมรับกว้าง

โครงสร้าง


README.rst
LICENSE
setup.py
requirements.txt
sample/
    __init__.py
    core.py
    helpers.py
docs/
    conf.py
    index.rst
tests/
    test_basic.py
    test_advanced.py

รายละเอียด

  • README.rst: Overview, Install, Usage
  • LICENSE: License Text
  • setup.py: Build/Install Entry Point
  • requirements.txt: Dev/Test/Docs Dependencies
  • docs/: Documentation Source
  • tests/: Test Suite (Mirror Package Structure)
  • sample/: Actual Package Code (__init__.py ทำให้เป็น Package)

หลักการ

  • Package Code อยู่ในโฟลเดอร์ชื่อ Package (ไม่ใช่ src/)
  • Single File Module → sample.py ที่ Root
  • ใช้ src/ layout ได้แต่ Complex มากกว่า (PEP 420 / Modern Packaging)