草庐IT

python - Python制作命名空间包的方法

coder 2023-08-13 原文

来自 Namespace Packages in distribute ，我知道我可以利用命名空间包将一个大的 Python 包分成几个较小的包。这真的很棒。该文件还提到:

Note, by the way, that your project’s source tree must include the namespace packages’ __init__.py files (and the __init__.py of any parent packages), in a normal Python package layout. These __init__.py files must contain the line:

__import__('pkg_resources').declare_namespace(__name__)

This code ensures that the namespace package machinery is operating and that the current package is registered as a namespace package.

我想知道保持目录层次结构与包层次结构相同有什么好处吗？或者，这只是 distribute/setuptools 的命名空间包特性的技术要求？

例如，

我想提供一个子包 foo.bar，这样我就必须构建以下文件夹层次结构并准备一个 __init__.py 以使 setup.py 在命名空间包中工作: 

~foo.bar/
~foo.bar/setup.py
~foo.bar/foo/__init__.py    <=    one-lined file dedicated to namespace packages
~foo.bar/foo/bar/__init__.py
~foo.bar/foo/bar/foobar.py

我不熟悉 namespace 包，但在我看来，1) foo/bar 和 2)(几乎)单行 __init__.py 是例行任务。他们确实提供了一些“这是一个命名空间包”的提示，但我认为我们已经在 setup.py 中获得了该信息？

编辑:

如以下 block 所示，我可以在我的工作目录中有一个没有嵌套目录和单行 __init__.py 的命名空间包吗？也就是说，我们是否可以要求 setup.py 仅通过输入一行 namespace_packages = ['foo'] 来自动生成这些包？

~foo.bar/
~foo.bar/setup.py
~foo.bar/src/__init__.py    <=    for bar package
~foo.bar/src/foobar.py

最佳答案

命名空间包主要在导入子包时有特殊作用。基本上，导入 foo.bar

时会发生以下情况
  • 导入器扫描 sys.path 寻找看起来像 foo 的东西。
  • 当它找到某些东西时，它会在已发现的 foo 内部寻找 bar。
  • 如果未找到 bar:
    1. 如果 foo 是一个普通包，则会引发一个 ImportError，表明 foo.bar 不存在。
    2. 如果 foo 是一个 namespace 包，导入器将返回到 sys.path 中寻找 foo 的下一个匹配项。 ImportError 只有在所有路径都已用尽时才会引发。

这就是它所做的，但没有解释您可能需要它的原因。假设您设计了一个大而有用的库 (foo)，但作为其中的一部分，您还开发了一个小但非常有用的实用程序 (foo.bar)，其他 python 程序员发现有用，即使他们对更大的图书馆没有用处。

您可以将它们作为一个大包(如您设计的那样)一起分发，即使大多数使用它的人只导入子模块。您的用户会发现这非常不方便，因为他们必须下载整个东西(全部 200MB!)，即使他们只真正对 10 行实用程序类感兴趣。如果您有一个开放许可证，您可能会发现有几个人最终 fork 了它，现在您的实用程序模块有六个不同的版本。

您可以重写整个库，使该实用程序位于 foo 命名空间之外(只是 bar 而不是 foo.bar)。您将能够单独分发该实用程序，您的一些用户会很高兴，但这需要大量工作，尤其是考虑到实际上有很多用户在使用整个库，因此他们将不得不重写他们的程序以使用新的。

因此，您真正想要的是一种单独安装 foo.bar 的方法，但在需要时也能与 foo 愉快地共存。

命名空间包正是允许这一点，foo 包的两个完全独立的安装可以共存。 setuptools 将认识到这两个包被设计为彼此相邻并礼貌地移动文件夹/文件，使它们都在路径上并显示为 foo ，一个包含 foo.bar，另一个包含 foo 的其余部分。

