python dependency injector

Dependency Injector คืออะไร?

Dependency Injector เป็นเฟรมเวิร์กการฉีดการพึ่งพาสำหรับ Python

ช่วยนำหลักการฉีดพึ่งพามาใช้

คุณสมบัติที่สำคัญของ Dependency Injector :

• ผู้ให้บริการ ให้ผู้ให้บริการ Factory , Singleton , Callable , Coroutine , Object , List , Dict , Configuration , Resource , Dependency และ Selector ที่ช่วยรวบรวมวัตถุของคุณ ดูผู้ให้บริการ
• การเอาชนะ สามารถแทนที่ผู้ให้บริการรายใดรายหนึ่งโดยผู้ให้บริการรายอื่นได้ทันที ซึ่งช่วยในการทดสอบและกำหนดค่าสภาพแวดล้อม dev/stage เพื่อแทนที่ไคลเอ็นต์ API ด้วย stub ฯลฯ โปรดดูการแทนที่ผู้ให้บริการ
• การกำหนดค่า อ่านการกำหนดค่าจากไฟล์ yaml , ini และ json การตั้งค่า pydantic ตัวแปรสภาพแวดล้อม และพจนานุกรม ดูผู้ให้บริการการกำหนดค่า
• ทรัพยากร . ช่วยในการเริ่มต้นและการกำหนดค่าการบันทึก ลูปเหตุการณ์ เธรดหรือพูลกระบวนการ ฯลฯ สามารถใช้สำหรับขอบเขตการดำเนินการต่อฟังก์ชันควบคู่กับการเดินสาย ดูผู้ให้บริการทรัพยากร
• ตู้คอนเทนเนอร์ จัดเตรียมคอนเทนเนอร์ที่ประกาศและไดนามิก ดูตู้คอนเทนเนอร์
• การเดินสายไฟ แทรกการพึ่งพาลงในฟังก์ชันและวิธีการ ช่วยผสานรวมกับเฟรมเวิร์กอื่นๆ: Django, Flask, Aiohttp, Sanic, FastAPI ฯลฯ ดูการเดินสายไฟ
• แบบอะซิงโครนัส รองรับการฉีดแบบอะซิงโครนัส ดูการฉีดแบบอะซิงโครนัส
• กำลังพิมพ์ ให้ต้นขั้วการพิมพ์ mypy เป็นมิตร ดูการพิมพ์และ mypy
• ผลงาน . เร็ว. เขียนใน Cython
• วุฒิภาวะ . ครบกำหนดและพร้อมสำหรับการผลิต มีการทดสอบ เอกสาร และการสนับสนุนอย่างดี

 from dependency_injector import containers , providers
from dependency_injector . wiring import Provide , inject


class Container ( containers . DeclarativeContainer ):

    config = providers . Configuration ()

    api_client = providers . Singleton (
        ApiClient ,
        api_key = config . api_key ,
        timeout = config . timeout ,
    )

    service = providers . Factory (
        Service ,
        api_client = api_client ,
    )


@ inject
def main ( service : Service = Provide [ Container . service ]) -> None :
    ...


if __name__ == "__main__" :
    container = Container ()
    container . config . api_key . from_env ( "API_KEY" , required = True )
    container . config . timeout . from_env ( "TIMEOUT" , as_ = int , default = 5 )
    container . wire ( modules = [ __name__ ])

    main ()  # <-- dependency is injected automatically

    with container . api_client . override ( mock . Mock ()):
        main ()  # <-- overridden dependency is injected automatically

เมื่อคุณเรียกใช้ฟังก์ชัน main() การพึ่งพา Service จะถูกประกอบและฉีดเข้าไปโดยอัตโนมัติ

เมื่อคุณทำการทดสอบ คุณจะเรียกใช้เมธอด container.api_client.override() เพื่อแทนที่ไคลเอ็นต์ API จริงด้วยการจำลอง เมื่อคุณโทร main() การเยาะเย้ยจะถูกฉีดเข้าไป

คุณสามารถแทนที่ผู้ให้บริการรายใดรายหนึ่งกับผู้ให้บริการรายอื่นได้

