Kesan menaip dalam Python

Python versi 3.5 memperkenalkan "petua jenis" untuk menjadikan kod lebih mudah dibaca dan memudahkan pembangun memahami kod masing-masing.

Mengapakah pembayang jenis penting?

Dalam bahasa yang ditaip kuat seperti Java dan C, penyongsangan ketergantungan (DI - Penyongsangan Ketergantungan) ialah teknologi yang penting, tetapi sukar untuk dilaksanakan dalam bahasa yang ditaip lemah.

Idea teras penyongsangan kebergantungan ialah: kelas tidak seharusnya bergantung pada pelaksanaan tertentu, tetapi pada abstraksi. Kerana abstraksi (antara muka atau kelas abstrak) adalah kontrak yang agak stabil.

Contoh buruk:

class GasStation:
    def fill_tank(car, amount):
        car.fill(amount)

Dalam contoh ini, stesen minyak hanya boleh mengisi minyak kereta. Lebih memburukkan lagi keadaan, memandangkan fungsi fill_tank tidak mempunyai jenis yang ditentukan, sebarang nilai boleh dihantar dan ralat hanya akan ditemui semasa masa jalan.

Contoh yang baik:

from typing import Protocol

class Vehicle(Protocol):
    def fill(amount: int) -> None:
        ...
class GasStation:
    def fill_tank(vehicle: Vehicle, amount: int) -> None:
        vehicle.fill(amount)

Dalam contoh ini, tentukan dahulu kelas abstrak Vehicle (menggunakan typing.Protocol). Fungsi GasStation fill_tank tidak lagi bergantung pada kelas kereta tertentu, tetapi pada antara muka Vehicle, dengan itu menjadi lebih umum dan boleh mengisi minyak mana-mana kenderaan yang melaksanakan kaedah fill.

Apakah itu PyDIT?

Saya mengambil kesempatan daripada sistem pembayang jenis Python dan mencipta perpustakaan yang memudahkan penggunaan penyongsangan kebergantungan, dipanggil PyDIT (Python Dependency Injection with Types).

Andaikan anda memerlukan antara muka pangkalan data untuk menyimpan data pengguna Sama ada anda menggunakan PostgreSQL, MySQL, OracleDB, pangkalan data dalam memori atau pangkalan data NoSQL, anda perlu melaksanakan kelas sambungan pangkalan data dan menyediakan fungsi membaca, menulis dan memadam rekod. .

from time import sleep
from typing import TypedDict
from typing_extensions import override
from uuid import UUID
from src.configs.di import pydit
from src.adapters.repositories.interfaces.user import UserRepository
from src.constants.injection import MEMORY_REPOSITORY_CONFIG_TOKEN
from src.domain.user.models.user import UserModel


class ConfigType(TypedDict):
    delay: int


class MemoryUserRepository(UserRepository):

    __users: dict[UUID, UserModel] = {}

    def __init__(self):
        self.__delay = self.config.get("delay", 0.2)

    @pydit.inject(token=MEMORY_REPOSITORY_CONFIG_TOKEN)
    def config(self) -> ConfigType:  # TODO: supress return type error
        pass

    @override
    def get_by_id(self, *, id_: UUID) -> UserModel:
        sleep(self.__delay)

        user = self.__users.get(id_)

        if user is None:
            raise ValueError("User not found")

        return user

    @override
    def save(self, *, data: UserModel) -> None:
        sleep(self.__delay)
        self._check_pk_conflict(pk=data.id)

        self.__users[data.id] = data

    @override
    def list_(self) -> list[UserModel]:
        return list(self.__users.values())

    def _check_pk_conflict(self, *, pk: UUID) -> None:
        if pk not in self.__users:
            return

        raise ValueError("Primary key conflicts: DB alrady has a user with this ID")

Untuk memastikan kod itu tiada kaitan dengan teknologi pangkalan data, tentukan antara muka yang mesti diikuti oleh semua kelas pangkalan data:

from abc import abstractmethod
from typing import Protocol
from uuid import UUID
from src.domain.user.models.user import UserModel


class UserRepository(Protocol):
    @abstractmethod
    def get_by_id(self, *, id_: UUID) -> UserModel:
        pass

    @abstractmethod
    def save(self, *, data: UserModel) -> None:
        pass

    @abstractmethod
    def list_(self) -> list[UserModel]:
        pass

Seterusnya, mulakan kebergantungan untuk suntikan:

from src.adapters.repositories.in_memory.user import MemoryUserRepository
from src.constants.injection import MEMORY_REPOSITORY_CONFIG_TOKEN
from .di import pydit
from .get_db_config import get_db_config


def setup_dependencies():
    pydit.add_dependency(get_db_config, token=MEMORY_REPOSITORY_CONFIG_TOKEN)
    pydit.add_dependency(MemoryUserRepository, "UserRepository")

Akhir sekali, masukkan kebergantungan ke dalam modul yang mencipta pengguna:

from typing import cast
from src.adapters.repositories.interfaces.user import UserRepository
from src.configs.di import pydit
from src.domain.user.models.create_user import CreateUserModel
from src.domain.user.models.user import UserModel
from src.domain.user.services.create import CreateUserService
from src.domain.user.services.list import ListUsersService


class UserModule:
    @pydit.inject()
    def user_repository(self) -> UserRepository:
        return cast(UserRepository, None)

    def create(self, data: CreateUserModel) -> None:
        CreateUserService(self.user_repository).execute(data)

    def list_(self) -> list[UserModel]:
        return ListUsersService().execute()

Pergantungan disuntik sebagai sifat dan boleh diakses melalui self atau module.user_repository .

Contoh ini mudah, tetapi PyDIT boleh digunakan pada pelbagai konfigurasi projek, abstraksi kod dan senario prinsip SOLID. Selamat mencuba dan menyumbang kod!

Repositori kod: Github
LinkedIn: Marcelo Almeida (MrM4rc)
PyPI: python-pydit

Atas ialah kandungan terperinci Kesan menaip dalam Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!