您将有两个不同的 setup.py 脚本，每个脚本一个。两个包中的 foo/__init__.py 必须表明它们是命名空间包，以便导入器知道要继续，而不管首先发现哪个包。

关于python - Python制作命名空间包的方法，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/8380381/

命名pythoncodefoobarsetuptoolsnamespace-packagemodule-packaging

有关python - Python制作命名空间包的方法的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby - Facter::Util::Uptime:Module 的未定义方法 get_uptime (NoMethodError) - 2

    我正在尝试设置一个puppet节点，但ruby​​gems似乎不正常。如果我通过它自己的二进制文件(/usr/lib/ruby/gems/1.8/gems/facter-1.5.8/bin/facter)在cli上运行facter，它工作正常，但如果我通过由ruby​​gems(/usr/bin/facter)安装的二进制文件，它抛出:/usr/lib/ruby/1.8/facter/uptime.rb:11:undefinedmethod`get_uptime'forFacter::Util::Uptime:Module(NoMethodError)from/usr/lib/ruby

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

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

  6. Ruby 方法() 方法 - 2

    我想了解Ruby方法methods()是如何工作的。我尝试使用“ruby方法”在Google上搜索，但这不是我需要的。我也看过ruby​​-doc.org，但我没有找到这种方法。你能详细解释一下它是如何工作的或者给我一个链接吗？更新我用methods()方法做了实验，得到了这样的结果:'labrat'代码classFirstdeffirst_instance_mymethodenddefself.first_class_mymethodendendclassSecond使用类#returnsavailablemethodslistforclassandancestorsputsSeco

  7. ruby-on-rails - Rails 3.2.1 中 ActionMailer 中的未定义方法 'default_content_type=' - 2

    我在我的项目中添加了一个系统来重置用户密码并通过电子邮件将密码发送给他，以防他忘记密码。昨天它运行良好(当我实现它时)。当我今天尝试启动服务器时，出现以下错误。=>BootingWEBrick=>Rails3.2.1applicationstartingindevelopmentonhttp://0.0.0.0:3000=>Callwith-dtodetach=>Ctrl-CtoshutdownserverExiting/Users/vinayshenoy/.rvm/gems/ruby-1.9.3-p0/gems/actionmailer-3.2.1/lib/action_mailer

  8. ruby - Highline 询问方法不会使用同一行 - 2

    设置:狂欢ruby1.9.2高线(1.6.13)描述:我已经相当习惯在其他一些项目中使用highline，但已经有几个月没有使用它了。现在，在Ruby1.9.2上全新安装时，它似乎不允许在同一行回答提示。所以以前我会看到类似的东西:require"highline/import"ask"Whatisyourfavoritecolor?"并得到:Whatisyourfavoritecolor?|现在我看到类似的东西:Whatisyourfavoritecolor?|竖线(|)符号是我的终端光标。知道为什么会发生这种变化吗？ 最佳答案

  9. ruby - 主要 :Object when running build from sublime 的未定义方法 `require_relative' - 2

    我已经从我的命令行中获得了一切，所以我可以运行rubymyfile并且它可以正常工作。但是当我尝试从sublime中运行它时，我得到了undefinedmethod`require_relative'formain:Object有人知道我的sublime设置中缺少什么吗？我正在使用OSX并安装了rvm。 最佳答案 或者，您可以只使用“require”，它应该可以正常工作。我认为“require_relative”仅适用于ruby​​1.9+ 关于ruby-主要:Objectwhenrun

  10. ruby - 多个属性的 update_column 方法 - 2

    我有一个具有一些属性的模型:attr1、attr2和attr3。我需要在不执行回调和验证的情况下更新此属性。我找到了update_column方法，但我想同时更新三个属性。我需要这样的东西:update_columns({attr1:val1,attr2:val2,attr3:val3})代替update_column(attr1,val1)update_column(attr2,val2)update_column(attr3,val3) 最佳答案 您可以使用update_columns(attr1:val1,attr2:val2

随机推荐