Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor to replace old logging to avoid mangling #3677

Merged
merged 1 commit into from
May 24, 2018
Merged

Refactor to replace old logging to avoid mangling #3677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 20 additions & 15 deletions readthedocs/core/symlink.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
fabric -> rtd-builds/fabric/en/latest/ # single version
"""

from __future__ import absolute_import
from __future__ import absolute_import, unicode_literals
from builtins import object
import os
import shutil
Expand Down Expand Up @@ -85,22 +85,16 @@ def __init__(self, project):
)
self.sanity_check()

def _log(self, msg, level='info'):
logger = getattr(log, level)
logger(constants.LOG_TEMPLATE
.format(project=self.project.slug,
version='',
msg=msg)
)

def sanity_check(self):
"""
Make sure the project_root is the proper structure before continuing.

This will leave it in the proper state for the single_project setting.
"""
if os.path.islink(self.project_root) and not self.project.single_version:
self._log("Removing single version symlink")
log.info(constants.LOG_TEMPLATE.format(
project=self.project.slug, version='',
msg="Removing single version symlink"))
os.unlink(self.project_root)
safe_makedirs(self.project_root)
elif (self.project.single_version and
Expand Down Expand Up @@ -152,7 +146,9 @@ def symlink_cnames(self, domain=None):
else:
domains = Domain.objects.filter(project=self.project)
for dom in domains:
self._log(u"Symlinking CNAME: {0} -> {1}".format(dom.domain, self.project.slug))
log_msg = 'Symlinking CNAME: {0} -> {1}'.format(dom.domain, self.project.slug)
log.info(constants.LOG_TEMPLATE.format(project=self.project.slug,
version='', msg=log_msg))

# CNAME to doc root
symlink = os.path.join(self.CNAME_ROOT, dom.domain)
Expand All @@ -164,7 +160,9 @@ def symlink_cnames(self, domain=None):

def remove_symlink_cname(self, domain):
"""Remove CNAME symlink."""
self._log(u"Removing symlink for CNAME {0}".format(domain.domain))
log_msg = "Removing symlink for CNAME {0}".format(domain.domain)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use single quotes on all new code to keeping consistency.

log.info(constants.LOG_TEMPLATE.format(project=self.project.slug,
version='', msg=log_msg))
symlink = os.path.join(self.CNAME_ROOT, domain.domain)
os.unlink(symlink)

Expand All @@ -190,7 +188,9 @@ def symlink_subprojects(self):
from_to[rel.alias] = rel.child.slug
subprojects.add(rel.alias)
for from_slug, to_slug in list(from_to.items()):
self._log(u"Symlinking subproject: {0} -> {1}".format(from_slug, to_slug))
log_msg = "Symlinking subproject: {0} -> {1}".format(from_slug, to_slug)
log.info(constants.LOG_TEMPLATE.format(project=self.project.slug,
version='', msg=log_msg))
symlink = os.path.join(self.subproject_root, from_slug)
docs_dir = os.path.join(
self.WEB_ROOT, to_slug
Expand Down Expand Up @@ -232,7 +232,10 @@ def symlink_translations(self):
safe_makedirs(language_dir)

for (language, slug) in list(translations.items()):
self._log(u"Symlinking translation: {0}->{1}".format(language, slug))

log_msg = 'Symlinking translation: {0}->{1}'.format(language, slug)
log.info(constants.LOG_TEMPLATE.format(project=self.project.slug,
version='', msg=log_msg))
symlink = os.path.join(self.project_root, language)
docs_dir = os.path.join(self.WEB_ROOT, slug, language)
run(['ln', '-nsf', docs_dir, symlink])
Expand Down Expand Up @@ -285,7 +288,9 @@ def symlink_versions(self):
if not os.path.exists(version_dir):
safe_makedirs(version_dir)
for version in version_queryset:
self._log(u"Symlinking Version: %s" % version)
log_msg = 'Symlinking Version: {}'.format(version)
log.info(constants.LOG_TEMPLATE.format(project=self.project.slug,
version='', msg=log_msg))
symlink = os.path.join(version_dir, version.slug)
docs_dir = os.path.join(settings.DOCROOT, self.project.slug, 'rtd-builds', version.slug)
run(['ln', '-nsf', docs_dir, symlink])
Expand Down