Làm cách nào để tôi viết các tập tin __init__ phút

Gói của tôi có cấu trúc như sau:

mobilescouter/
    __init__.py #1
    mapper/
        __init__.py  #2
        lxml/
            __init__.py #3
            vehiclemapper.py
            vehiclefeaturemapper.py
            vehiclefeaturesetmapper.py
        ...
        basemapper.py
   vehicle/
        __init__.py #4
        vehicle.py
        vehiclefeature.py
        vehiclefeaturemapper.py
   ...

Tôi không chắc làm thế nào các __init__.pytập tin nên được viết chính xác.
Hình __init__.py #1như:

__all__ = ['mapper', 'vehicle']
import mapper
import vehicle

Nhưng ví dụ __init__.py #2như thế nào? Của tôi là:

__all__ = ['basemapper', 'lxml']
from basemaper import *
import lxml

Khi nào nên __all__sử dụng?

__all__là rất tốt - nó giúp hướng dẫn nhập các câu lệnh mà không cần tự động nhập các mô-đun http://docs.python.org/tutorial/modules.html#importing-from-a-package

sử dụng __all__và import *là dư thừa, chỉ __all__cần thiết

Tôi nghĩ rằng một trong những lý do mạnh mẽ nhất để sử dụng import *trong một __init__.pygói nhập khẩu là có thể cấu trúc lại một tập lệnh đã phát triển thành nhiều tập lệnh mà không phá vỡ một ứng dụng hiện có. Nhưng nếu bạn đang thiết kế một gói từ đầu. Tôi nghĩ tốt nhất là để __init__.pytrống các tập tin.

ví dụ:

foo.py - contains classes related to foo such as fooFactory, tallFoo, shortFoo

sau đó ứng dụng phát triển và bây giờ là toàn bộ thư mục

foo/
    __init__.py
    foofactories.py
    tallFoos.py
    shortfoos.py
    mediumfoos.py
    santaslittlehelperfoo.py
    superawsomefoo.py
    anotherfoo.py

sau đó tập lệnh init có thể nói

__all__ = ['foofactories', 'tallFoos', 'shortfoos', 'medumfoos',
           'santaslittlehelperfoo', 'superawsomefoo', 'anotherfoo']
# deprecated to keep older scripts who import this from breaking
from foo.foofactories import fooFactory
from foo.tallfoos import tallFoo
from foo.shortfoos import shortFoo

để một kịch bản được viết để làm như sau không bị phá vỡ trong quá trình thay đổi:

from foo import fooFactory, tallFoo, shortFoo

Các __init__.pytập tin của tôi trống thường xuyên hơn không. Cụ thể, tôi không bao giờ có một from blah import *phần của __init__.py- nếu "nhập gói" có nghĩa là nhận tất cả các loại lớp, hàm vv được xác định trực tiếp như một phần của gói, thì tôi sẽ sao chép nội dung của blah.pygói __init__.pyvào thay thế và loại bỏ blah.py( sự nhân lên của các tập tin nguồn không tốt ở đây).

Nếu bạn khăng khăng ủng hộ các import *thành ngữ (eek), thì việc sử dụng __all__(với rất ít danh sách tên mà bạn có thể tự mang theo trong đó) có thể giúp kiểm soát thiệt hại. Nói chung, không gian tên và nhập khẩu rõ ràng là những điều tốt và tôi mạnh mẽ đề nghị xem xét lại bất kỳ phương pháp tiếp cận nào dựa trên việc bỏ qua một cách có hệ thống một hoặc cả hai khái niệm! -)

Bạn __init__.pynên có một chuỗi doc .

Mặc dù tất cả các chức năng được triển khai trong các mô-đun và gói phụ, chuỗi tài liệu gói của bạn là nơi để ghi lại nơi bắt đầu. Ví dụ, hãy xem xét gói pythonemail . Tài liệu gói là phần giới thiệu mô tả mục đích, bối cảnh và cách các thành phần khác nhau trong gói hoạt động cùng nhau. Nếu bạn tự động tạo tài liệu từ các tài liệu bằng cách sử dụng nhân sư hoặc gói khác, chuỗi tài liệu chính xác là nơi phù hợp để mô tả phần giới thiệu đó.

Đối với bất kỳ nội dung nào khác, hãy xem câu trả lời tuyệt vời của Firecrow và Alex Martelli .