草庐IT

python - 如何将多个 python 文件组织成一个模块而不像一个包？

coder 2023-05-22 原文

有没有办法使用__init__.py将多个文件组织成一个 模块 ?

原因:模块比包更容易使用，因为它们没有那么多的命名空间层。

通常它会制作一个包裹，这是我得到的。问题在于包，“导入包”给了我一个空的命名空间。然后，用户必须要么使用“from thepackage import *”(不赞成)，要么确切地知道所包含的内容并手动将其拉出到可用的命名空间中。

我想要的是用户执行“导入包”并拥有看起来像这样的漂亮干净的命名空间，公开与项目相关的函数和类以供使用。

current_module
\
  doit_tools/
  \
   - (class) _hidden_resource_pool
   - (class) JobInfo
   - (class) CachedLookup
   - (class) ThreadedWorker
   - (Fn) util_a
   - (Fn) util_b
   - (Fn) gather_stuff
   - (Fn) analyze_stuff

维护者的工作是避免在不同的文件中定义相同的名称，当项目像我这样很小时，这应该很容易。

如果人们能做也不错from doit_stuff import JobInfo并让它检索类，而不是包含类的模块。

如果我的所有代码都在一个巨大的文件中，这很容易，但是我喜欢在事情开始变大时进行组织。我在磁盘上的内容看起来像这样:
place_in_my_python_path/
  doit_tools/
    __init__.py
    JobInfo.py
      - class JobInfo:
    NetworkAccessors.py
      - class _hidden_resource_pool:
      - class CachedLookup:
      - class ThreadedWorker:
    utility_functions.py
      - def util_a()
      - def util_b()
    data_functions.py
      - def gather_stuff()
      - def analyze_stuff()

我只将它们分开，所以我的文件不是很大且无法导航。它们都是相关的，尽管有人(可能是我)可能想自己使用这些类而不导入所有内容。

我已经阅读了各种线程中的许多建议，以下是我可以找到的有关如何执行此操作的每个建议的情况:

如果我不使用 __init__.py ，我无法导入任何内容，因为 Python 不会从 sys.path 进入文件夹。

如果我使用空白 __init__.py ，当我 import doit_tools它是一个空命名空间，里面什么都没有。我没有导入任何文件，这使得使用起来更加困难。

如果我在 __all__ 中列出子模块，我可以使用(皱眉？)from thing import *语法，但我所有的类都再次位于不必要的命名空间障碍之后。用户必须 (1) 知道他们应该使用 from x import *而不是 import x , (2) 手动重新排列类，直到它们可以合理地遵守线宽样式约束。

如果我添加 from thatfile import X对 __init__.py 的声明，我走得更近了，但我有命名空间冲突 (?) 和我不想在那里的东西的额外命名空间。在下面的示例中，您将看到:
  • JobInfo 类覆盖了名为 JobInfo 的模块对象，因为它们的名称相同。不知何故，Python 可以解决这个问题，因为 JobInfo 的类型是 <class 'doit_tools.JobInfo.JobInfo'> . (doit_tools.JobInfo 是一个类，但 doit_tools.JobInfo.JobInfo 是同一个类...这很纠结，看起来很糟糕，但似乎没有破坏任何东西。)
  • 每个文件名都进入了 doit_tools 命名空间，如果有人正在查看模块的内容，这会使查看更加困惑。我想要 doit_tools.utility_functions.py 来保存一些代码，而不是定义一个新的命名空间。

    • .
    current_module
\
  doit_tools/
  \
   - (module) JobInfo
      \
       - (class) JobInfo
   - (class) JobInfo
   - (module) NetworkAccessors
      \
       - (class) CachedLookup
       - (class) ThreadedWorker
   - (class) CachedLookup
   - (class) ThreadedWorker
   - (module) utility_functions
      \
       - (Fn) util_a
       - (Fn) util_b
   - (Fn) util_a
   - (Fn) util_b
   - (module) data_functions
      \
       - (Fn) gather_stuff
       - (Fn) analyze_stuff
   - (Fn) gather_stuff
   - (Fn) analyze_stuff

    另外，当他们执行“from doit_tools import JobInfo”时，只导入数据抽象类的人会得到与他们预期不同的东西:
    current_namespace
\
 JobInfo (module)
  \
   -JobInfo (class)

instead of:

