Commit c9a195ec authored by Benjamin Peterson's avatar Benjamin Peterson Committed by GitHub

[2.7] Stop using deprecated logging API in Sphinx suspicious checker (GH-16635)

(cherry picked from commit ee171a26)
Co-authored-by: default avatarPablo Galindo <Pablogsal@gmail.com>
parent 1c7b1419
...@@ -36,13 +36,14 @@ matrix: ...@@ -36,13 +36,14 @@ matrix:
- xvfb - xvfb
- os: linux - os: linux
language: python language: python
python: 2.7 # Build the docs against a stable version of Python so code bugs don't hold up doc-related PRs.
python: 3.6
env: TESTING=docs env: TESTING=docs
before_script: before_script:
- cd Doc - cd Doc
# Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures. # Sphinx is pinned so that new versions that introduce new warnings won't suddenly cause build failures.
# (Updating the version is fine as long as no warnings are raised by doing so.) # (Updating the version is fine as long as no warnings are raised by doing so.)
- python -m pip install sphinx~=1.6.1 - python3 -m pip install sphinx~=2.0.1
script: script:
- make check suspicious html SPHINXOPTS="-q -W -j4" - make check suspicious html SPHINXOPTS="-q -W -j4"
......
...@@ -148,7 +148,7 @@ dist: ...@@ -148,7 +148,7 @@ dist:
cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub cp -pPR build/epub/Python.epub dist/python-$(DISTVERSION)-docs.epub
check: check:
$(PYTHON) tools/rstlint.py -i tools $(PYTHON)2 tools/rstlint.py -i tools
serve: serve:
../Tools/scripts/serve.py build/html ../Tools/scripts/serve.py build/html
......
...@@ -48,6 +48,7 @@ import sys ...@@ -48,6 +48,7 @@ import sys
from docutils import nodes from docutils import nodes
from sphinx.builders import Builder from sphinx.builders import Builder
import sphinx.util
detect_all = re.compile(r''' detect_all = re.compile(r'''
::(?=[^=])| # two :: (but NOT ::=) ::(?=[^=])| # two :: (but NOT ::=)
...@@ -85,6 +86,7 @@ class CheckSuspiciousMarkupBuilder(Builder): ...@@ -85,6 +86,7 @@ class CheckSuspiciousMarkupBuilder(Builder):
Checks for possibly invalid markup that may leak into the output. Checks for possibly invalid markup that may leak into the output.
""" """
name = 'suspicious' name = 'suspicious'
logger = sphinx.util.logging.getLogger("CheckSuspiciousMarkupBuilder")
def init(self): def init(self):
# create output file # create output file
...@@ -116,7 +118,7 @@ class CheckSuspiciousMarkupBuilder(Builder): ...@@ -116,7 +118,7 @@ class CheckSuspiciousMarkupBuilder(Builder):
self.warn('Found %s/%s unused rules:' % self.warn('Found %s/%s unused rules:' %
(len(unused_rules), len(self.rules))) (len(unused_rules), len(self.rules)))
for rule in unused_rules: for rule in unused_rules:
self.info(repr(rule)) self.logger.info(repr(rule))
return return
def check_issue(self, line, lineno, issue): def check_issue(self, line, lineno, issue):
...@@ -146,7 +148,7 @@ class CheckSuspiciousMarkupBuilder(Builder): ...@@ -146,7 +148,7 @@ class CheckSuspiciousMarkupBuilder(Builder):
return False return False
def report_issue(self, text, lineno, issue): def report_issue(self, text, lineno, issue):
if not self.any_issue: self.info() if not self.any_issue: self.logger.info()
self.any_issue = True self.any_issue = True
self.write_log_entry(lineno, issue, text) self.write_log_entry(lineno, issue, text)
if py3: if py3:
...@@ -181,7 +183,7 @@ class CheckSuspiciousMarkupBuilder(Builder): ...@@ -181,7 +183,7 @@ class CheckSuspiciousMarkupBuilder(Builder):
A csv file, with exactly the same format as suspicious.csv A csv file, with exactly the same format as suspicious.csv
Fields: document name (normalized), line number, issue, surrounding text Fields: document name (normalized), line number, issue, surrounding text
""" """
self.info("loading ignore rules... ", nonl=1) self.logger.info("loading ignore rules... ", nonl=1)
self.rules = rules = [] self.rules = rules = []
try: try:
if py3: if py3:
...@@ -206,7 +208,7 @@ class CheckSuspiciousMarkupBuilder(Builder): ...@@ -206,7 +208,7 @@ class CheckSuspiciousMarkupBuilder(Builder):
rule = Rule(docname, lineno, issue, text) rule = Rule(docname, lineno, issue, text)
rules.append(rule) rules.append(rule)
f.close() f.close()
self.info('done, %d rules loaded' % len(self.rules)) self.logger.info('done, %d rules loaded' % len(self.rules))
def get_lineno(node): def get_lineno(node):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment