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.

Answer 1

DJANGO_SETTINGS_MODULE应该是Python module identifier，而不是文件系统路径。查看django/conf/__init__py文件，似乎设置模块的相对路径无法在那里工作。您需要将其移至sys.path中列出的目录下方，或者您应将父目录添加到sys.path并从那里引用您的设置模块。

Answer 2

我是通过谷歌来回答这个问题的，所以我会回答什么对我有帮助（与这个问题没有直接关系）。

我使用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)

Answer 3

可能是您在uwsgi.py中设置的设置不正确
uwsgi.py中的设置路径（XXXX与uwsgi.py位于同一目录中）：

os.environ.setdefault（＆＃34; DJANGO_SETTINGS_MODULE＆＃34;，＆＃34; XXXX.settings＆＃34;）

Answer 4

如果您在指定设置文件名的地方出现错字，也可以得到此错误。

Answer 5

您需要像将项目路径添加到sys路径一样

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

相对导入需要'package'参数

5 个答案: