Install Python Dev Dependencies to Virtual Environment

scripts/common_test.py

@@ -44,11 +44,11 @@
 from . import common
 
 
-# The pool_size argument is required by Requester.__init__(), but it is
-# missing from the typing definition in Requester.pyi.  We therefore
-# disable type checking here. A PR was open to PyGithub to fix this, but it was
-# closed due to inactivity (the project does not seem very active). Here is the
-# PR: https://github.com/PyGithub/PyGithub/pull/2151.
+# The pool_size argument is required by Requester.__init__(), but it is missing
+# from the typing definition in Requester.pyi.  We therefore disable type
+# checking here. A PR was opened to PyGithub to fix this, but it was closed due
+# to inactivity (the project does not seem very active). Here is the PR:
+# https://github.com/PyGithub/PyGithub/pull/2151.
 _MOCK_REQUESTER = github.Requester.Requester(  # type: ignore
     login_or_token=None,
     password=None,

scripts/install_python_dev_dependencies.py

@@ -41,8 +41,15 @@
     help='Assert that the dev requirements file is already compiled.')
 
 
-def check_python_env() -> None:
-    """Raise an error if we are not in a virtual environment or on CI."""
+def check_python_env_is_suitable() -> None:
+    """Raise an error if we are not in a virtual environment or on CI.
+
+    We want developers to use a virtual environment when developing locally so
+    that our scripts don't change their global Python environments. On CI
+    however, it's okay to change the global environment since the checks are
+    running in an epehmeral virtual machine. Therefore, a "suitable" Python
+    environment is one that either is on CI or is a virtual environment.
+    """
     if 'GITHUB_ACTION' in os.environ:
         # The GITHUB_ACTION environment variable indicates we are running on
         # GitHub Actions according to
@@ -116,7 +123,7 @@ def compile_pip_requirements(
 def main(cli_args: Optional[List[str]] = None) -> None:
     """Install all dev dependencies."""
     args = _PARSER.parse_args(cli_args)
-    check_python_env()
+    check_python_env_is_suitable()
     install_installation_tools()
     not_compiled = compile_pip_requirements(
         REQUIREMENTS_DEV_FILE_PATH, COMPILED_REQUIREMENTS_DEV_FILE_PATH)

scripts/install_python_dev_dependencies_test.py

@@ -57,17 +57,19 @@ def sys_real_prefix_context(
             else:
                 delattr(sys, 'real_prefix')
 
-    def test_check_python_env_passes_when_in_venv(self) -> None:
+    def test_check_python_env_is_suitable_passes_when_in_venv(self) -> None:
         prefix_swap = self.swap(
             sys, 'prefix', '/home/user/.pyenv/versions/3.7.10')
         base_prefix_swap = self.swap(
             sys, 'base_prefix', '/home/user/.pyenv/versions/oppia')
         real_prefix_manager = self.sys_real_prefix_context('')
         environ_swap = self.swap(os, 'environ', {})
         with prefix_swap, base_prefix_swap, real_prefix_manager, environ_swap:
-            install_python_dev_dependencies.check_python_env()
+            install_python_dev_dependencies.check_python_env_is_suitable()
 
-    def test_check_python_env_passes_when_in_venv_real_prefix(self) -> None:
+    def test_check_python_env_is_suitable_passes_when_in_venv_real_prefix(
+        self
+    ) -> None:
         prefix_swap = self.swap(
             sys, 'prefix', '/home/user/.pyenv/versions/3.7.10')
         base_prefix_swap = self.swap(
@@ -76,9 +78,9 @@ def test_check_python_env_passes_when_in_venv_real_prefix(self) -> None:
             '/home/user/.pyenv/versions/oppia')
         environ_swap = self.swap(os, 'environ', {})
         with prefix_swap, base_prefix_swap, real_prefix_manager, environ_swap:
-            install_python_dev_dependencies.check_python_env()
+            install_python_dev_dependencies.check_python_env_is_suitable()
 
-    def test_check_python_env_fails_when_out_of_venv(self) -> None:
+    def test_check_python_env_is_suitable_fails_when_out_of_venv(self) -> None:
         prefix_swap = self.swap(
             sys, 'prefix', '/home/user/.pyenv/versions/3.7.10')
         base_prefix_swap = self.swap(
@@ -88,20 +90,24 @@ def test_check_python_env_fails_when_out_of_venv(self) -> None:
         expected_error = (
             'Oppia must be developed within a virtual environment.')
         with self.assertRaisesRegex(  # type: ignore[no-untyped-call]
-                AssertionError, expected_error):
+            AssertionError, expected_error
+        ):
             with prefix_swap, base_prefix_swap, real_prefix_manager:
                 with environ_swap:
-                    install_python_dev_dependencies.check_python_env()
+                    (
+                        install_python_dev_dependencies
+                        .check_python_env_is_suitable()
+                    )
 
-    def test_check_python_env_passes_when_on_ci(self) -> None:
+    def test_check_python_env_is_suitable_passes_when_on_ci(self) -> None:
         prefix_swap = self.swap(
             sys, 'prefix', '/home/user/.pyenv/versions/3.7.10')
         base_prefix_swap = self.swap(
             sys, 'base_prefix', '/home/user/.pyenv/versions/3.7.10')
         real_prefix_manager = self.sys_real_prefix_context('')
         environ_swap = self.swap(os, 'environ', {'GITHUB_ACTION': '1'})
         with prefix_swap, base_prefix_swap, real_prefix_manager, environ_swap:
-            install_python_dev_dependencies.check_python_env()
+            install_python_dev_dependencies.check_python_env_is_suitable()
 
     def test_install_installation_tools(self) -> None:
         expected_tools = {
@@ -244,7 +250,8 @@ def mock_compile(*_args: Any) -> bool:
             return False
 
         assert_swap = self.swap_with_checks(
-            install_python_dev_dependencies, 'check_python_env', mock_func)
+            install_python_dev_dependencies, 'check_python_env_is_suitable',
+            mock_func)
         install_tools_swap = self.swap_with_checks(
             install_python_dev_dependencies,
             'install_installation_tools', mock_func)
@@ -267,7 +274,8 @@ def mock_compile(*_args: Any) -> bool:
             return False
 
         assert_swap = self.swap_with_checks(
-            install_python_dev_dependencies, 'check_python_env', mock_func)
+            install_python_dev_dependencies, 'check_python_env_is_suitable',
+            mock_func)
         install_tools_swap = self.swap_with_checks(
             install_python_dev_dependencies,
             'install_installation_tools', mock_func)
@@ -291,7 +299,8 @@ def mock_compile(*_args: Any) -> bool:
             return True
 
         assert_swap = self.swap_with_checks(
-            install_python_dev_dependencies, 'check_python_env', mock_func)
+            install_python_dev_dependencies, 'check_python_env_is_suitable',
+            mock_func)
         install_tools_swap = self.swap_with_checks(
             install_python_dev_dependencies,
             'install_installation_tools', mock_func)
@@ -314,7 +323,8 @@ def mock_compile(*_args: Any) -> bool:
             return True
 
         assert_swap = self.swap_with_checks(
-            install_python_dev_dependencies, 'check_python_env', mock_func)
+            install_python_dev_dependencies, 'check_python_env_is_suitable',
+            mock_func)
         install_tools_swap = self.swap_with_checks(
             install_python_dev_dependencies,
             'install_installation_tools', mock_func)