VimPlug/django-stubs
1
0
Fork 0
mirror of https://github.com/davidhalter/django-stubs.git synced 2025-12-15 08:17:08 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adds support for pyproject.toml files (#639)

Browse Source 
* Adds support for pyproject.toml files

Since mypy 0.900 the pyproject.toml files are supported.

This PR adds a support for it. It searchs for a `tool.django-stubs` section. This is an example configuration:

```
[tool.django-stubs]
django_settings_module = "config.settings.local"
```

Fixes #638

* Added TOML tests

* Use textwrap.dedent instead of trying to manually replace spaces
This commit is contained in:
Cesar Canassa
2021-06-15 00:50:31 +02:00
committed by GitHub
parent 8c387e85fe
commit 397e3f3dac
6 changed files with 135 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
tests/test_error_handling.py
View File

@@ -5,7 +5,8 @@ import pytest
from mypy_django_plugin.main import extract_django_settings_module
TEMPLATE = """usage: (config)
TEMPLATE = """
(config)
...
[mypy.plugins.django_stubs]
django_settings_module: str (required)
@@ -13,6 +14,15 @@ TEMPLATE = """usage: (config)
(django-stubs) mypy: error: 'django_settings_module' is not set: {}
"""
TEMPLATE_TOML = """
(config)
...
[tool.django-stubs]
django_settings_module = str (required)
...
(django-stubs) mypy: error: 'django_settings_module' not found or invalid: {}
"""
@pytest.mark.parametrize(
"config_file_contents,message_part",
@@ -52,10 +62,64 @@ def test_misconfiguration_handling(capsys, config_file_contents, message_part):
with pytest.raises(SystemExit, match="2"):
extract_django_settings_module(config_file.name)
error_message = TEMPLATE.format(message_part)
error_message = "usage: " + TEMPLATE.format(message_part)
assert error_message == capsys.readouterr().err
@pytest.mark.parametrize(
"config_file_contents,message_part",
[
(
"""
[tool.django-stubs]
django_settings_module = 123
""",
"the setting must be a string",
),
(
"""
[tool.not-really-django-stubs]
django_settings_module = "my.module"
""",
"no section [tool.django-stubs]",
),
(
"""
[tool.django-stubs]
not_django_not_settings_module = "badbadmodule"
""",
"the setting is not provided",
),
],
)
def test_toml_misconfiguration_handling(capsys, config_file_contents, message_part):
with tempfile.NamedTemporaryFile(mode="w+", suffix=".toml") as config_file:
config_file.write(config_file_contents)
config_file.seek(0)
with pytest.raises(SystemExit, match="2"):
extract_django_settings_module(config_file.name)
error_message = "usage: " + TEMPLATE_TOML.format(message_part)
assert error_message == capsys.readouterr().err
def test_correct_toml_configuration() -> None:
config_file_contents = """
[tool.django-stubs]
some_other_setting = "setting"
django_settings_module = "my.module"
"""
with tempfile.NamedTemporaryFile(mode="w+", suffix=".toml") as config_file:
config_file.write(config_file_contents)
config_file.seek(0)
extracted = extract_django_settings_module(config_file.name)
assert extracted == "my.module"
def test_correct_configuration() -> None:
"""Django settings module gets extracted given valid configuration."""
config_file_contents = [