การเพิ่มโค้ดใน __init__.py

ฉันกำลังดูว่าระบบโมเดลใน django ทำงานอย่างไรและฉันสังเกตเห็นบางสิ่งที่ฉันไม่เข้าใจ

ฉันรู้ว่าคุณสร้าง__init__.pyไฟล์ว่างเพื่อระบุว่าไดเร็กทอรีปัจจุบันเป็นแพ็กเกจ และคุณสามารถตั้งค่าตัวแปร__init__.pyเพื่อให้ import * ทำงานได้อย่างถูกต้อง

แต่ django เพิ่มคำสั่ง from ... import ... และกำหนดกลุ่มของคลาสใน__init__.py. ทำไม? สิ่งนี้ไม่ทำให้สิ่งต่างๆดูยุ่งเหยิง? มีเหตุผลที่ต้องใช้รหัสนี้__init__.pyหรือไม่?

การนำเข้าทั้งหมด__init__.pyจะพร้อมใช้งานเมื่อคุณอิมพอร์ตแพ็กเกจ (ไดเร็กทอรี) ที่มีอยู่

ตัวอย่าง:

./dir/__init__.py:

import something

./test.py:

import dir
# can now use dir.something

แก้ไข: ลืมพูดถึงรหัสในการ__init__.pyทำงานในครั้งแรกที่คุณนำเข้าโมดูลจากไดเร็กทอรีนั้น ดังนั้นจึงเป็นจุดที่ดีที่จะใส่รหัสเริ่มต้นระดับแพ็คเกจ

แก้ไข 2: dgrant ชี้ให้เห็นถึงความสับสนที่อาจเกิดขึ้นในตัวอย่างของฉัน In __init__.py import somethingสามารถนำเข้าโมดูลใดก็ได้โดยไม่จำเป็นจากแพ็คเกจ ตัวอย่างเช่นเราสามารถแทนที่ด้วยimport datetimeจากนั้นในระดับบนสุดของเราtest.pyทั้งสองตัวอย่างเหล่านี้จะทำงาน:

import dir
print dir.datetime.datetime.now()

และ

import dir.some_module_in_dir
print dir.datetime.datetime.now()

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

เป็นเพียงความชอบส่วนบุคคลจริงๆและเกี่ยวข้องกับรูปแบบของโมดูลหลามของคุณ

erikutilsสมมติว่าคุณมีโมดูลที่เรียกว่า มีสองวิธีที่สามารถเป็นโมดูลได้ไม่ว่าคุณจะมีไฟล์ชื่อerikutils.pyในไดเร็กทอรีของคุณsys.pathหรือคุณมีไดเร็กทอรีชื่อerikutilsในไฟล์ของคุณsys.pathโดยมี__init__.pyไฟล์ว่างอยู่ แล้วสมมติว่าคุณมีพวงของโมดูลที่เรียกว่าfileutils, procutils, และคุณต้องการผู้ที่จะเป็นโมดูลย่อยภายใต้parseutils erikutilsคุณจึงสร้างไฟล์. py ชื่อfileutils.py , procutils.pyและparseutils.py :

erikutils
  __init__.py
  fileutils.py
  procutils.py
  parseutils.py

บางทีคุณอาจจะมีฟังก์ชั่นบางอย่างที่เพียงแค่ไม่ได้อยู่ในfileutils, procutilsหรือparseutilsโมดูล miscutilsและขอบอกว่าคุณไม่รู้สึกเหมือนการสร้างโมดูลใหม่ที่เรียกว่า และคุณต้องการเรียกใช้ฟังก์ชันดังนี้:

erikutils.foo()
erikutils.bar()

แทนที่จะทำ

erikutils.miscutils.foo()
erikutils.miscutils.bar()

ดังนั้นเนื่องจากerikutilsโมดูลเป็นไดเร็กทอรีไม่ใช่ไฟล์เราจึงต้องกำหนดฟังก์ชันภายในไฟล์__init__.pyไฟล์

ใน Django django.db.models.fieldsตัวอย่างที่ดีที่สุดที่ฉันสามารถคิดคือ ALL Django * การเรียนสนามกำหนดไว้ใน__init__.pyแฟ้มในDjango / DB / รุ่น / เขตไดเรกทอรี ผมคิดว่าพวกเขาทำอย่างนี้เพราะพวกเขาไม่ต้องการที่จะยัดทุกอย่างเป็นสมมุติDjango / DB / รุ่น / fields.pyรูปแบบเพื่อให้พวกเขาแยกมันออกไปไม่กี่ submodules A ( related.py , files.pyตัวอย่างเช่น) และ พวกเขาติดคำนิยามฟิลด์ * ที่สร้างไว้ในโมดูลฟิลด์เอง (ด้วยเหตุนี้__init__.py)

การใช้__init__.pyไฟล์ช่วยให้คุณสามารถทำให้โครงสร้างแพ็คเกจภายในมองไม่เห็นจากภายนอก หากโครงสร้างภายในเปลี่ยนไป (เช่นเนื่องจากคุณแยกโมดูลไขมันหนึ่งออกเป็นสองโมดูล) คุณจะต้องปรับเปลี่ยน__init__.pyไฟล์เท่านั้น แต่ไม่ใช่โค้ดที่ขึ้นอยู่กับแพ็กเกจ คุณยังสามารถทำให้บางส่วนของแพ็กเกจของคุณมองไม่เห็นได้เช่นหากไม่พร้อมสำหรับการใช้งานทั่วไป

โปรดทราบว่าคุณสามารถใช้delคำสั่งได้ดังนั้นโดยทั่วไป__init__.pyอาจมีลักษณะดังนี้:

from somemodule import some_function1, some_function2, SomeObject

del somemodule

ตอนนี้ถ้าคุณตัดสินใจที่จะแยกsomemoduleใหม่__init__.pyอาจเป็น:

from somemodule1 import some_function1, some_function2
from somemodule2 import SomeObject

del somemodule1
del somemodule2

จากภายนอกแพ็คเกจยังดูเป๊ะเหมือนเดิม