草庐IT

python - 如何为基本包设置配置 __main__.py、__init__.py 和 __setup__.py？

coder 2023-05-22 原文

背景:

我有一个像这样的目录结构:

Package/
    setup.py
    src/
        __init__.py
        __main__.py 
        code.py

我希望能够以多种不同的方式运行代码。
  • pip install Package然后 python然后 from Package import *
  • python -m Package哪个应该做 __main__.py 中的事情
  • python __main__.py这也应该做 __main__.py 中的事情但这一次，我们假设您下载的是源代码而不是 pip installing .

    • 现在我已经让前两个工作了，但是设置很困惑:

    setup.py: 
    setup(
    name='Package',
    packages=['Package'],
    package_dir={'Package': 'src'},
    ...
    entry_points={ 'console_scripts': ['Package = src.__main__:main' ] }

    __init__.py: 
    from Package.code import .......

    __main__.py: 
    from . import .......

    对我来说更有意义的是在这两种情况下都写
    from code import ........

    但这给了我导入错误。

    题:

    我拥有它的方式真的是唯一的方式吗？

    最重要的是，我如何支持第三个用例？现在，python __main__.py throw 
    File "__main__.py", line 10, in <module>
    from . import code
ImportError: cannot import name 'class defined in code.py'

    笔记:

    我读过了
  • https://chriswarrick.com/blog/2014/09/15/python-apps-the-right-way-entry_points-and-scripts/
  • http://setuptools.readthedocs.io/en/latest/setuptools.html
  • 这里的许多问题看起来像这个，但没有回答我上面的问题。

    • 最佳答案

    您几乎拥有所需的一切(甚至更多)!我会采用以下设置:

    代码.py :

    foo = 1

    __init__.py: 
    from .code import foo

    在这里做一个相对导入，因为 __init__.py将在导入整个包时使用。请注意，我们使用 . 显式地将导入标记为相对导入。 -syntax 因为这是 Python 3 所必需的(如果您使用了 from __future__ import absolute_import，则在 Python 2 中)。

    __main__.py: 
    from Package import foo

print('foo = ', foo)

    这是包的主脚本，所以我们使用绝对import陈述。通过这样做，我们假设包已经安装(或者至少已经放在路径上)；这就是处理包裹的方式!您可能认为这与您的第三个用例冲突，但实际上没有理由不这样做 pip install在处理包裹时。这真的没什么大不了的(尤其是在使用 virtualenv 时)!

    如果您关心的是修改源文件并通过运行 __main__.py 轻松观察更改文件然后你可以简单地使用 -e 安装包(“可编辑”)开关:pip install -e . (假设您在目录 Package 中)。但是，对于您当前的目录结构，这将不起作用，因为 -e开关将放置一个 egg-link到包含 setup.py 的目录文件;此目录不包含名为 Package 的包但是 src相反(我有 a question about that )。

    相反，如果您遵循约定以包本身命名包源的根目录(例如 Package)，则使用 -e 进行安装。不是问题:Python 确实找到了所需的包 Package在对应目录中:
    $ tree Package/
Package/
├── setup.py
└── Package   <-- Renamed "src" to "Package" because that's the package's name.
    ├── code.py
    ├── __init__.py
    └── __main__.py

    这也让您可以省略 package_dir={'Package': 'src'} 的额外定义。在 setup.py .

    关于setup.py的说明 :对于您指定的三个用例，无需定义入口 pip 。也就是说，您可以跳过该行 entry_points={ 'console_scripts': ['Package = src.__main__:main' ] } .通过运送 __main__.py模块python -m Package将很容易执行此模块中的代码。您还可以添加额外的 if 子句:
    def main():
    print('foo = ', foo)

if __name__ == '__main__':
    main()

    另一方面，入口 pip 让您可以直接执行 __main__.main 中的代码。来自 CLI；正在运行 $ Package会执行相应的代码。

    回顾

    最重要的是，我总是使用 pip install在处理包裹时。为什么不呢，特别是如果您已经创建了 setup.py文件？如果要“实时”应用对包的更改，则可以使用 -e 进行安装。开关(这可能需要重命名 src 文件夹，见上文)。因此，您的第三个用例将显示为“下载源代码和 pip install (-e) Package(在 virtualenv 中)；然后您可以运行 python __main__.py”。

    编辑

    运行 __main__.py没有 pip install
    如果您不想通过 pip 安装软件包但仍然可以运行 __main__.py脚本，我仍然会采用上述设置。然后我们需要确保from Package import ...语句仍然成功，这可以通过扩展导入路径来实现(请注意，这需要将 src 目录重命名为包的名称!)。

    修改 PYTHONPATH
    对于 Linux bash，您可以按如下方式设置 Pythonpath:
    export PYTHONPATH=$PYTHONPATH:/path/to/Package

    或者，如果您与 __main__.py 位于同一目录中:
    export PYTHONPATH=$PYTHONPATH:`cd ..; pwd`

    当然，不同的操作系统有不同的方法。

    扩展 __main__.py 中的路径

    您(或者您的同事)可以将以下几行添加到脚本的顶部(在 from Package import ... 语句之前):
    import sys
sys.path.append('/path/to/Package')

    扩展 sitecustomize.py 中的路径

    您可以放置​​一个名为 sitecustomize.py 的模块在 lib/python3.5/site-packages/ Python 安装目录，其中包含以下行:
    import sys
sys.path.append('/path/to/Package')

    创建一个单独的顶级 main.py脚本

    所以你会有以下布局:
    $ tree Package/
Package/
├── main.py   <-- Add this file.
├── setup.py
└── src
    ├── code.py
    ├── __init__.py
    └── __main__.py

    哪里main.py包含
    import src.__main__

    现在 __main__.py被视为 src 的一部分包和相对导入将起作用。
    而不是运行 python src/__main__.py你会跑 python main.py现在。

    关于python - 如何为基本包设置配置 __main__.py、__init__.py 和 __setup__.py？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/44977227/

    何为pycodePackagebrpythonpipsetuptools

    有关python - 如何为基本包设置配置 __main__.py、__init__.py 和 __setup__.py？的更多相关文章

    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. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

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

    3. ruby-openid:执行发现时未设置@socket - 2

      我在使用omniauth/openid时遇到了一些麻烦。在尝试进行身份验证时，我在日志中发现了这一点:OpenID::FetchingError:Errorfetchinghttps://www.google.com/accounts/o8/.well-known/host-meta?hd=profiles.google.com%2Fmy_username:undefinedmethod`io'fornil:NilClass重要的是undefinedmethodio'fornil:NilClass来自openid/fetchers.rb，在下面的代码片段中:moduleNetclass

    4. ruby - 如何为 emacs 安装 ruby​​-mode - 2

      我刚刚为fedora安装了emacs。我想用emacs编写ruby。为ruby​​提供代码提示、代码完成类型功能所需的工具、扩展是什么？ 最佳答案 ruby-mode已经包含在Emacs23之后的版本中。不过，它也可以通过ELPA获得。您可能感兴趣的其他一些事情是集成RVM、feature-mode(Cucumber)、rspec-mode、ruby-electric、inf-ruby、rinari(用于Rails)等。这是我当前用于Ruby开发的Emacs配置:https://github.com/citizen428/emacs

    5. ruby-on-rails - 如何使用 instance_variable_set 正确设置实例变量？ - 2

      我正在查看instance_variable_set的文档并看到给出的示例代码是这样做的:obj.instance_variable_set(:@instnc_var,"valuefortheinstancevariable")然后允许您在类的任何实例方法中以@instnc_var的形式访问该变量。我想知道为什么在@instnc_var之前需要一个冒号:。冒号有什么作用？ 最佳答案 我的第一直觉是告诉你不要使用instance_variable_set除非你真的知道你用它做什么。它本质上是一种元编程工具或绕过实例变量可见性的黑客攻击

    6. ruby-on-rails - 独立 ruby​​ 脚本的配置文件 - 2

      我有一个在Linux服务器上运行的ruby​​脚本。它不使用rails或任何东西。它基本上是一个命令行ruby​​脚本，可以像这样传递参数:./ruby_script.rbarg1arg2如何将参数抽象到配置文件(例如yaml文件或其他文件)中？您能否举例说明如何做到这一点？提前谢谢你。 最佳答案 首先，您可以运行一个写入YAML配置文件的独立脚本:require"yaml"File.write("path_to_yaml_file",[arg1,arg2].to_yaml)然后，在您的应用中阅读它:require"yaml"arg

    7. ruby-on-rails - date_field_tag，如何设置默认日期？ [ rails 上的 ruby ] - 2

      我想设置一个默认日期，例如实际日期，我该如何设置？还有如何在组合框中设置默认值顺便问一下，date_field_tag和date_field之间有什么区别？ 最佳答案 试试这个:将默认日期作为第二个参数传递。youcorrectlysetthedefaultvalueofcomboboxasshowninyourquestion. 关于ruby-on-rails-date_field_tag，如何设置默认日期？[rails上的ruby]，我们在StackOverflow上找到一个类似的问

    8. Ruby Sinatra 配置用于生产和开发 - 2

      我已经在Sinatra上创建了应用程序，它代表了一个简单的API。我想在生产和开发上进行部署。我想在部署时选择，是开发还是生产，一些方法的逻辑应该改变，这取决于部署类型。是否有任何想法，如何完成以及解决此问题的一些示例。例子:我有代码get'/api/test'doreturn"Itisdev"end但是在部署到生产环境之后我想在运行/api/test之后看到ItisPROD如何实现？ 最佳答案 根据SinatraDocumentation:EnvironmentscanbesetthroughtheRACK_ENVenvironm

    9. ruby-on-rails - 在 Rails 开发环境中为 .ogv 文件设置 Mime 类型 - 2

      我正在玩HTML5视频并且在ERB中有以下片段:mp4视频从在我的开发环境中运行的服务器很好地流式传输到chrome。然而firefox显示带有海报图像的视频播放器，但带有一个大X。问题似乎是mongrel不确定ogv扩展的mime类型，并且只返回text/plain，如curl所示:$curl-Ihttp://0.0.0.0:3000/pr6.ogvHTTP/1.1200OKConnection:closeDate:Mon,19Apr201012:33:50GMTLast-Modified:Sun,18Apr201012:46:07GMTContent-Type:text/plain

    10. Python 相当于 Perl/Ruby ||= - 2

      这个问题在这里已经有了答案:关闭10年前。PossibleDuplicate:Pythonconditionalassignmentoperator对于这样一个简单的问题表示歉意，但是谷歌搜索||=并不是很有帮助；)Python中是否有与Ruby和Perl中的||=语句等效的语句？例如:foo="hey"foo||="what"#assignfooifit'sundefined#fooisstill"hey"bar||="yeah"#baris"yeah"另外，类似这样的东西的通用术语是什么？条件分配是我的第一个猜测，但Wikipediapage跟我想的不太一样。

    随机推荐