Add feature flip for always upgrading user defined packages on pip install

readthedocs/doc_builder/python_environments.py

@@ -117,7 +117,13 @@ def install_core_requirements(self):
         """Install basic Read the Docs requirements into the virtualenv."""
         requirements = [
             'Pygments==2.2.0',
-            'setuptools==28.8.0',
+            # Assume semver for setuptools version, support up to next backwards
+            # incompatible release
+            self.project.get_feature_value(
+                Feature.USE_SETUPTOOLS_LATEST,
+                'setuptools<37',
+                'setuptools==28.8.0',
+            ),
             'docutils==0.13.1',
             'mock==1.0.1',
             'pillow==2.6.1',
@@ -129,13 +135,14 @@ def install_core_requirements(self):
         if self.project.documentation_type == 'mkdocs':
             requirements.append('mkdocs==0.15.0')
         else:
-            if self.project.has_feature(Feature.USE_SPHINX_LATEST):
-                # We will assume semver here and only automate up to the next
-                # backward incompatible release: 2.x
-                requirements.append('sphinx<2')
-            else:
-                requirements.append('sphinx==1.5.6')
+            # We will assume semver here and only automate up to the next
+            # backward incompatible release: 2.x
             requirements.extend([
+                self.project.get_feature_value(
+                    Feature.USE_SPHINX_LATEST,
+                    'sphinx<2',
+                    'sphinx==1.5.6',
+                ),
                 'sphinx-rtd-theme<0.3',
                 'readthedocs-sphinx-ext<0.6'
             ])
@@ -145,7 +152,7 @@ def install_core_requirements(self):
             self.venv_bin(filename='pip'),
             'install',
             '--use-wheel',
-            '-U',
+            '--upgrade',
             '--cache-dir',
             self.project.pip_cache_path,
         ]
@@ -175,14 +182,21 @@ def install_user_requirements(self):
                         break
 
         if requirements_file_path:
-            self.build_env.run(
+            args = [
                 'python',
                 self.venv_bin(filename='pip'),
                 'install',
+            ]
+            if self.project.has_feature(Feature.PIP_ALWAYS_UPGRADE):
+                args += ['--upgrade']
+            args += [
                 '--exists-action=w',
                 '--cache-dir',
                 self.project.pip_cache_path,
                 '-r{0}'.format(requirements_file_path),
+            ]
+            self.build_env.run(
+                *args,
                 cwd=self.checkout_path,
                 bin_path=self.venv_bin()
             )

readthedocs/projects/models.py

@@ -835,6 +835,14 @@ def has_feature(self, feature_id):
         """
         return self.features.filter(feature_id=feature_id).exists()
 
+    def get_feature_value(self, feature, positive, negative):
+        """Look up project feature, return corresponding value
+
+        If a project has a feature, return ``positive``, otherwise return
+        ``negative``
+        """
+        return positive if self.has_feature(feature) else negative
+
 
 class APIProject(Project):
 
@@ -994,9 +1002,13 @@ def add_features(sender, **kwargs):
     # Feature constants - this is not a exhaustive list of features, features
     # may be added by other packages
     USE_SPHINX_LATEST = 'use_sphinx_latest'
+    USE_SETUPTOOLS_LATEST = 'use_setuptools_latest'
+    PIP_ALWAYS_UPGRADE = 'pip_always_upgrade'
 
     FEATURES = (
         (USE_SPHINX_LATEST, _('Use latest version of Sphinx')),
+        (USE_SETUPTOOLS_LATEST, _('Use latest version of setuptools')),
+        (PIP_ALWAYS_UPGRADE, _('Always run pip install --upgrade')),
     )
 
     projects = models.ManyToManyField(