From ee8e938fd149e7804447d2e79394454a4812adf3 Mon Sep 17 00:00:00 2001 From: saadmk11 Date: Fri, 3 May 2019 17:31:01 +0600 Subject: [PATCH] lint fix for readthedocs.projects --- readthedocs/projects/constants.py | 2 +- readthedocs/projects/models.py | 18 +++-- readthedocs/projects/tasks.py | 121 ++++++++++++++++-------------- 3 files changed, 78 insertions(+), 63 deletions(-) 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]+)' diff --git a/readthedocs/projects/models.py b/readthedocs/projects/models.py index 02127823c84..db9aed3890a 100644 --- a/readthedocs/projects/models.py +++ b/readthedocs/projects/models.py @@ -924,18 +924,22 @@ def update_stable_version(self): ) if identifier_updated and current_stable.machine: log.info( - 'Update stable version: {project}:{version}'.format( - project=self.slug, - version=new_stable.identifier, - ), + 'Update stable version: %(project)s:%(version)s', + { + 'project': self.slug, + 'version': new_stable.identifier, + } ) current_stable.identifier = new_stable.identifier current_stable.save() return new_stable else: log.info( - 'Creating new stable version: {project}:{version}' - .format(project=self.slug, version=new_stable.identifier), + 'Creating new stable version: %(project)s:%(version)s', + { + 'project': self.slug, + 'version': new_stable.identifier, + } ) current_stable = self.versions.create_stable( type=new_stable.type, @@ -1161,7 +1165,7 @@ class HTMLFile(ImportedFile): This tracks only the HTML files for indexing to search. """ - class Meta(object): + class Meta: proxy = True objects = HTMLFileManager() diff --git a/readthedocs/projects/tasks.py b/readthedocs/projects/tasks.py index e31f521a1cc..a240770f3fb 100644 --- a/readthedocs/projects/tasks.py +++ b/readthedocs/projects/tasks.py @@ -144,11 +144,12 @@ def sync_repo(self): identifier=self.version.identifier, ) log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg=msg, - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': msg, + } ) version_repo = self.get_vcs_repo() version_repo.update() @@ -484,11 +485,12 @@ def run_setup(self, record=True): self.setup_env.failure, ) log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg=msg, - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': msg, + } ) # Send notification to users only if the build didn't fail because @@ -545,11 +547,12 @@ def run_build(self, docker, record): python_env_cls = Virtualenv if self.config.conda is not None: log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg='Using conda', - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': 'Using conda', + } ) python_env_cls = Conda self.python_env = python_env_cls( @@ -624,11 +627,12 @@ def setup_vcs(self): self.setup_env.update_build(state=BUILD_STATE_CLONING) log.info( - LOG_TEMPLATE.format( - project=self.project.slug, - version=self.version.slug, - msg='Updating docs from VCS', - ), + LOG_TEMPLATE, + { + 'project': self.project.slug, + 'version': self.version.slug, + 'msg': 'Updating docs from VCS', + } ) try: self.sync_repo() @@ -1028,11 +1032,12 @@ def move_files( storage.delete(storage_path) log.debug( - LOG_TEMPLATE.format( - project=version.project.slug, - version=version.slug, - msg='Moving files', - ), + LOG_TEMPLATE, + { + 'project': version.project.slug, + 'version': version.slug, + 'msg': 'Moving files', + } ) if html: @@ -1178,24 +1183,26 @@ def fileify(version_pk, commit): if not commit: log.warning( - LOG_TEMPLATE.format( - project=project.slug, - version=version.slug, - msg=( + LOG_TEMPLATE, + { + 'project': project.slug, + 'version': version.slug, + 'msg': ( 'Search index not being built because no commit information' ), - ), + } ) return path = project.rtd_build_path(version.slug) if path: log.info( - LOG_TEMPLATE.format( - project=version.project.slug, - version=version.slug, - msg='Creating ImportedFiles', - ), + LOG_TEMPLATE, + { + 'project': version.project.slug, + 'version': version.slug, + 'msg': 'Creating ImportedFiles', + } ) try: _manage_imported_files(version, path, commit) @@ -1414,11 +1421,12 @@ def email_notification(version, build, email): :param email: Email recipient address """ log.debug( - LOG_TEMPLATE.format( - project=version.project.slug, - version=version.slug, - msg='sending email to: %s' % email, - ), + LOG_TEMPLATE, + { + 'project': version.project.slug, + 'version': version.slug, + 'msg': 'sending email to: %s' % email, + } ) # We send only what we need from the Django model objects here to avoid @@ -1482,11 +1490,12 @@ def webhook_notification(version, build, hook_url): }, }) log.debug( - LOG_TEMPLATE.format( - project=project.slug, - version='', - msg='sending notification to: %s' % hook_url, - ), + LOG_TEMPLATE, + { + 'project': project.slug, + 'version': '', + 'msg': 'sending notification to: %s' % hook_url, + } ) try: requests.post(hook_url, data=data) @@ -1515,11 +1524,12 @@ def update_static_metadata(project_pk, path=None): path = project.static_metadata_path() log.info( - LOG_TEMPLATE.format( - project=project.slug, - version='', - msg='Updating static metadata', - ), + LOG_TEMPLATE, + { + 'project': project.slug, + 'version': '', + 'msg': 'Updating static metadata', + } ) translations = [trans.language for trans in project.translations.all()] languages = set(translations) @@ -1538,11 +1548,12 @@ def update_static_metadata(project_pk, path=None): fh.close() except (AttributeError, IOError) as e: log.debug( - LOG_TEMPLATE.format( - project=project.slug, - version='', - msg='Cannot write to metadata.json: {}'.format(e), - ), + LOG_TEMPLATE, + { + 'project': project.slug, + 'version': '', + 'msg': 'Cannot write to metadata.json: {}'.format(e), + } )