草庐IT

python - 在 setuputils 包中获取入口点脚本文件位置?

coder 2023-08-17 原文

所以我在 setup.py [console_scripts] 部分中定义了一个入口点。该命令已正确安装并且运行良好,但我需要一种方法来以编程方式找出脚本的路径(例如,在 Windows 上,它类似于 C:/my/virtual/env/scripts/my_console_script.exe)。我需要这个,这样我就可以将该脚本路径作为参数传递给其他命令,而不管包安装在哪里。 Setuputils 提供了 pkg_resources,但这似乎并没有公开任何实际获取原始安装路径的方法,只有可加载的对象。

编辑:为了使用例简单明了,这里是设置。

我有一个插件驱动的应用程序,可以与各种本地服务进行通信。这些插件之一与 NMS 包的警报接口(interface)相关联。这个警报包可以向任意处理程序发出警报的唯一方法是调用脚本 - 执行路径(在本例中为 console_scripts 入口点)注册为完整路径 - 这就是我需要获取的路径。

最佳答案

那么,您可以将 --install-option="--install-scripts=/usr/local/bin" 形式的选项传递给 pip 并且只需自己设置路径。但我理解为什么您可能不想在跨平台项目中对其进行硬编码。

因此,我们只需要找出setuptools 实际 使用的目录。不幸的是,路径是在一大堆实际设置代码的中间确定的,而不是在我们可以调用的单独函数中确定的。

所以下一步是编写一个自定义安装命令来观察并保存路径。 (就此而言,您还可以设置 self.install_scripts 到您在此自定义安装程序类中选择的目录,从而将那部分配置保存在一个地方(包) 而不是在包中和命令行参数中设置...)

例子:

from setuptools import setup
from setuptools.command.install import install
from distutils.command.build_py import build_py
import os

class InstallReadsScriptDir(install):
    def run(self):
        self.distribution._x_script_dir = self.install_scripts
        install.run(self)

class BuildConfiguresScriptDir(build_py):
    def run(self):
        build_py.run(self)
        if self.dry_run:
            return
        script_dir = self.distribution._x_script_dir  # todo: check exists
        target = os.path.join(self.build_lib, 'mypackage', 'scriptdir.py')
        with open(target, 'w') as outfile:
            outfile.write('path = """{}"""'.format(script_dir))

setup(
    name="MyPackage",
    version='0.0.1',
    packages = ['mypackage'],
    entry_points = {
        'console_scripts': [
            'footest = mypackage:main',
        ],
    },
    cmdclass= {
        'install': InstallReadsScriptDir,
        'build_py': BuildConfiguresScriptDir,
    },
)

可能的异议:

  • 有些人不喜欢任何形式的代码生成。在这种情况下,它更像是配置,尽管将它放在包中的 .py 中可以很容易地从任何地方的 Python 代码获取。

  • 从表面上看,它看起来有点像 hack。但是,setuptools 专门设计用于允许自定义命令类。这里没有真正访问任何私有(private)的东西,除了可能使用 distribution 对象传递的值,这只是为了避免 global

  • 只获取目录,不获取可执行文件名。不过,根据您的入口点配置,您应该知道这些名称。获取名称需要调用入口点规范的解析方法并生成更多代码。

  • 如果您需要修复一些错误,例如无需安装即可构建。不过 sdist 是安全的。

  • develop 是可能的,但需要另一个命令类。 install 不会被调用,build_py 只会在您设置 use_2to3 时被调用。自定义 develop 命令可以获得与 install 示例相同的路径,但作为 self.script_dir。从那里您必须决定是否愿意将文件写入您的源目录,该目录位于 self.egg_path 中——因为它稍后会被 install 获取,虽然它应该是同一个文件(并且构建命令无论如何都会覆盖该文件)

附录

这一点点洞察力可能更优雅,因为它不需要在任何地方保存路径,但仍会获得 setuptools 使用的实际路径,尽管它假定自安装以来没有配置发生变化。

from setuptools import Distribution
from setuptools.command.install import install

class OnlyGetScriptPath(install):
    def run(self):
        # does not call install.run() by design
        self.distribution.install_scripts = self.install_scripts

def get_setuptools_script_dir():
    dist = Distribution({'cmdclass': {'install': OnlyGetScriptPath}})
    dist.dry_run = True  # not sure if necessary, but to be safe
    dist.parse_config_files()
    command = dist.get_command_obj('install')
    command.ensure_finalized()
    command.run()
    return dist.install_scripts

附录 2

刚刚意识到/记得 pipegg-info 中创建了一个 installed-files.txt,这是一个相对路径列表到包括脚本在内的所有文件的包根目录。 pkg_resources.get_distribution('mypackage').get_metadata('installed-files.txt') 会得到这个。它只是一个 pip 东西,不是由 setup.py install 创建的。您需要逐行查找您的脚本名称,然后根据您的包目录获取绝对路径。

关于python - 在 setuputils 包中获取入口点脚本文件位置?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25066084/

有关python - 在 setuputils 包中获取入口点脚本文件位置?的更多相关文章

  1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  2. ruby - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake,如果我把所有东西都放到Rakefile中,它会很大并且很难读取/找到东西,所以我试着将每个命名空间放在lib/rake中它自己的文件中,我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题,但没有任务。我现在只有一个.rake文件作为测试,名为“servers.rake”,它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  3. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

    我的目标是转换表单输入,例如“100兆字节”或“1GB”,并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前,我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效,但前提是输入是倍数(“gigabytes”,而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以,功能正常,

  4. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  5. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情? 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中,使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件,我们在StackOverflow上找到一个类似的问题

  6. ruby - 将差异补丁应用于字符串/文件 - 2

    对于具有离线功能的智能手机应用程序,我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

  7. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  8. ruby - 使用 Vim Rails,您可以创建一个新的迁移文件并一次性打开它吗? - 2

    使用带有Rails插件的vim,您可以创建一个迁移文件,然后一次性打开该文件吗?textmate也可以这样吗? 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件,这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails,您可以创建一个新的迁移文件并一次性打开它吗?,我们在StackOverflow上找到一个类似的问题: https://sta

  9. Ruby 写入和读取对象到文件 - 2

    好的,所以我的目标是轻松地将一些数据保存到磁盘以备后用。您如何简单地写入然后读取一个对象?所以如果我有一个简单的类classCattr_accessor:a,:bdefinitialize(a,b)@a,@b=a,bendend所以如果我从中非常快地制作一个objobj=C.new("foo","bar")#justgaveitsomerandomvalues然后我可以把它变成一个kindaidstring=obj.to_s#whichreturns""我终于可以将此字符串打印到文件或其他内容中。我的问题是,我该如何再次将这个id变回一个对象?我知道我可以自己挑选信息并制作一个接受该信

  10. ruby - 如何使用 Ruby aws/s3 Gem 生成安全 URL 以从 s3 下载文件 - 2

    我正在编写一个小脚本来定位aws存储桶中的特定文件,并创建一个临时验证的url以发送给同事。(理想情况下,这将创建类似于在控制台上右键单击存储桶中的文件并复制链接地址的结果)。我研究过回形针,它似乎不符合这个标准,但我可能只是不知道它的全部功能。我尝试了以下方法:defauthenticated_url(file_name,bucket)AWS::S3::S3Object.url_for(file_name,bucket,:secure=>true,:expires=>20*60)end产生这种类型的结果:...-1.amazonaws.com/file_path/file.zip.A

随机推荐