[英]Run / Debug a Django application's UnitTests from the mouse right click context menu in PyCharm Community Edition?
我必须强调PyCharm社区版，它没有任何Django集成（问题时间为v 2016.3.2 ）。
我已经用谷歌搜索了我的问题，并且（令人惊讶的是）我没有得到任何答案，（当然我不排除可能存在一些问题的可能性，但是我只是错过了它们）。
问题很简单：在PyCharm 中，只需单击鼠标右键（从上下文菜单中）即可运行（调试）单元测试（ TestCase或其方法之一），如下图所示：
不幸的是，这产生了一个例外：
Traceback (most recent call last): File "C:\\Install\\PyCharm Community Edition\\2016.3.2\\helpers\\pycharm\\utrunner.py", line 254, in <module> main() File "C:\\Install\\PyCharm Community Edition\\2016.3.2\\helpers\\pycharm\\utrunner.py", line 232, in main module = loadSource(a[0]) File "C:\\Install\\PyCharm Community Edition\\2016.3.2\\helpers\\pycharm\\utrunner.py", line 65, in loadSource module = imp.load_source(moduleName, fileName) File "E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\tests.py", line 7, in <module> from polls.models import Question File "E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\models.py", line 9, in <module> class Question(models.Model): File "E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\models.py", line 10, in Question question_text = models.CharField(max_length=200) File "E:\\Work\\Dev\\VEnvs\\py2713x64-django\\lib\\site-packages\\django\\db\\models\\fields\\__init__.py", line 1043, in __init__ super(CharField, self).__init__(*args, **kwargs) File "E:\\Work\\Dev\\VEnvs\\py2713x64-django\\lib\\site-packages\\django\\db\\models\\fields\\__init__.py", line 166, in __init__ self.db_tablespace = db_tablespace or settings.DEFAULT_INDEX_TABLESPACE File "E:\\Work\\Dev\\VEnvs\\py2713x64-django\\lib\\site-packages\\django\\conf\\__init__.py", line 53, in __getattr__ self._setup(name) File "E:\\Work\\Dev\\VEnvs\\py2713x64-django\\lib\\site-packages\\django\\conf\\__init__.py", line 39, in _setup % (desc, ENVIRONMENT_VARIABLE)) django.core.exceptions.ImproperlyConfigured: Requested setting DEFAULT_INDEX_TABLESPACE, but settings are not configured. You must either define the environment variable DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.
注意：我添加这个问题只是为了提供一个可能对某人有用的答案。
考虑到上述情况，对于某些高级用户来说，解决方案的某些（或全部）部分可能看起来很麻烦/愚蠢，所以请耐心等待。 我将在解决方案中加入任何可能增加价值的评论。
回到问题：我对一个项目进行了测试/研究，该项目由Django 教程（ [DjangoProject]：编写您的第一个 Django 应用程序）+ Django Rest 框架教程（ [DRF]：快速入门）中的一些部分组成。 例如，我将尝试运行polls/tests.py ： QuestionViewTests.test_index_view_with_no_questions()
请注意，将DJANGO_SETTINGS_MODULE设置为异常指示，触发另一个，依此类推......
虽然这不是问题的答案（它只是远程相关），但我还是要发布它（我相信很多人已经这样做了）：
test QuestionViewTests.test_index_view_with_no_questions ）当然，必须为每个测试用例（及其方法）执行此操作并不是可行的方法（这确实很烦人），因此这种方法不可扩展。
需要注意的是，我不认为这是一个真正的解决方案，它更像是一种（蹩脚的）解决方法（ Gainarie ），而且它也具有侵入性。
让我们先看看当我们RClick在一个测试上时会发生什么（我将一般使用这个术语 - 它可能意味着测试用例或方法或整个测试文件，除非另有说明）。 对我来说，它正在运行以下命令：
"E:\\Work\\Dev\\VEnvs\\py2713x64-django\\Scripts\\python.exe" "C:\\Install\\PyCharm Community Edition\\2016.3.2\\helpers\\pycharm\\utrunner.py" E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\tests.py::QuestionViewTests::test_index_view_with_no_questions true
如您所见，它正在启动“ C:\\Install\\PyCharm Community Edition\\2016.3.2\\helpers\\pycharm\\utrunner.py ”（我将其称为utrunner ）并带有一堆参数（第一个对我们很重要，因为它是测试规范）。 utrunner使用一个不关心Django的测试运行框架（实际上有一些Django处理代码，但这对我们没有帮助）。
关于PyCharm的运行/调试配置的几句话：
考虑到上述情况，让我们继续：
您需要做的第一件事是：从Run/Debug Configurations对话框（菜单： Run -> Edit Configurations... ），编辑Defaults/Python 测试/Unittests设置：
第二件事也是更棘手的一件事（也涉及入侵）：修补utrunner 。
utrunner.patch ：
--- utrunner.py.orig 2016-12-28 19:06:22.000000000 +0200
+++ utrunner.py 2017-03-23 15:20:13.643084400 +0200
@@ -113,7 +113,74 @@
except:
pass
-if __name__ == "__main__":
+
+def fileToMod(filePath, basePath):
+ if os.path.exists(filePath) and filePath.startswith(basePath):
+ modList = filePath[len(basePath):].split(os.path.sep)
+ mods = ".".join([os.path.splitext(item)[0] for item in modList if item])
+ return mods
+ else:
+ return None
+
+
+def utrunnerArgToDjangoTest(arg, basePath):
+ if arg.strip() and not arg.startswith("--"):
+ testData = arg.split("::")
+ mods = fileToMod(testData[0], basePath)
+ if mods:
+ testData[0] = mods
+ return ".".join(testData)
+ else:
+ return None
+ else:
+ return None
+
+
+def flushBuffers():
+ sys.stdout.write(os.linesep)
+ sys.stdout.flush()
+ sys.stderr.write(os.linesep)
+ sys.stderr.flush()
+
+
+def runModAsMain(argv, codeGlobals):
+ with open(argv[0]) as f:
+ codeStr = f.read()
+ sys.argv = argv
+ code = compile(codeStr, os.path.basename(argv[0]), "exec")
+ codeGlobals.update({
+ "__name__": "__main__",
+ "__file__": argv[0]
+ })
+ exec(code, codeGlobals)
+
+
+def djangoMain():
+ djangoTests = list()
+ basePath = os.getcwd()
+ for arg in sys.argv[1: -1]:
+ djangoTest = utrunnerArgToDjangoTest(arg, basePath)
+ if djangoTest:
+ djangoTests.append(djangoTest)
+ if not djangoTests:
+ debug("/ [DJANGO MODE] Invalid arguments: " + sys.argv[1: -1])
+ startupTestArgs = [item for item in os.getenv("DJANGO_STARTUP_TEST_ARGS", "").split(" ") if item]
+ startupFullName = os.path.join(basePath, os.getenv("DJANGO_STARTUP_NAME", "manage.py"))
+ if not os.path.isfile(startupFullName):
+ debug("/ [DJANGO MODE] Invalid startup file: " + startupFullName)
+ return
+ djangoStartupArgs = [startupFullName, "test"]
+ djangoStartupArgs.extend(startupTestArgs)
+ djangoStartupArgs.extend(djangoTests)
+ additionalGlobalsStr = os.getenv("DJANGO_STARTUP_ADDITIONAL_GLOBALS", "{}")
+ import ast
+ additionalGlobals = ast.literal_eval(additionalGlobalsStr)
+ flushBuffers()
+ runModAsMain(djangoStartupArgs, additionalGlobals)
+ flushBuffers()
+
+
+def main():
arg = sys.argv[-1]
if arg == "true":
import unittest
@@ -186,3 +253,10 @@
debug("/ Loaded " + str(all.countTestCases()) + " tests")
TeamcityTestRunner().run(all, **options)
+
+
+if __name__ == "__main__":
+ if os.getenv("DJANGO_TEST_MODE_GAINARIE"):
+ djangoMain()
+ else:
+ main()
上面是一个diff ( [man7]: DIFF(1) )（或一个补丁- 名称可以连用 - 我喜欢（并将使用）补丁）：它显示了utrunner.py.orig （原始文件 - 我在开始修改之前保存的，你不需要这样做）和utrunner.py （包含更改的当前版本）。 我使用的命令是diff --binary -uN utrunner.py.orig utrunner.py （显然，在utrunner的文件夹中）。 作为个人的话，补丁的改变第三方源代码中的优选形式（控制住的变化，并分离）。
补丁中的代码做了什么（它可能比普通的Python代码更难理解）：
if __name__ == "__main__":或当前行为）都已移至名为main的函数中（以使其保持独立并避免错误地更改它）fileToMod("E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\tests.py", "E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src") ，将返回polls.testsE:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\tests.py::QuestionViewTests::test_index_view_with_no_questions ）到manage.py格式（ polls.tests.QuestionViewTests.test_index_view_with_no_questions ）if __name__ == "__main__": 。 这个函数“欺骗”了Python ，让它相信manage.py是作为它的第一个参数运行的修补utrunner ：
patch -i /tmp/utrunner.patch 。 [man7]：PATCH(1)是一个默认安装的实用程序（ Ubtu中补丁dpkg 的一部分）。 请注意，由于utrunner.py归root 所有，因此在此步骤中您需要sudopatch -Ri /tmp/utrunner.patch ，它将把它切换回原来的内容（它还会创建一个utrunner.py.orig文件修改后的内容；它实际上会切换.py和.py.orig文件）。关于这种方法的几句话：
代码可以处理（可选）环境变量（除了DJANGO_TEST_MODE_GAINARIE - 这是强制性的）：
manage.py test接受的附加参数（运行manage.py test --help以获取整个列表）。 在这里，我必须坚持-k / --keepdb在运行之间保留测试数据库（默认情况下test_${REGULAR_DB_NAME}或在TEST字典下的设置中设置）。 运行单个测试时，创建数据库（并应用所有迁移）并销毁它可能很耗时（而且也很烦人）。 此标志确保数据库在最后不会被删除，并将在下一次测试运行时重新使用globals()字典中出现的任何值都应该放在这里修改默认配置时，所有先前创建的继承它的配置都不会更新，因此必须手动删除它们（并且将在其测试中由新的RClick自动重新创建）
R单击相同的测试（删除其先前的配置后：d），然后瞧：
E:\\Work\\Dev\\VEnvs\\py2713x64-django\\Scripts\\python.exe "C:\\Install\\PyCharm Community Edition\\2016.3.2\\helpers\\pycharm\\utrunner.py" E:\\Work\\Dev\\Django\\Tutorials\\proj0\\src\\polls\\tests.py::QuestionViewTests::test_index_view_with_no_questions true Testing started at 01:38 ... Using existing test database for alias 'default'... . ---------------------------------------------------------------------- Ran 1 test in 0.390s OK Preserving test database for alias 'default'... Process finished with exit code 0
调试也有效（断点，等等......）。
注意事项（到目前为止，我确定了其中的 2 个）：
input （ raw_input ）调用都没有得到很好的处理； 提示文本：“如果您想尝试删除测试数据库‘test_tut-proj0’，请输入‘yes’，或者‘no’取消： ”（如果之前的测试运行崩溃，并且其数据库在最后）没有被显示并且程序冻结（这不会发生在utrunner之外），而不让用户输入文本（也许混合中有线程？）。 恢复的唯一方法是停止测试运行，删除数据库并再次运行测试。 再次，我必须提升manage.py test -k标志来解决这个问题我已经在以下环境中工作/测试过：
注意事项：
正如我在开头所说的，任何建议都非常受欢迎！
@编辑0 ：
请参阅https://github.com/AndreyMZ/jb_django_test_runner/blob/master/README.md 。
优点：
如何在 PyCharm 社区版中为 Django 项目运行调试服务器？
[英]How to run Debug server for Django project in PyCharm Community Edition?
如何在Pycharm Mac Osx Community Edition 5中将模板语言设置为Django？
[英]How to set Template Language to Django in Pycharm Mac Osx Community Edition 5?
Django 和 Pycharm 社区版文档类型 html 意外令牌
[英]Django and Pycharm Community Edition Doctype html Unexpected Token
如何在 PyCharm 社区版中运行和编辑 Jupyter Notebook 代码
[英]How to run and edit Jupyter Notebook Code in PyCharm Community Edition
声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.