current_namespace
\
 - JobInfo (class)

    那么，这只是一种错误的组织 Python 代码的方式吗？如果不是，那么拆分相关代码但仍以类似模块的方式收集它的正确方法是什么？

    也许最好的情况是，对于使用该包的人来说，执行“from doit_tools import JobInfo”有点令人困惑？

    也许是一个名为“api”的 python 文件，以便使用代码的人执行以下操作？:
    import doit_tools.api
from doit_tools.api import JobInfo

    ============================================

    回复评论的例子:

    在python路径中的文件夹“foo”中获取以下包内容。
    foo/__init__.py
    __all__ = ['doit','dataholder','getSomeStuff','hold_more_data','SpecialCase']
from another_class import doit
from another_class import dataholder
from descriptive_name import getSomeStuff
from descriptive_name import hold_more_data
from specialcase import SpecialCase
    foo/specialcase.py
    class SpecialCase:
    pass
    foo/more.py
    def getSomeStuff():
    pass

class hold_more_data(object):
    pass
    foo/stuff.py
    def doit():
    print "I'm a function."

class dataholder(object):
    pass

    做这个:
    >>> import foo
>>> for thing in dir(foo): print thing
... 
SpecialCase
__builtins__
__doc__
__file__
__name__
__package__
__path__
another_class
dataholder
descriptive_name
doit
getSomeStuff
hold_more_data
specialcase
    another_class和 descriptive_name有没有杂乱无章的东西，还有额外的副本，例如doit() 在它们的命名空间下。

    如果我在名为 Data.py 的文件中有一个名为 Data 的类，当我执行“从数据导入数据”时，我会遇到命名空间冲突，因为 Data 是当前命名空间中的一个类，它位于模块 Data 内，不知何故也在当前命名空间。 (但 Python 似乎能够处理这个。)

    最佳答案

    您可以这样做，但这并不是一个好主意，而且您正在与 Python 模块/包应该工作的方式作斗争。通过在 __init__.py 中导入适当的名称您可以在包命名空间中访问它们。通过删除模块名称，您可以使它们无法访问。 (为什么需要删除它们，请参阅 this question )。所以你可以用这样的东西来接近你想要的东西(在 __init__.py 中):

    from another_class import doit
from another_class import dataholder
from descriptive_name import getSomeStuff
from descriptive_name import hold_more_data
del another_class, descriptive_name
__all__ = ['doit', 'dataholder', 'getSomeStuff', 'hold_more_data']

    但是，这将破坏后续对 import package.another_class 的尝试。 .通常，您不能从 package.module 导入任何内容。无需制作 package.module作为对该模块的可导入引用访问(尽管使用 __all__ 您可以阻止 from package import module )。

    更一般地，通过按类/函数拆分代码，您正在针对 Python 包/模块系统工作。 Python 模块通常应包含要作为一个单元导入的内容。为方便起见，直接在顶级包命名空间中导入子模块组件并不少见，但反过来——试图隐藏子模块并只允许通过顶级包命名空间访问它们的内容——将会导致到问题。此外，尝试“清理”模块的包命名空间也无济于事。这些模块应该在包命名空间中；那是他们所属的地方。

    关于python - 如何将多个 python 文件组织成一个模块而不像一个包？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/12540290/

    python一个codeclassimportmodulepackage

    有关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 - 使用 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

    4. ruby - 在 Ruby 中使用匿名模块 - 2

      假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

    5. 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时

    6. 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看起来疯狂不安全。所以，功能正常，

    7. ruby-on-rails - Ruby net/ldap 模块中的内存泄漏 - 2

      作为我的Rails应用程序的一部分，我编写了一个小导入程序，它从我们的LDAP系统中吸取数据并将其塞入一个用户表中。不幸的是，与LDAP相关的代码在遍历我们的32K用户时泄漏了大量内存，我一直无法弄清楚如何解决这个问题。这个问题似乎在某种程度上与LDAP库有关，因为当我删除对LDAP内容的调用时，内存使用情况会很好地稳定下来。此外，不断增加的对象是Net::BER::BerIdentifiedString和Net::BER::BerIdentifiedArray，它们都是LDAP库的一部分。当我运行导入时，内存使用量最终达到超过1GB的峰值。如果问题存在，我需要找到一些方法来更正我的代

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

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

    9. 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上找到一个类似的问题

    10. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

      给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

    随机推荐