#31 makes django scripts compatibile with django > 3.1. by Giles and Filip

Author: filiplajszczak

pythonanywhere/django_project.py

@@ -3,6 +3,8 @@
 import shutil
 import subprocess
 
+from packaging import version
+
 from pythonanywhere.exceptions import SanityException
 from pythonanywhere.snakesay import snakesay
 from .project import Project
@@ -34,6 +36,7 @@ def detect_requirements(self):
         return 'django'
 
 
+
     def run_startproject(self, nuke):
         print(snakesay('Starting Django project'))
         if nuke and self.project_path.exists():
@@ -67,12 +70,21 @@ def update_settings_file(self):
             'ALLOWED_HOSTS = []',
             f'ALLOWED_HOSTS = [{self.domain!r}]'
         )
+
+        new_django = version.parse(self.virtualenv.get_version("django")) >= version.parse("3.1")
+
         if re.search(r'^MEDIA_ROOT\s*=', settings, flags=re.MULTILINE) is None:
             new_settings += "\nMEDIA_URL = '/media/'"
         if re.search(r'^STATIC_ROOT\s*=', settings, flags=re.MULTILINE) is None:
-            new_settings += "\nSTATIC_ROOT = os.path.join(BASE_DIR, 'static')"
+            if new_django:
+                new_settings += "\nSTATIC_ROOT = Path(BASE_DIR / 'static')"
+            else:
+                new_settings += "\nSTATIC_ROOT = os.path.join(BASE_DIR, 'static')"
         if re.search(r'^MEDIA_ROOT\s*=', settings, flags=re.MULTILINE) is None:
-            new_settings += "\nMEDIA_ROOT = os.path.join(BASE_DIR, 'media')"
+            if new_django:
+                new_settings += "\nMEDIA_ROOT = Path(BASE_DIR / 'media')"
+            else:
+                new_settings += "\nMEDIA_ROOT = os.path.join(BASE_DIR, 'media')"
 
         with self.settings_path.open('w') as f:
             f.write(new_settings)

pythonanywhere/virtualenvs.py

@@ -26,3 +26,10 @@ def pip_install(self, packages):
         print(snakesay(f"Pip installing {packages} (this may take a couple of minutes)"))
         commands = [str(self.path / "bin/pip"), "install"] + packages.split()
         subprocess.check_call(commands)
+
+    def get_version(self, package_name):
+        commands = [str(self.path / "bin/pip"), "show", package_name]
+        output = subprocess.check_output(commands).decode()
+        for line in output.splitlines():
+            if line.startswith("Version: "):
+                return line.split()[1]

pythonanywhere/virtualenvs.pyi

@@ -10,3 +10,4 @@ class Virtualenv:
     def __eq__(self, other: Virtualenv) -> bool: ...
     def create(self, nuke: bool) -> None: ...
     def pip_install(self, packages: List[str]) -> None: ...
+    def get_version(self, package_name: str) -> str: ...

requirements.txt

@@ -1,5 +1,6 @@
 python-dateutil==2.8.1
 docopt==0.6.2
+packaging
 psutil==5.7.0
 pytest==5.4.2
 pytest-cov==2.8.1

tests/test_django_project.py

@@ -196,9 +196,10 @@ def test_raises_if_manage_py_not_found(self, fake_home, non_nested_submodule, vi
 
 
 class TestUpdateSettingsFile:
-    def test_adds_STATIC_and_MEDIA_config_to_settings(self, virtualenvs_folder):
+    def test_adds_STATIC_and_MEDIA_config_to_settings_with_old_django(self, virtualenvs_folder):
         project = DjangoProject("mydomain.com", "python.version")
         project.settings_path = Path(tempfile.NamedTemporaryFile().name)
+        project.virtualenv.get_version = Mock(return_value="1.0")
 
         with project.settings_path.open("w") as f:
             f.write(
@@ -221,9 +222,36 @@ def test_adds_STATIC_and_MEDIA_config_to_settings(self, virtualenvs_folder):
         assert "STATIC_ROOT = os.path.join(BASE_DIR, 'static')" in lines
         assert "MEDIA_ROOT = os.path.join(BASE_DIR, 'media')" in lines
 
+    def test_adds_STATIC_and_MEDIA_config_to_settings_with_new_django(self, virtualenvs_folder):
+        project = DjangoProject("mydomain.com", "python.version")
+        project.settings_path = Path(tempfile.NamedTemporaryFile().name)
+        project.virtualenv.get_version = Mock(return_value="3.1.1")
+
+        with project.settings_path.open("w") as f:
+            f.write(
+                dedent(
+                    """
+                    # settings file
+                    STATIC_URL = '/static/'
+                    ALLOWED_HOSTS = []
+                    """
+                )
+            )
+
+        project.update_settings_file()
+
+        with project.settings_path.open() as f:
+            lines = f.read().split("\n")
+
+        assert "STATIC_URL = '/static/'" in lines
+        assert "MEDIA_URL = '/media/'" in lines
+        assert "STATIC_ROOT = Path(BASE_DIR / 'static')" in lines
+        assert "MEDIA_ROOT = Path(BASE_DIR / 'media')" in lines
+
     def test_adds_domain_to_ALLOWED_HOSTS(self, virtualenvs_folder):
         project = DjangoProject("mydomain.com", "python.version")
         project.settings_path = Path(tempfile.NamedTemporaryFile().name)
+        project.virtualenv.get_version = Mock(return_value="1.0")
 
         with project.settings_path.open("w") as f:
             f.write(
@@ -246,6 +274,7 @@ def test_adds_domain_to_ALLOWED_HOSTS(self, virtualenvs_folder):
     def test_only_adds_MEDIA_URL_if_its_not_already_there(self, virtualenvs_folder):
         project = DjangoProject("mydomain.com", "python.version")
         project.settings_path = Path(tempfile.NamedTemporaryFile().name)
+        project.virtualenv.get_version = Mock(return_value="1.0")
 
         with project.settings_path.open("w") as f:
             f.write(
@@ -270,6 +299,7 @@ def test_only_adds_MEDIA_URL_if_its_not_already_there(self, virtualenvs_folder):
     def test_only_adds_STATIC_ROOT_if_its_not_already_there(self, virtualenvs_folder):
         project = DjangoProject("mydomain.com", "python.version")
         project.settings_path = Path(tempfile.NamedTemporaryFile().name)
+        project.virtualenv.get_version = Mock(return_value="1.0")
 
         with project.settings_path.open("w") as f:
             f.write(
@@ -294,6 +324,7 @@ def test_only_adds_STATIC_ROOT_if_its_not_already_there(self, virtualenvs_folder
     def test_only_adds_MEDIA_ROOT_if_its_not_already_there(self, virtualenvs_folder):
         project = DjangoProject("mydomain.com", "python.version")
         project.settings_path = Path(tempfile.NamedTemporaryFile().name)
+        project.virtualenv.get_version = Mock(return_value="1.0")
 
         with project.settings_path.open("w") as f:
             f.write(

tests/test_virtualenvs.py

@@ -52,3 +52,12 @@ def test_actually_installing_a_real_package(self, fake_home, virtualenvs_folder)
         v.pip_install("aafigure")
 
         subprocess.check_call([str(v.path / "bin/python"), "-c" "import aafigure"])
+
+    @pytest.mark.slowtest
+    def test_gets_version(self, fake_home, virtualenvs_folder):
+        running_python_version = ".".join(python_version().split(".")[:2])
+        v = Virtualenv("www.adomain.com", running_python_version)
+        v.create(nuke=False)
+        v.pip_install("aafigure==0.6")
+
+        assert v.get_version("aafigure") == "0.6"