相对导入需要提供“package”参数

Question

我想使用Sphinx自动生成我的Python代码的pydoc，但是出错了。我做错了什么？

conf.py Sphinx配置文件

import sys
import os
from django.conf import settings
os.environ['DJANGO_SETTINGS_MODULE'] = '../cloud_server.settings'

sys.path.insert(0, os.path.abspath('../cloud_server/cloud_api'))

views.py是Django文件。

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from cloud_api.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

当我尝试创建HTML文件时，出现了TypeError错误。

    C:\Users\ogward\STUDPROJ\docs\code.rst:3: WARNING: autodoc: failed to import module u'views'; the following exception wa
s raised:
Traceback (most recent call last):
  File "C:\Python27\lib\site-packages\sphinx-1.2.2-py2.7.egg\sphinx\ext\autodoc.py", line 335, in import_object
    __import__(self.modname)
  File "C:\Users\ogward\STUDPROJ\cloud_server\cloud_api\views.py", line 1, in <module>
    from django.contrib.auth.models import User, Group
  File "C:\Python27\lib\site-packages\django\contrib\auth\__init__.py", line 6, in <module>
    from django.middleware.csrf import rotate_token
  File "C:\Python27\lib\site-packages\django\middleware\csrf.py", line 14, in <module>
    from django.utils.cache import patch_vary_headers
  File "C:\Python27\lib\site-packages\django\utils\cache.py", line 26, in <module>
    from django.core.cache import get_cache
  File "C:\Python27\lib\site-packages\django\core\cache\__init__.py", line 69, in <module>
    if DEFAULT_CACHE_ALIAS not in settings.CACHES:
  File "C:\Python27\lib\site-packages\django\conf\__init__.py", line 54, in __getattr__
    self._setup(name)
  File "C:\Python27\lib\site-packages\django\conf\__init__.py", line 49, in _setup
    self._wrapped = Settings(settings_module)
  File "C:\Python27\lib\site-packages\django\conf\__init__.py", line 128, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
  File "C:\Python27\lib\site-packages\django\utils\importlib.py", line 33, in import_module
    raise TypeError("relative imports require the 'package' argument")
TypeError: relative imports require the 'package' argument
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] code
writing output... [100%] index

writing additional files... genindex search
copying static files... done
copying extra files... done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.

- ogward

Answer 1

我通过Google找到这个问题，所以我会回答对我有帮助的内容（与问题不直接相关）。

我使用importlib来根据字符串动态导入子包。

import importlib
module_name = 'subpackage.i.import'
special_module = importlib.import_module(module_name, package=None)

这只需要进行调整即可。

import importlib
module_name = 'subpackage.i.import'
special_module = importlib.import_module(module_name, package='my_current_pkg')

- Martin Thoma

Answer 2

DJANGO_SETTINGS_MODULE 需要是一个 Python 模块标识符，而不是文件系统路径。查看 django/conf/__init__py 文件，似乎在那里使用相对路径引用你的设置模块是无法工作的。你需要将其移动到列在你的 sys.path 中的目录下，或者添加父目录到你的 sys.path 并从那里引用你的设置模块。

- lanzz

---

谢谢！为了返回上一级目录，我添加了这行代码 sys.path.append(os.path.join(os.path.dirname(__file__), '..'))。 - undefined

Answer 3

如果您在指定设置文件名时出现拼写错误，也可能会导致出现此错误。

- Jan Kyu Peblik

Answer 4

你需要像这样将项目路径添加到sys路径中

sys.path.append("C:\\Users\\ogward\\STUDPROJ") 
os.environ['DJANGO_SETTINGS_MODULE'] = '../cloud_server.settings'
 

- Saurabh Chandra Patel

---

这可能只在本地机器上运行，但在尝试部署到远程服务器时会引起问题。 - devmike01

Answer 5

1. 可能是您在uwsgi.py中设置的设置不正确

2. uwsgi.py中的设置路径（XXXX与uwsgi.py在同一目录中）：

   os.environ.setdefault("DJANGO_SETTINGS_MODULE", "XXXX.settings")

- jammyWolf