以Python编程方式确定distutils数据文件的位置

我正在尝试将数据文件包含在我的软件包的distutils中,然后使用相对路径引用它们(以下是 http://docs.python.org/distutils/setupscript.html#distutils-additional-files)

我的目录结构是：

myproject/
  mycode.py
  data/
    file1.dat

mycode.py中的代码,其实际上是包中的脚本.它依赖于访问数据/ file1.dat,使用该相对路径引用它.在setup.py中,我有：

setup(
 ...
 scripts = "myproject/mycode.py"
 data_files = [('data','myproject/data/file1.dat')]
)

假设用户现在使用：

python setup.py --prefix=/home/user/

那么mycode.py会出现在/ home / user / bin /这样的地方.但是,对于data / file1.dat的引用现在已经被打破了,因为脚本存在于数据的其他位置.

如何从mycode.py中找到myproject / data / file1.dat的绝对路径,所以我可以根据用户安装包的位置正确地引用它吗？

编辑
当我使用prefix = / home / user /安装它时,我得到/ home / user /中创建的数据/ file1.dat是我想要的,唯一缺少的是如何以编程方式检索该文件的绝对路径,只给出相对路径,而不知道用户安装包的位置.当我尝试使用package_data而不是data_files时,它不起作用 – 我不会在任何地方创建data / file1.dat,即使我删除了我的MANIFEST文件.

我已经阅读了这个显然非常常见的问题的所有当前讨论.然而,所有提出的解决方案都没有处理我以上的情况,需要访问data_files的代码是一个脚本,其位置可能会根据setup.py的–prefix参数而改变.我可以想到的唯一的黑客就是将数据文件添加到scripts = in setup()中,如下所示：

setup(
  ...
  scripts = ["myproject/mycode.py","myproject/data/file1.data"]
)

这是一个可怕的骇客,但它是唯一的方法,我可以想到,以确保file1.data将与脚本中定义的脚本在同一个位置,因为我找不到任何平台独立和安装敏感的API来恢复位置的用户运行setup.py安装后(可能使用–prefix = args).

解决方法

我认为使用脚本会产生混乱.脚本应该引用一个可运行的可执行文件,也许是一个与你的软件包相关的实用程序脚本,也可能是你的软件包的一个入口点.在这两种情况下,您应该期望任何脚本不会与您的其他软件包一起安装.这个期望主要是由于软件包被认为是库(并安装到lib目录)的惯例,而脚本被认为是可执行文件(并且被安装到bin或Scripts目录).此外,数据文件既不是可执行文件也不是库,是完全独立的.

因此,从脚本中,您需要确定数据文件所在的位置.根据Python docs,

If directory is a relative path,it is interpreted relative to the
installation prefix.

因此,您应该在mycode脚本中写下如下内容以找到数据文件：

import sys
import os

def my_func():
    with open(os.path.join(sys.prefix,'data','file1.dat')) as f:
        print(next(f))

if __name__ == '__main__':
    my_func()

如果您对代码和数据未捆绑在一起的方式感到不满意(我不会这样做),那么我将重组您的包,以便您具有一个实际的Python包(和模块),并使用packages =和package_data =将数据注入到包中,然后创建一个调用到包中的模块的简单脚本.

我通过创建这个树来做到这一点：

.
│   setup.py
│
├───myproject
│   │   mycode.py
│   │   __init__.py
│   │
│   └───data
│           file1.dat
│
└───scripts
        run-my-code.py

使用setup.py：

from distutils.core import setup

setup(
    name='myproject',version='1.0',scripts=['scripts/run-my-code.py'],packages=['myproject'],package_data = {
        'myproject': ['data/file1.dat'],},)

run-my-code.py是简单的：

from myproject import mycode

mycode.my_func()

__init__是空的,mycode.py看起来像：

import os

here = os.path.dirname(__file__)

def my_func():
    with open(os.path.join(here,'file1.dat')) as f:
        print(next(f))

后一种方法将数据和代码捆绑在一起(在site-packages / myproject中),并且仅将脚本安装在不同的位置(因此它显示在$PATH中).

以Python编程方式确定distutils数据文件的位置

解决方法

相关推荐