Style by pre-commit run

Note: the changes were selected manually since there were many that
break the style that we want :(

Author: humitos

readthedocs/doc_builder/environments.py

@@ -2,42 +2,45 @@
 
 """Documentation Builder Environments."""
 
-from __future__ import absolute_import
-from builtins import str
-from builtins import object
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals)
+
+import logging
 import os
 import re
-import sys
-import logging
+import socket
 import subprocess
+import sys
 import traceback
-import socket
 from datetime import datetime
 
+import six
+from builtins import object, str
 from django.conf import settings
 from django.utils.translation import ugettext_lazy as _
 from docker import APIClient
-from docker.errors import APIError as DockerAPIError, DockerException
+from docker.errors import APIError as DockerAPIError
+from docker.errors import DockerException
+from requests.exceptions import ConnectionError
 from slumber.exceptions import HttpClientError
 
 from readthedocs.builds.constants import BUILD_STATE_FINISHED
 from readthedocs.builds.models import BuildCommandResultMixin
 from readthedocs.core.utils import slugify
 from readthedocs.projects.constants import LOG_TEMPLATE
 from readthedocs.restapi.client import api as api_v2
-from requests.exceptions import ConnectionError
 
-from .exceptions import (BuildEnvironmentException, BuildEnvironmentError,
-                         BuildEnvironmentWarning, BuildEnvironmentCreationFailed, VersionLockedError, ProjectBuildsSkippedError, YAMLParseError, BuildTimeoutError)
-from .constants import (DOCKER_SOCKET, DOCKER_VERSION, DOCKER_IMAGE,
-                        DOCKER_LIMITS, DOCKER_TIMEOUT_EXIT_CODE,
-                        DOCKER_OOM_EXIT_CODE, SPHINX_TEMPLATE_DIR,
-                        MKDOCS_TEMPLATE_DIR, DOCKER_HOSTNAME_MAX_LEN)
-import six
+from .constants import (
+    DOCKER_HOSTNAME_MAX_LEN, DOCKER_IMAGE, DOCKER_LIMITS, DOCKER_OOM_EXIT_CODE,
+    DOCKER_SOCKET, DOCKER_TIMEOUT_EXIT_CODE, DOCKER_VERSION,
+    MKDOCS_TEMPLATE_DIR, SPHINX_TEMPLATE_DIR)
+from .exceptions import (
+    BuildEnvironmentCreationFailed, BuildEnvironmentError,
+    BuildEnvironmentException, BuildEnvironmentWarning, BuildTimeoutError,
+    ProjectBuildsSkippedError, VersionLockedError, YAMLParseError)
 
 log = logging.getLogger(__name__)
 
