纯Python包发布setup脚本编写示例

如果你有多个模块需要发布,而它们又存在于多个包中,那么指定整个包比指定模块可能要容易地多。即使你的模块并不在一个包内,这种做法也行的通;你可以告诉Distutils从根包(root package)处理模块,并且它工作起来和其他任意的包一样(除非你不需要拥有一个__init__.py文件)。

例1.1 根包发布

文件结构为:

<root>/
        setup.py
        foo.py
        bar.py

setup脚本可以这样写:

from distutils.core import setup
    setup(name='foobar',
        version='1.0',
        packages=[''],
        )

(空字符串表示根包)

例1.2 根包发布(模块在子目录)

如果你把上例中两个模块文件移入到一个子目录,但是它们仍在根包中,如:

<root>/
        setup.py
        src/
            foo.py
            bar.py

那么将仍然指定根包,但是你必须告诉Distutils那些源文件在哪里:

from distutils.core import setup
    setup(name='foobar',
        version='1.0',
        package_dir={'': 'src'},
        packages=[''],
        )

例2.1 包发布

如果你想发布在同一包中(或者在子包中)的多个模块。比如,如果foobar 模块属于包foobar,文件结构如下:

<root>/
        setup.py
        foobar/
            __init__.py
            foo.py
            bar.py

实际上这是Distutils默认的层次,一个精简的setup脚本可以这样写:

from distutils.core import setup
    setup(name='foobar',
        version='1.0',
        packages=['foobar'],
        )

例2.2 包发布(模块所在目录名不是包名)

如果你想将模块放入不是包名的目录,那么你还需要用到package_dir参数。例如,如果在foobar 包中src 目录拥有多个模块:

<root>/
        setup.py
        src/
            __init__.py
            foo.py
            bar.py

合适的setup脚本将会是:

from distutils.core import setup
    setup(name='foobar',
        version='1.0',
        package_dir={'foobar': 'src'},
        packages=['foobar'],
        )

例2.3 包发布(包存在于根目录)

或者你想把包放在发布根目录,如:

<root>/
        setup.py
        __init__.py
        foo.py
        bar.py

这种情况下你的setu脚本将会是:

from distutils.core import setup
    setup(name='foobar',
        version='1.0',
        package_dir={'foobar': ''},
        packages=['foobar'],
        )

(空字符串同样也代表当前目录)

例2.4 包发布(多子包)

如果你有多个子包,它们必须被显在地列举在packages参数中,但是其他任何在package_dir参数中的实体自动扩展到子包。(换句话说,Distutils并不浏览你的源文件树(source tree),而是通过寻找__init__.py文件来计算相应Python包的目录。)因此,如果默认的层次有一个子包:

<root>/
        setup.py
        foobar/
            __init__.py
            foo.py
            bar.py
            subfoo/
                __init__.py
                blah.py

那么相应的setup脚本将会是:

from distutils.core import setup
    setup(name='foobar',
        version='1.0',
        packages=['foobar', 'foobar.subfoo'],
        )

注意:发布一个包,就是将该包所在目录所有模块全部发布。那么我们就不能只发布包内部分模块。

例如,文件结构如下:

<root>/
        setup.py
        sub_package1/
            __init__.py
            sub_model1
            sub_model2
        sub_package2/
            __init__.py
            sub_model3

使用Distutils,我们无法在发布包sub_packe1sub_package2的同时,不发布sub_model2模块。

posted @ 2016-09-30 09:19  godjob  Views(...)  Comments(...Edit  收藏