İyi / doğru paket __init__.py dosyalarını nasıl yazarım

Paketim aşağıdaki yapıya sahiptir:

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
   ...

__init__.pyDosyaların nasıl doğru yazılması gerektiğinden emin değilim . Bakışlar ister:
__init__.py #1

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

Ama örneğin nasıl görünmeli __init__.py #2? Benimki:

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

Ne zaman __all__kullanılmalı?

__all__çok iyi - modülleri otomatik olarak içe aktarmadan içe aktarma ifadelerini yönlendirmeye yardımcı olur http://docs.python.org/tutorial/modules.html#importing-from-a-package

kullanmak __all__ve import *gereksizdir, sadece __all__gereklidir

Ben import *bir __init__.pyithalat paketleri kullanmak için en güçlü nedenlerinden biri var varolan bir uygulama kırmadan birden fazla komut dosyası haline geldi bir komut dosyası refactor edebilmek olduğunu düşünüyorum. Ama en başından beri bir paket tasarlıyorsanız. Sanırım __init__.pydosyaları boş bırakmak en iyisidir .

Örneğin:

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

o zaman uygulama büyür ve şimdi bütün bir klasör

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

init betiğ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

böylece aşağıdakileri yapmak için yazılan bir komut dosyası değişiklik sırasında bozulmaz:

from foo import fooFactory, tallFoo, shortFoo

Kendi __init__.pydosyalarım daha sık boş. Özellikle, ben asla bir from blah import *parçası olarak __init__.py- "paketi alma" doğrudan paketin bir parçası olarak tanımlanan her türlü sınıf, fonksiyonlar vb almak anlamına gelirse, o zaman ben içeriği yerine blah.pypaketin içine lexically kopyalamak __init__.pyve kaldırmak blah.py( burada kaynak dosyaların çoğaltılması iyi değildir).

import *Deyimleri (eek) desteklemede ısrar ederseniz , __all__(minik olarak, içine sahip olabileceğiniz gibi bir isim listesi kullanmak ) hasar kontrolüne yardımcı olabilir. Genel olarak, ad alanları ve açık ithalat iyi şeylerdir ve kavramlardan birini veya her ikisini atlayarak sistematik olarak atlamaya dayanan herhangi bir yaklaşımı yeniden düşünmenizi şiddetle tavsiye ederim! -)

Sizin __init__.pybir olmalıdır docstring'ini .

Tüm işlevler modüllerde ve alt paketlerde uygulansa da, paket doktrininiz nereden başlayacağınızı belgeleyeceğiniz yerdir. Örneğin, python emailpaketini düşünün . Paket belgeleri, paketin içindeki çeşitli bileşenlerin birlikte, amacını, arka planını ve nasıl çalıştığını açıklayan bir giriş niteliğindedir. Sfenks veya başka bir paket kullanarak docstrings'den otomatik olarak dokümantasyon oluşturursanız, docstring paketi böyle bir girişi tanımlamak için tam olarak doğru yerdir.

Diğer içerikler için firecrow ve Alex Martelli'nin mükemmel yanıtlarına bakın .