在Python中，如何有效地管理脚本文件之间的引用？

发布于 2024-07-08 04:27:59 字数 570 浏览 8 评论 0原文

我有相当多的 Python 脚本，其中包含其他 Python 脚本使用和引用的可重用代码。然而，这些脚本往往分散在不同的目录中，我发现必须在顶级脚本上包含（通常是多个）对 sys.path.append 的调用有点乏味。我只想提供“导入”语句，而无需在同一脚本中提供其他文件引用。

目前，我有这样的：

import sys
sys.path.append('..//shared1//reusable_foo')
import Foo
sys.path.append('..//shared2//reusable_bar')
import Bar

我的偏好如下：

import Foo
import Bar

我的背景主要是.NET平台，所以我习惯使用*.csproj、*.vbproj、*.sln等元文件来管理和包含源文件外部的实际文件路径引用。这允许我只提供“using”指令（相当于 Python 的导入），而无需公开所有引用，并允许在多个脚本中重用路径引用本身。

Python 是否对此有同等支持？如果没有，有哪些技术和方法？

原文

I have a fair number of Python scripts that contain reusable code that are used and referenced by other Python scripts. However, these scripts tend to be scattered across different directories and I find it to be somewhat tedious to have to include (most often multiple) calls to sys.path.append on my top-level scripts. I just want to provide the 'import' statements without the additional file references in the same script.

Currently, I have this:

import sys
sys.path.append('..//shared1//reusable_foo')
import Foo
sys.path.append('..//shared2//reusable_bar')
import Bar

My preference would be the following:

import Foo
import Bar

My background is primarily in the .NET platform so I am accustomed to having meta files such as *.csproj, *.vbproj, *.sln, etc. to manage and contain the actual file path references outside of the source files. This allows me to just provide 'using' directives (equivalent to Python's import) without exposing all of the references and allowing for reuse of the path references themselves across multiple scripts.

Does Python have equivalent support for this and, if not, what are some techniques and approaches?

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

何以心动 2024-07-15 04:28:02

我的解决方案是打包一个可以导入模块的实用程序：
my_util 在站点包中

import my_util

foo = myutil.import_script('..//shared1//reusable_foo')
if foo == None:
    sys.exit(1)


def import_script(script_path, log_status = True):
    """
    imports a module and returns the handle
    """
    lpath = os.path.split(script_path)

    if lpath[1] == '':
        log('Error in script "%s" in import_script' % (script_path))
        return None


    #check if path is already in sys.path so we don't repeat
    npath = None
    if lpath[0] == '':
        npath = '.'
    else:
        if lpath[0] not in sys.path:
            npath = lpath[0]

    if npath != None:
        try:
            sys.path.append(npath)
        except:
            if log_status == True:
                log('Error adding path "%s" in import_script' % npath)
            return None

    try:   
        mod =  __import__(lpath[1])
    except:
        error_trace,error_reason =  FormatExceptionInfo()
        if log_status == True:
            log('Error importing "%s" module in import_script: %s' % (script_path, error_trace + error_reason))
        sys.path.remove(npath)
        return None

    return mod

My solution was to package up one utility that would import the module:
my_util is in site packages

import my_util

foo = myutil.import_script('..//shared1//reusable_foo')
if foo == None:
    sys.exit(1)


def import_script(script_path, log_status = True):
    """
    imports a module and returns the handle
    """
    lpath = os.path.split(script_path)

    if lpath[1] == '':
        log('Error in script "%s" in import_script' % (script_path))
        return None


    #check if path is already in sys.path so we don't repeat
    npath = None
    if lpath[0] == '':
        npath = '.'
    else:
        if lpath[0] not in sys.path:
            npath = lpath[0]

    if npath != None:
        try:
            sys.path.append(npath)
        except:
            if log_status == True:
                log('Error adding path "%s" in import_script' % npath)
            return None

    try:   
        mod =  __import__(lpath[1])
    except:
        error_trace,error_reason =  FormatExceptionInfo()
        if log_status == True:
            log('Error importing "%s" module in import_script: %s' % (script_path, error_trace + error_reason))
        sys.path.remove(npath)
        return None

    return mod

回复收藏 0 原文

诗化ㄋ丶相逢 2024-07-15 04:28:01

如果您的可重用文件已打包（即，它们包含 __init__.py 文件）并且该包的路径是 PYTHONPATH 或 sys.path 的一部分，那么您应该能够执行

import Foo

这个问题提供了更多详细信息。

（注意：正如吉姆所说，您还可以将可重用代码放入您的 site-packages 目录中。）

If your reusable files are packaged (that is, they include an __init__.py file) and the path to that package is part of your PYTHONPATH or sys.path then you should be able to do just

import Foo

This question provides a few more details.

(Note: As Jim said, you could also drop your reusable code into your site-packages directory.)

回复收藏 0 原文

绅刃 2024-07-15 04:28:01

您可以将可重用的东西放在site-packages中。这是完全透明的，因为默认情况下它位于 sys.path 中。

您可以将 someName.pth 文件放入 site-packages 中。这些文件包含实际可重用内容所在的目录。这也是完全透明的。并且不涉及在 site-packages 中安装更改的额外步骤。

您可以将可重用内容的目录放在 PYTHONPATH 上。这有点不太透明，因为您必须确保它已设置。不是火箭科学，但也不是完全透明的。

回复收藏 0 原文

ˇ宁静的妩媚 2024-07-15 04:28:01

在一个项目中，我想确保用户可以将 python 脚本（基本上可以用作插件）放在任何地方。我的解决方案是将以下内容放入该项目的配置文件中：

[server]
PYPATH_APPEND: /home/jason:/usr/share/some_directory

这样，这将在程序启动时将 /home/jason 和 /usr/share/some_directory 添加到 python 路径。

然后，只需用冒号分割字符串并将这些目录添加到 sys.path 的末尾即可。您可能需要考虑将一个模块放在 site-packages 目录中，该目录包含一个读取该配置文件并将这些目录添加到 sys.path 的函数（不幸的是，我现在没有时间编写示例）。

正如其他人提到的，最好将尽可能多的内容放入站点包中并使用 .pth 文件。但是，如果您有一个脚本需要导入一堆不在站点包中且您不想从其他脚本导入的内容，那么这可能是一个好主意。

（也可能有一种方法可以使用 .pth 文件来执行此操作，但我喜欢能够在放置其余配置信息的同一位置操作 python 路径）

In one project, I wanted to make sure that the user could put python scripts (that could basically be used as plugins) anywhere. My solution was to put the following in the config file for that project:

[server]
PYPATH_APPEND: /home/jason:/usr/share/some_directory

That way, this would add /home/jason and /usr/share/some_directory to the python path at program launch.

Then, it's just a simple matter of splitting the string by the colons and adding those directories to the end of the sys.path. You may want to consider putting a module in the site-packages directory that contains a function to read in that config file and add those directories to the sys.path (unfortunately, I don't have time at the moment to write an example).

As others have mentioned, it's a good idea to put as much in site-packages as possible and also using .pth files. But this can be a good idea if you have a script that needs to import a bunch of stuff that's not in site-packages that you wouldn't want to import from other scripts.

(there may also be a way to do this using .pth files, but I like being able to manipulate the python path in the same place as I put the rest of my configuration info)

回复收藏 0 原文