Bagaimanakah Saya Boleh Mengakses Fail Statik Dalam Pakej Python?

Membaca Fail Statik dari Dalam Pakej Python

Situasi

Bayangkan pakej Python anda mengandungi fail teks templat yang anda ingin akses dari dalam anda program. Apabila menentukan laluan ke fail ini, ia menjadi perlu untuk mengendalikan struktur pakej.

TLDR: Gunakan importlib.resources (Python 3.9 )

Jika keserasian ke belakang tidak menjadi kebimbangan (iaitu, anda menggunakan Python 3.9 atau lebih tinggi), memanfaatkan importlib.resources modul.

from importlib import resources as impresources
from . import templates

inp_file = impresources.files(templates) / 'temp_file'
with inp_file.open("rt") as f:
    template = f.read()

Kaedah Tradisional: Menggunakan pkg_resources daripada Setuptools

Untuk versi Python di bawah 3.9, pertimbangkan untuk menggunakan modul pkg_resources daripada alat persediaan pengedaran.

import pkg_resources

# Could be a dot-separated package/module name or a "Requirement"
resource_package = __name__
resource_path = '/'.join(('templates', 'temp_file'))  # Do not use os.path.join()
template = pkg_resources.resource_string(resource_package, resource_path)
# or for a file-like stream:
template = pkg_resources.resource_stream(resource_package, resource_path)

Langkah:

1. Cari templat anda dalam hierarki pakej:

   <your-package>
     +--<module-asking-for-the-file>
     +--templates/
          +--temp_file

2. Rujuk fail templat menggunakan sama ada kaedah:

   • Pilihan 1 (importlib.resources):

     from . import templates
     
     inp_file = impresources.files(templates) / 'temp_file'

   • Pilihan 2 (pkg_resources):

     resource_path = '/'.join(('templates', 'temp_file'))
     template = pkg_resources.resource_string(__name__, resource_path)

Petua:

• Untuk fail dalam modul semasa anda, gunakan pakej sebagai hujah pakej dalam importlib.resources.
• Fungsi importlib.resources.files mengembalikan objek seperti laluan, yang membenarkan akses fail sementara berasaskan pengurus konteks.
• Sertakan sebarang fail statik dalam setup.py anda atau MANIFEST untuk tujuan pembungkusan.
• Pertimbangkan tetapan zip_safe=True dalam setup.py untuk mendayakan pengedaran zipapp.

Atas ialah kandungan terperinci Bagaimanakah Saya Boleh Mengakses Fail Statik Dalam Pakej Python?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!