From 3c0692c19c4a296e087196c03a84d8667fa7a85d Mon Sep 17 00:00:00 2001 From: saadmk11 Date: Fri, 3 May 2019 17:03:07 +0600 Subject: [PATCH] lint fix for readthedocs.doc_builder --- readthedocs/doc_builder/environments.py | 88 ++++++++++--------- .../doc_builder/python_environments.py | 33 +++---- readthedocs/projects/constants.py | 2 +- 3 files changed, 67 insertions(+), 56 deletions(-) diff --git a/readthedocs/doc_builder/environments.py b/readthedocs/doc_builder/environments.py index cda73492dea..d93e43bce01 100644 --- a/readthedocs/doc_builder/environments.py +++ b/readthedocs/doc_builder/environments.py @@ -463,11 +463,12 @@ def run_command_class( if warn_only: log.warning( - LOG_TEMPLATE.format( - project=self.project.slug, - version='latest', - msg=msg, - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': 'latest', + 'msg': msg, + } ) else: raise BuildEnvironmentWarning(msg) @@ -551,11 +552,12 @@ 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_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': 'Build finished', + } ) return ret @@ -586,11 +588,12 @@ def handle_exception(self, exc_type, exc_value, _): self.failure = exc_value log_level_function( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg=exc_value, - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': exc_value, + }, exc_info=True, extra={ 'stack': True, @@ -820,15 +823,16 @@ def __enter__(self): raise exc else: log.warning( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg=( + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': ( 'Removing stale container {}'.format( self.container_id, ) ), - ), + } ) client = self.get_client() client.remove_container(self.container_id) @@ -874,11 +878,12 @@ 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( - project=self.project.slug, - version=self.version.slug, - msg="Couldn't remove container", - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': "Couldn't remove container", + } ) self.container = None except BuildEnvironmentError: @@ -902,11 +907,12 @@ def get_client(self): return self.client except DockerException: log.exception( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg='Could not connect to Docker API', - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': "Could not connect to Docker API", + } ) # We don't raise an error here mentioning Docker, that is a # technical detail that the user can't resolve on their own. @@ -1024,14 +1030,15 @@ def create_container(self): client.start(container=self.container_id) except ConnectionError: log.exception( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg=( + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': ( 'Could not connect to the Docker API, ' 'make sure Docker is running' ), - ), + } ) # We don't raise an error here mentioning Docker, that is a # technical detail that the user can't resolve on their own. @@ -1043,10 +1050,11 @@ def create_container(self): ) except DockerAPIError as e: log.exception( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg=e.explanation, - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': e.explanation, + } ) raise BuildEnvironmentCreationFailed diff --git a/readthedocs/doc_builder/python_environments.py b/readthedocs/doc_builder/python_environments.py index d78d9e361b1..c5a653085a3 100644 --- a/readthedocs/doc_builder/python_environments.py +++ b/readthedocs/doc_builder/python_environments.py @@ -44,11 +44,12 @@ def delete_existing_build_dir(self): ) if os.path.exists(build_dir): log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg='Removing existing build directory', - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': 'Removing existing build directory', + } ) shutil.rmtree(build_dir) @@ -57,11 +58,12 @@ def delete_existing_venv_dir(self): # Handle deleting old venv dir if os.path.exists(venv_dir): log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg='Removing existing venv directory', - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': 'Removing existing venv directory', + } ) shutil.rmtree(venv_dir) @@ -413,11 +415,12 @@ def setup_base(self): if os.path.exists(version_path): # Re-create conda directory each time to keep fresh state log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg='Removing existing conda directory', - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': 'Removing existing conda directory', + } ) shutil.rmtree(version_path) self.build_env.run( diff --git a/readthedocs/projects/constants.py b/readthedocs/projects/constants.py index 26093e84917..a80e22f19e9 100644 --- a/readthedocs/projects/constants.py +++ b/readthedocs/projects/constants.py @@ -287,7 +287,7 @@ ('other', 'Other'), ) -LOG_TEMPLATE = '(Build) [{project}:{version}] {msg}' +LOG_TEMPLATE = '(Build) [%(project)s:%(version)s] %(msg)s' PROJECT_PK_REGEX = r'(?:[-\w]+)' PROJECT_SLUG_REGEX = r'(?:[-\w]+)'