如何导入__init__.py中定义的类


105

我正在尝试组织一些供我自己使用的模块。我有这样的事情:

lib/
  __init__.py
  settings.py
  foo/
    __init__.py
    someobject.py
  bar/
    __init__.py
    somethingelse.py

在中lib/__init__.py,如果要导入lib,我想定义一些要使用的类。但是,如果不将这些类分离到文件中并将其导入中,我似乎无法弄清楚__init__.py

与其说:

    lib/
      __init__.py
      settings.py
      helperclass.py
      foo/
        __init__.py
        someobject.py
      bar/
        __init__.py
        somethingelse.py

from lib.settings import Values
from lib.helperclass import Helper

我想要这样的东西:

    lib/
      __init__.py  #Helper defined in this file
      settings.py
      foo/
        __init__.py
        someobject.py
      bar/
        __init__.py
        somethingelse.py

from lib.settings import Values
from lib import Helper

有可能吗,还是我必须将类分成另一个文件?

编辑

好的,如果我从另一个脚本导入lib,则可以访问Helper类。如何从settings.py访问Helper类?

此处的示例描述了包装内参考。我引用“子模块经常需要互相引用”。就我而言,lib.settings.py需要Helper,而lib.foo.someobject需要访问Helper,那么我应该在哪里定义Helper类?


您的最后一个示例应该起作用。您看到ImportError吗?您可以粘贴详细信息吗?
Joe Holloway

Answers:


81
  1. lib/的父目录必须是sys.path

  2. 您的“ lib/__init__.py”可能看起来像这样:

    from . import settings # or just 'import settings' on old Python versions
    class Helper(object):
          pass

然后,以下示例应该起作用:

from lib.settings import Values
from lib import Helper

回答问题的编辑版本:

__init__.py定义包从外部的外观。如果需要使用Helperin,settings.pyHelper在另一个文件中定义,例如' lib/helper.py'。

。
| `-import_submodule.py
    `-lib
    |-__init__.py
    |-foo
    | |-__init__.py
    | `-someobject.py
    |-helper.py
    `-settings.py

2个目录,6个文件

命令:

$ python import_submodule.py

输出:

settings
helper
Helper in lib.settings
someobject
Helper in lib.foo.someobject

# ./import_submodule.py
import fnmatch, os
from lib.settings import Values
from lib import Helper

print
for root, dirs, files in os.walk('.'):
    for f in fnmatch.filter(files, '*.py'):
        print "# %s/%s" % (os.path.basename(root), f)
        print open(os.path.join(root, f)).read()
        print


# lib/helper.py
print 'helper'
class Helper(object):
    def __init__(self, module_name):
        print "Helper in", module_name


# lib/settings.py
print "settings"
import helper

class Values(object):
    pass

helper.Helper(__name__)


# lib/__init__.py
#from __future__ import absolute_import
import settings, foo.someobject, helper

Helper = helper.Helper


# foo/someobject.py
print "someobject"
from .. import helper

helper.Helper(__name__)


# foo/__init__.py
import someobject

在示例中,如何将Helper类导入到settings.py文件中?
斯科特,

我不明白为什么这是循环的。如果settings.py需要帮助程序,并且说foo.someobject.py需要帮助程序,那么您建议在哪里定义它?
斯科特,

哇,在该示例中,“ helper”一词的含义开始变得松散。但是,您已经向我展示了我在寻找什么。
斯科特

3
赞成“ __init__.py定义了您的程序包从外部的外观”。
Petri

19

如果lib/__init__.py定义了Helper类,则可以在settings.py中使用:

from . import Helper

这是因为。是当前目录,从设置模块的角度来看,它是lib软件包的同义词。请注意,不必通过导出助手__all__

(已在Windows上运行的python 2.7.10确认。)


1
这对我来说很好,请支持者请解释您的不满意?
yoyo 2015年

8

您只需将它们放在__init__.py中。

因此,与test / classes.py是:

class A(object): pass
class B(object): pass

...并且测试/__init__.py为:

from classes import *

class Helper(object): pass

您可以导入测试并可以访问A,B和Helper

>>> import test
>>> test.A
<class 'test.classes.A'>
>>> test.B
<class 'test.classes.B'>
>>> test.Helper
<class 'test.Helper'>

您从哪里进口?
2009年

说我想从lib / settings.py导入Helper?
斯科特,

1
这几乎肯定会导致循环导入(设置将导入测试,测试将导入设置)...这将产生您描述的NameError。如果要在包内使用帮助程序,则应定义代码使用的内部模块。
亚伦·曼帕

1
init .py的帮助程序应该供外部用户使用,以简化您的API。
亚伦·曼帕

1
如果它不是API的一部分,那么init .py确实不是它的地方。lib / internal.py或类似文件会更好(这具有减少循环进口的可能性的双重目的)。
亚伦·曼帕


4

编辑,因为我误解了这个问题:

只需Helper上课__init__.py。那完全是pythonic。来自Java之类的语言使人感到奇怪。


你误会了。如果可能,我想消除helperClass.py文件。
斯科特,

理查德不是唯一被误解的人。您的示例应该可以正常工作。什么是回溯?
Troy J. Farrell,2009年

好吧,那么我正确地阅读了文档。所以,现在我只是做了一个测试用例,它工作正常。
斯科特

我的程序包中有相同的设置,但是出现ImportError“无法导入名称助手”
scottm

我认为我的问题是我正在尝试从settings.py导入Helper类,该怎么办?
斯科特,

2

是的,有可能。您可能还想__all____init__.py文件中定义。这是您执行操作时将导入的模块列表

from lib import *

-6

也许这可以工作:

import __init__ as lib
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.