นอกจากนี้ยังช่วยคุณในการกำหนดค่าโปรเจ็กต์ใหม่สำหรับสภาพแวดล้อมที่แตกต่างกัน: แทนที่ไคลเอนต์ API ด้วย stub บน dev หรือสเตจ

ด้วย Dependency Injector การประกอบวัตถุจะถูกรวมไว้ในคอนเทนเนอร์ การฉีดการพึ่งพาถูกกำหนดไว้อย่างชัดเจน ทำให้ง่ายต่อการเข้าใจและเปลี่ยนแปลงวิธีการทำงานของแอปพลิเคชัน

ไปที่เอกสารเพื่อทราบข้อมูลเพิ่มเติมเกี่ยวกับการพึ่งพาการฉีดและการผกผันของการควบคุมใน Python

การติดตั้ง

แพ็คเกจนี้มีอยู่ใน PyPi:

 pip ติดตั้งหัวฉีดพึ่งพา

เอกสารประกอบ

เอกสารมีอยู่ที่นี่

ตัวอย่าง

เลือกอย่างใดอย่างหนึ่งต่อไปนี้:

• ตัวอย่างการใช้งาน (ภาชนะเดียว)
• ตัวอย่างการใช้งาน (หลายคอนเทนเนอร์)
• ตัวอย่างแพ็คเกจแยกส่วน (หลายคอนเทนเนอร์)
• ตัวอย่าง Boto3
• ตัวอย่างของจังโก้
• ตัวอย่างขวด
• ตัวอย่าง Aiohttp
• ตัวอย่างซานิค
• ตัวอย่าง FastAPI
• ตัวอย่าง FastAPI + Redis
• ตัวอย่าง FastAPI + SQLAlchemy

บทช่วยสอน

เลือกอย่างใดอย่างหนึ่งต่อไปนี้:

• บทช่วยสอนการใช้เว็บแอปพลิเคชัน Flask
• บทช่วยสอน Aiohttp REST API
• บทช่วยสอนการตรวจสอบ Daemon ของ Asyncio
• บทช่วยสอนการใช้งาน CLI

แนวคิด

กรอบการทำงานนี้ตั้งอยู่บนหลักการ PEP20 (The Zen of Python):

Explicit is better than implicit

คุณต้องระบุวิธีการประกอบและตำแหน่งที่จะแทรกการขึ้นต่อกันอย่างชัดเจน

พลังของกรอบการทำงานอยู่ที่ความเรียบง่าย Dependency Injector เป็นเครื่องมือง่ายๆ สำหรับแนวคิดอันทรงพลัง

คำถามที่พบบ่อย

การฉีดพึ่งพาคืออะไร?

• การฉีดพึ่งพาเป็นหลักการที่ลดการมีเพศสัมพันธ์และเพิ่มการทำงานร่วมกัน

เหตุใดฉันจึงควรฉีดการพึ่งพา?

• รหัสของคุณจะมีความยืดหยุ่น ทดสอบได้ และชัดเจนมากขึ้น ?

ฉันจะเริ่มใช้การฉีดพึ่งพาได้อย่างไร

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

ฉันต้องจ่ายราคาเท่าไหร่และได้อะไร?

• คุณต้องระบุการขึ้นต่อกันอย่างชัดเจน
• มันจะเป็นงานพิเศษในช่วงเริ่มต้น
• มันจะให้ผลตอบแทนเมื่อโครงการเติบโตขึ้น

มีคำถาม?

• เปิดปัญหา Github

พบข้อผิดพลาดหรือไม่?

• เปิดปัญหา Github

ต้องการความช่วยเหลือ?

• ️ ติดดาว Dependency Injector บน Github
• - เริ่มต้นโปรเจ็กต์ใหม่ด้วย Dependency Injector
• บอกเพื่อนของคุณเกี่ยวกับ Dependency Injector

ต้องการที่จะมีส่วนร่วม?

• - แยกโครงการ
• ⬅️ เปิดคำขอดึงไปที่สาขา develop