-
 __all__ = (
     'api_v2',
     'BuildCommand',
@@ -220,8 +223,12 @@ def run(self):
         :type cmd_input: str
         :param combine_output: combine STDERR into STDOUT
         """
-        log.info("Running in container %s: '%s' [%s]",
-                 self.build_env.container_id, self.get_command(), self.cwd)
+        log.info(
+            "Running in container %s: '%s' [%s]",
+            self.build_env.container_id,
+            self.get_command(),
+            self.cwd,
+        )
 
         self.start_time = datetime.utcnow()
         client = self.build_env.get_client()
@@ -230,7 +237,7 @@ def run(self):
                 container=self.build_env.container_id,
                 cmd=self.get_wrapped_command(),
                 stdout=True,
-                stderr=True
+                stderr=True,
             )
 
             output = client.exec_start(exec_id=exec_cmd['Id'], stream=False)
@@ -439,10 +446,13 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, tb):
         ret = self.handle_exception(exc_type, exc_value, tb)
         self.update_build(BUILD_STATE_FINISHED)
-        log.info(LOG_TEMPLATE
-                 .format(project=self.project.slug,
-                         version=self.version.slug,
-                         msg='Build finished'))
+        log.info(
+            LOG_TEMPLATE.format(
+                project=self.project.slug,
+                version=self.version.slug,
+                msg='Build finished',
+            )
+        )
         return ret
 
     def handle_exception(self, exc_type, exc_value, _):
@@ -479,7 +489,8 @@ def handle_exception(self, exc_type, exc_value, _):
                         'project': self.project.slug,
                         'version': self.version.slug,
                     },
-                })
+                },
+            )
             self.failure = exc_value
             return True
 
@@ -488,11 +499,13 @@ def record_command(self, command):
 
     def _log_warning(self, msg):
         # :'(
-        log.warning(LOG_TEMPLATE.format(
-            project=self.project.slug,
-            version=self.version.slug,
-            msg=msg,
-        ))
+        log.warning(
+            LOG_TEMPLATE.format(
+                project=self.project.slug,
+                version=self.version.slug,
+                msg=msg,
+            )
+        )
 
     def run(self, *cmd, **kwargs):
         kwargs.update({
@@ -550,15 +563,18 @@ def update_build(self, state=None):
 
             # TODO drop exit_code and provide a more meaningful UX for error
             # reporting
-            if self.failure and isinstance(self.failure,
-                                           BuildEnvironmentException):
+            if self.failure and isinstance(
+                    self.failure,
+                    BuildEnvironmentException,
+            ):
                 self.build['exit_code'] = self.failure.status_code
             elif self.commands:
-                self.build['exit_code'] = max([cmd.exit_code
-                                               for cmd in self.commands])
+                self.build['exit_code'] = max([
+                    cmd.exit_code for cmd in self.commands
+                ])
 
-        self.build['setup'] = self.build['setup_error'] = ""
-        self.build['output'] = self.build['error'] = ""
+        self.build['setup'] = self.build['setup_error'] = ''
+        self.build['output'] = self.build['error'] = ''
 
         if self.start_time:
             build_length = (datetime.utcnow() - self.start_time)
@@ -567,9 +583,13 @@ def update_build(self, state=None):
         if self.failure is not None:
             # Surface a generic error if the class is not a
             # BuildEnvironmentError
-            if not isinstance(self.failure,
-                              (BuildEnvironmentException,
-                               BuildEnvironmentWarning)):
+            if not isinstance(
+                    self.failure,
+                (
+                    BuildEnvironmentException,
+                    BuildEnvironmentWarning,
+                ),
+            ):
                 log.error(
                     'Build failed with unhandled exception: %s',
                     str(self.failure),
@@ -585,7 +605,7 @@ def update_build(self, state=None):
                 self.failure = BuildEnvironmentError(
                     BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(
                         build_id=self.build['id'],
-                    )
+                    ),
                 )
             self.build['error'] = str(self.failure)
 
@@ -608,11 +628,11 @@ def update_build(self, state=None):
                 api_v2.build(self.build['id']).put(self.build)
             except HttpClientError as e:
                 log.exception(
-                    "Unable to update build: id=%d",
+                    'Unable to update build: id=%d',
                     self.build['id'],
                 )
             except Exception:
-                log.exception("Unknown build exception")
+                log.exception('Unknown build exception')
 
 
 class LocalBuildEnvironment(BuildEnvironment):
@@ -653,7 +673,7 @@ def __init__(self, *args, **kwargs):
                 build=self.build.get('id'),
                 project_id=self.project.pk,
                 project_name=self.project.slug,
-            )[:DOCKER_HOSTNAME_MAX_LEN]
+            )[:DOCKER_HOSTNAME_MAX_LEN],
         )
         if self.config and self.config.build_image:
             self.container_image = self.config.build_image
@@ -675,18 +695,25 @@ def __enter__(self):
             if state is not None:
                 if state.get('Running') is True:
                     exc = BuildEnvironmentError(
-                        _('A build environment is currently '
-                          'running for this version'))
+                        _(
+                            'A build environment is currently '
+                            'running for this version',
+                        ),
+                    )
                     self.failure = exc
                     self.build['state'] = BUILD_STATE_FINISHED
                     raise exc
                 else:
-                    log.warning(LOG_TEMPLATE
-                                .format(
-                                    project=self.project.slug,
-                                    version=self.version.slug,
-                                    msg=("Removing stale container {0}"
-                                         .format(self.container_id))))
+                    log.warning(
+                        LOG_TEMPLATE.format(
+                            project=self.project.slug,
+                            version=self.version.slug,
+                            msg=(
+                                'Removing stale container {0}'
+                                .format(self.container_id)
+                            ),
+                        )
+                    )
                     client = self.get_client()
                     client.remove_container(self.container_id)
         except (DockerAPIError, ConnectionError):
@@ -731,8 +758,7 @@ def __exit__(self, exc_type, exc_value, tb):
             # request. These errors should not surface to the user.
             except (DockerAPIError, ConnectionError):
                 log.exception(
-                    LOG_TEMPLATE
-                    .format(
+                    LOG_TEMPLATE.format(
                         project=self.project.slug,
                         version=self.version.slug,
                         msg="Couldn't remove container",
@@ -772,7 +798,7 @@ def get_client(self):
             raise BuildEnvironmentError(
                 BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(
                     build_id=self.build['id'],
-                )
+                ),
             )
 
     def get_container_host_config(self):
@@ -851,14 +877,18 @@ def update_build_from_container_state(self):
         if state is not None and state.get('Running') is False:
             if state.get('ExitCode') == DOCKER_TIMEOUT_EXIT_CODE:
                 self.failure = BuildEnvironmentError(
-                    _('Build exited due to time out'))
+                    _('Build exited due to time out'),
+                )
             elif state.get('OOMKilled', False):
                 self.failure = BuildEnvironmentError(
-                    _('Build exited due to excessive memory consumption'))
+                    _('Build exited due to excessive memory consumption'),
+                )
             elif state.get('Error'):
-                self.failure = BuildEnvironmentError(
-                    (_('Build exited due to unknown error: {0}')
-                     .format(state.get('Error'))))
+                self.failure = BuildEnvironmentError((
+                    _('Build exited due to unknown error: {0}')
+                    .format(state.get('Error'))
+                ),
+                )
 
     def create_container(self):
         """Create docker container."""
@@ -870,9 +900,12 @@ def create_container(self):
             )
             self.container = client.create_container(
                 image=self.container_image,
-                command=('/bin/sh -c "sleep {time}; exit {exit}"'
-                         .format(time=self.container_time_limit,
-                                 exit=DOCKER_TIMEOUT_EXIT_CODE)),
+                command=(
+                    '/bin/sh -c "sleep {time}; exit {exit}"'.format(
+                        time=self.container_time_limit,
+                        exit=DOCKER_TIMEOUT_EXIT_CODE,
+                    )
+                ),
                 name=self.container_id,
                 hostname=self.container_id,
                 host_config=self.get_container_host_config(),
@@ -897,12 +930,11 @@ def create_container(self):
             raise BuildEnvironmentError(
                 BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(
                     build_id=self.build['id'],
-                )
+                ),
             )
         except DockerAPIError as e:
             log.exception(
-                LOG_TEMPLATE
-                .format(
+                LOG_TEMPLATE.format(
                     project=self.project.slug,
                     version=self.version.slug,
                     msg=e.explanation,

readthedocs/doc_builder/exceptions.py

@@ -1,5 +1,8 @@
+# -*- coding: utf-8 -*-
 """Exceptions raised when building documentation."""
 
+from __future__ import division, print_function, unicode_literals
+
 from django.utils.translation import ugettext_noop
 
 
@@ -19,30 +22,24 @@ def get_default_message(self):
 class BuildEnvironmentError(BuildEnvironmentException):
 
     GENERIC_WITH_BUILD_ID = ugettext_noop(
-        "There was a problem with Read the Docs while building your documentation. "
-        "Please report this to us with your build id ({build_id})."
+        'There was a problem with Read the Docs while building your documentation. '
+        'Please report this to us with your build id ({build_id}).',
     )
 
 
 class BuildEnvironmentCreationFailed(BuildEnvironmentError):
 
-    message = ugettext_noop(
-        "Build environment creation failed"
-    )
+    message = ugettext_noop('Build environment creation failed')
 
 
 class VersionLockedError(BuildEnvironmentError):
 
-    message = ugettext_noop(
-        'Version locked, retrying in 5 minutes.',
-    )
+    message = ugettext_noop('Version locked, retrying in 5 minutes.')
 
 
 class ProjectBuildsSkippedError(BuildEnvironmentError):
 
-    message = ugettext_noop(
-        'Builds for this project are temporarily disabled',
-    )
+    message = ugettext_noop('Builds for this project are temporarily disabled')
 
 
 class YAMLParseError(BuildEnvironmentError):
@@ -54,9 +51,7 @@ class YAMLParseError(BuildEnvironmentError):
 
 class BuildTimeoutError(BuildEnvironmentError):
 
-    message = ugettext_noop(
-        'Build exited due to time out',
-    )
+    message = ugettext_noop('Build exited due to time out')
 
 
 class BuildEnvironmentWarning(BuildEnvironmentException):