当使用代码存储库时,如何引用资源的相对路径

我们正在使用部署在Windows和Linux上的代码存储库-有时在不同的目录中。项目中的一个模块应该如何引用项目中的一个非python资源(CSV文件等)?

如果我们这样做:

thefile = open('test.csv')

或者:

thefile = open('../somedirectory/test.csv')

只有当脚本从一个特定目录或目录的一个子集运行时,它才会工作。

我想做的是:

path = getBasePathOfProject() + '/somedirectory/test.csv'
thefile = open(path)

这可能吗?

224482 次浏览

尝试使用相对于当前文件路径的文件名。'./my_file'示例:

fn = os.path.join(os.path.dirname(__file__), 'my_file')

在Python 3.4+中,你也可以使用pathlib:

fn = pathlib.Path(__file__).parent / 'my_file'

你可以使用build in __file__变量。它包含当前文件的路径。我将在项目根的一个模块中实现getBaseOfProject。在那里,我将获取__file__的路径部分并返回它。然后可以在项目中的任何地方使用此方法。

import os
cwd = os.getcwd()
path = os.path.join(cwd, "my_file")
f = open(path)

你也可以尝试使用os.path.abspath(os.getcwd())来规范化你的cwd。更多信息在这里

我经常使用类似的方法:

import os
DATA_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), 'datadir'))


# if you have more paths to set, you might want to shorten this as
here = lambda x: os.path.abspath(os.path.join(os.path.dirname(__file__), x))
DATA_DIR = here('datadir')


pathjoin = os.path.join
# ...
# later in script
for fn in os.listdir(DATA_DIR):
f = open(pathjoin(DATA_DIR, fn))
# ...

的变量

__file__

保存编写该代码的脚本的文件名,因此可以使路径相对于脚本,但仍然使用绝对路径编写。它运行得非常好,原因如下:

  • 路径是绝对的,但仍然是相对的
  • 项目仍然可以部署在相对容器中

但是你需要注意平台兼容性——Windows操作系统。pathsep与UNIX不同。

我花了很长时间来思考这个问题的答案,但我最终得到了它(它实际上非常简单):

import sys
import os
sys.path.append(os.getcwd() + '/your/subfolder/of/choice')


# now import whatever other modules you want, both the standard ones,
# as the ones supplied in your subfolders
这将附加子文件夹的相对路径到供python查看的目录中 这是非常快速和肮脏的,但它的工作就像一个魅力:)

如果您正在使用安装工具或分发(setup.py安装),那么访问这些打包资源的“正确”方式似乎是使用package_resources。

对你来说,这个例子就是

import pkg_resources
my_data = pkg_resources.resource_string(__name__, "foo.dat")

当然,是哪个读取了资源,读取的二进制数据是my_data的值

如果你只是需要文件名,你也可以使用

resource_filename(package_or_requirement, resource_name)

例子:

resource_filename("MyPackage","foo.dat")

这样做的好处是,即使它是一个像鸡蛋一样的存档发行版,它也能保证工作。

看到http://packages.python.org/distribute/pkg_resources.html#resourcemanager-api

在Python中,路径是相对于当前工作目录的,在大多数情况下,当前工作目录是运行程序的目录。当前工作目录很可能与模块文件的目录不相同,因此使用相对于当前模块文件的路径总是一个糟糕的选择。

使用绝对路径应该是最好的解决方案:

import os
package_dir = os.path.dirname(os.path.abspath(__file__))
thefile = os.path.join(package_dir,'test.cvs')

我被难住了。想把一些资源文件打包到一个轮子文件中并访问它们。使用清单文件打包,但是pip install没有安装它,除非它是一个子目录。希望这些场景照片能有所帮助

├── cnn_client
│   ├── image_preprocessor.py
│   ├── __init__.py
│   ├── resources
│   │   ├── mscoco_complete_label_map.pbtxt
│   │   ├── retinanet_complete_label_map.pbtxt
│   │   └── retinanet_label_map.py
│   ├── tf_client.py

MANIFEST.in

recursive-include cnn_client/resources *
使用标准setup.py创建一个weel。PIP安装了车轮文件。 安装后检查资源是否安装。他们是< / p >
ls /usr/local/lib/python2.7/dist-packages/cnn_client/resources


mscoco_complete_label_map.pbtxt
retinanet_complete_label_map.pbtxt
retinanet_label_map.py

在tfclient.py中访问这些文件。

templates_dir = os.path.join(os.path.dirname(__file__), 'resources')
file_path = os.path.join(templates_dir, \
'mscoco_complete_label_map.pbtxt')
s = open(file_path, 'r').read()


这很有效。

既然你说你有一些代码要部署到不同的地方,你应该使用python生态系统来分发资源,而不仅仅局限于文件。它还支持访问zip归档中的文件,这可以很好,这样您就不必为此烦恼了。

以前,这是用pkg_resourcessetuptools处理的,但随着越来越多的工具出现,生态系统已经发生了变化。从python 3.7开始,你应该使用importlib.resources

import importlib.resources
with importlib.resources.open_text('mypackage.somedirectory','text.csv') as f:
print(f.read()) # or whatever

但是您还必须指示安装程序包含包资源。否则,pip install mypackage将不会绑定数据文件。

有很多方法可以做到这一点,但其中一种方法是添加

[options.package_data]
mypackage =
"somedirectory/*.csv"

到你的setup.cfg。当使用setup.pypyproject.toml时,有等效的方法。更完整的帐户可以在setuptools主页上找到

如果您希望稍后将脚本编译为.exe那么__file__不会给你.exe文件的路径。在这种情况下你应该这样做

使用sys.argv[0]

sys.argv[0]给出了文件的路径,当它是一个。exe文件时,当你运行像python script.py这样的脚本时

这就是我目前引用事物的方式

os.path.join(os.path.dirname(os.path.abspath(sys.argv[0])), 'Resources')

关于为什么这是一个在这里的东西有更多的细节