IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Emit warning on logger methods

Browse Source
This commit is contained in:
Takeshi KOMIYA 2016-12-25 01:14:08 +09:00
parent 25a078655b
commit 4ea25a4df3
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sphinx/application.py
View File

@ -35,7 +35,7 @@ from sphinx.errors import SphinxError, ExtensionError, VersionRequirementError,
ConfigError ConfigError
from sphinx.domains import ObjType from sphinx.domains import ObjType
from sphinx.domains.std import GenericObject, Target, StandardDomain from sphinx.domains.std import GenericObject, Target, StandardDomain
from sphinx.deprecation import RemovedInSphinx17Warning from sphinx.deprecation import RemovedInSphinx17Warning, RemovedInSphinx20Warning
from sphinx.environment import BuildEnvironment from sphinx.environment import BuildEnvironment
from sphinx.io import SphinxStandaloneReader from sphinx.io import SphinxStandaloneReader
from sphinx.roles import XRefRole from sphinx.roles import XRefRole
@ -399,6 +399,8 @@ class Sphinx(object):
warnings.warn('colorfunc option of warn() is now deprecated.', warnings.warn('colorfunc option of warn() is now deprecated.',
RemovedInSphinx17Warning) RemovedInSphinx17Warning)
warnings.warn('app.warning() is now deprecated. Use sphinx.util.logging instead.',
RemovedInSphinx20Warning)
logger.warning(message, type=type, subtype=subtype, location=location) logger.warning(message, type=type, subtype=subtype, location=location)
def info(self, message='', nonl=False): def info(self, message='', nonl=False):
@ -408,21 +410,29 @@ class Sphinx(object):
If *nonl* is true, don't emit a newline at the end (which implies that If *nonl* is true, don't emit a newline at the end (which implies that
more info output will follow soon.) more info output will follow soon.)
""" """
warnings.warn('app.info() is now deprecated. Use sphinx.util.logging instead.',
RemovedInSphinx20Warning)
logger.info(message, nonl=nonl) logger.info(message, nonl=nonl)
def verbose(self, message, *args, **kwargs): def verbose(self, message, *args, **kwargs):
# type: (unicode, Any, Any) -> None # type: (unicode, Any, Any) -> None
"""Emit a verbose informational message.""" """Emit a verbose informational message."""
warnings.warn('app.verbose() is now deprecated. Use sphinx.util.logging instead.',
RemovedInSphinx20Warning)
logger.verbose(message, *args, **kwargs) logger.verbose(message, *args, **kwargs)
def debug(self, message, *args, **kwargs): def debug(self, message, *args, **kwargs):
# type: (unicode, Any, Any) -> None # type: (unicode, Any, Any) -> None
"""Emit a debug-level informational message.""" """Emit a debug-level informational message."""
warnings.warn('app.debug() is now deprecated. Use sphinx.util.logging instead.',
RemovedInSphinx20Warning)
logger.debug(message, *args, **kwargs) logger.debug(message, *args, **kwargs)
def debug2(self, message, *args, **kwargs): def debug2(self, message, *args, **kwargs):
# type: (unicode, Any, Any) -> None # type: (unicode, Any, Any) -> None
"""Emit a lowlevel debug-level informational message.""" """Emit a lowlevel debug-level informational message."""
warnings.warn('app.debug2() is now deprecated. Use sphinx.util.logging instead.',
RemovedInSphinx20Warning)
logger.debug2(message, *args, **kwargs) logger.debug2(message, *args, **kwargs)
def _display_chunk(chunk): def _display_chunk(chunk):

4
sphinx/deprecation.py
View File

@ -18,4 +18,8 @@ class RemovedInSphinx17Warning(PendingDeprecationWarning):
pass pass
class RemovedInSphinx20Warning(PendingDeprecationWarning):
pass
RemovedInNextVersionWarning = RemovedInSphinx16Warning RemovedInNextVersionWarning = RemovedInSphinx16Warning