Deply: pastikan seni bina python anda bersih

Projek Python yang besar sering berubah menjadi pangkalan kod kompleks yang sukar untuk dikekalkan. Menjejaki import, lapisan dan siapa yang bergantung pada siapa yang boleh cepat berubah menjadi huru-hara. Deply sedia membantu. Ia menganalisis struktur kod anda dan menguatkuasakan peraturan seni bina, memastikan projek Python anda kekal bersih, modular dan mudah diselenggara—walaupun ia berkembang.

Mengapa Penguatkuasaan Seni Bina Penting

Fleksibiliti Python memudahkan untuk memperkenalkan kod spageti jika kita tidak berhati-hati. Menambah modul baharu, penghias atau mengubah cara kelas yang diwarisi boleh memperkenalkan isu pergantungan yang halus merentas pasukan besar. Sempadan yang jelas—dikuatkuasakan oleh semakan automatik—membantu mengekalkan kualiti kod yang tinggi. Pendekatan ini meningkatkan kebolehbacaan dan produktiviti pasukan.

Apa Itu Deply?

Deply ialah alat kendiri yang:

1. Membolehkan anda menentukan lapisan projek (seperti paparan, model, perkhidmatan) dalam konfigurasi YAML.
2. Mengumpul elemen kod ke dalam lapisan ini melalui peraturan (cth., class_inherits, decorator_usage, file_regex).
3. Menguatkuasakan dasar seni bina untuk mengelakkan gandingan yang tidak diingini atau kemalangan penamaan.

Mengapa Tidak Gunakan Alat Lain?

• pydeps: Fokus pada menggambarkan import.
• import-linter: Menyemak kekangan import.
• pytestarch atau pytest-archon: Bergantung pada penulisan ujian berasaskan kod untuk seni bina.
• Tach (Berasaskan Karat): Pendekatan agnostik bahasa, mungkin tidak sejajar dengan spesifik Python.

Kelebihan Deply ialah ia melangkaui import, melihat pada penghias, warisan kelas, corak fail dan banyak lagi. Konfigurasi berasaskan YAML menjadikannya lebih mudah untuk dimasukkan ke dalam saluran paip CI tanpa menulis fail ujian baharu.

Baru dalam 0.5.2

1. Pengumpul Dinaik Taraf: Cara yang lebih fleksibel untuk menentukan kelas dan fungsi, termasuk corak regex lanjutan.
2. Peningkatan Prestasi: Deply kini berjalan sehingga 10x lebih pantas daripada sebelumnya. Menyepadukannya dengan CI tidak akan melambatkan binaan anda.
3. Peraturan Dikembangkan: Pemeriksaan tambahan untuk warisan, penggunaan penghias dan konvensyen penamaan membolehkan anda mereka bentuk dasar berbutir.

Pemasangan

pip install deply

Anda akan mendapat versi terkini, pada masa ini 0.5.2.

Konfigurasi Deply (deply.yaml)

Buat fail deply.yaml dalam akar projek anda. Sekurang-kurangnya, tentukan laluan yang ingin anda analisis, sebarang fail untuk dikecualikan, lapisan anda dan peraturan. Di bawah ialah contoh coretan untuk projek seperti Django.

deply:
  paths:
    - /path/to/your/project

  exclude_files:
    - ".*\.venv/.*"

  layers:
    - name: models
      collectors:
        - type: bool
          any_of:
            - type: class_inherits
              base_class: "django.db.models.Model"
            - type: class_inherits
              base_class: "django.contrib.auth.models.AbstractUser"

    - name: views
      collectors:
        - type: file_regex
          regex: ".*/views_api.py"

  ruleset:
    views:
      disallow_layer_dependencies:
        - models
      enforce_function_decorator_usage:
        - type: bool
          any_of:
            - type: bool
              must:
                - type: function_decorator_name_regex
                  decorator_name_regex: "^HasPerm$"
                - type: function_decorator_name_regex
                  decorator_name_regex: "^extend_schema$"
            - type: function_decorator_name_regex
              decorator_name_regex: "^staticmethod$"

Cara ia berfungsi:

1. lapisan model mengumpul kelas yang diwarisi daripada Model Django atau Pengguna Abstrak.
2. lapisan paparan mengumpul kod daripada fail yang berakhir dengan views_api.py.
3. Peraturan:
4. disallow_layer_dependencies: lapisan pandangan tidak boleh bergantung secara langsung pada model.
5. enforce_function_decorator_usage: semua fungsi dalam paparan memerlukan sama ada (HasPerm dan extend_schema) atau kaedah statik.

Menjalankan Deply

Setelah konfigurasi anda sedia, jalankan:

pip install deply

• --config=another_config.yaml membolehkan anda menentukan fail lain.
• --report-format=text|json|github-actions mengawal cara pelanggaran dipaparkan.

Contoh Tambahan

Penamaan Kelas:

deply:
  paths:
    - /path/to/your/project

  exclude_files:
    - ".*\.venv/.*"

  layers:
    - name: models
      collectors:
        - type: bool
          any_of:
            - type: class_inherits
              base_class: "django.db.models.Model"
            - type: class_inherits
              base_class: "django.contrib.auth.models.AbstractUser"

    - name: views
      collectors:
        - type: file_regex
          regex: ".*/views_api.py"

  ruleset:
    views:
      disallow_layer_dependencies:
        - models
      enforce_function_decorator_usage:
        - type: bool
          any_of:
            - type: bool
              must:
                - type: function_decorator_name_regex
                  decorator_name_regex: "^HasPerm$"
                - type: function_decorator_name_regex
                  decorator_name_regex: "^extend_schema$"
            - type: function_decorator_name_regex
              decorator_name_regex: "^staticmethod$"

Semua kelas dalam lapisan perkhidmatan mesti berakhir dengan Perkhidmatan.

Penamaan Fungsi:

deply analyze

Semua fungsi dalam tugasan mesti bermula dengan tugas_.

Petua Pro: Gabungkan berbilang syarat dengan bool untuk membentuk logik lanjutan (mesti, mana-mana, mesti_tidak), memastikan anda boleh mencipta peraturan yang sangat khusus.

Integrasi CI

Tambahkan langkah pada saluran paip CI anda:

service:
  enforce_class_naming:
    - type: class_name_regex
      class_name_regex: ".*Service$"

Saluran paip anda boleh gagal jika sebarang pelanggaran seni bina ditemui.

Bungkus

Deply direka untuk membantu anda menangkap pelanggaran seni bina sebelum ia menjadi refactor yang memakan masa. Dengan mengautomasikan semakan ini, anda boleh mengekalkan reka bentuk yang segar dan berlapis, walaupun pada pasukan yang besar.

• GitHub: https://github.com/Vashkatsi/deply
• PyPI: https://pypi.org/project/deply/

Jangan ragu untuk mengujinya dan melaraskan konfigurasi untuk keperluan anda sendiri. Jika anda mempunyai soalan atau idea, lihat repo untuk mendapatkan butiran tentang isu pemfailan atau sumbangan. Selamat mengekod!

Atas ialah kandungan terperinci Deply: pastikan seni bina python anda bersih. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!