logger.warn method is used in "Logging HOWTO" documentation though logger.warn method is deprecated in Python 3.7

[yuji38kwmt]

BPO	35781
Nosy	@vsajip, @tirkarthi, @yuji38kwmt
PRs	bpo-35781: Changed references to deprecated 'warn' method in logging documentation in favour of 'warning' #11654 [3.7] bpo-35781: Changed references to deprecated 'warn' method in logging documentation in favour of 'warning' (GH-11654) #11657

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-01-23.07:44:17.139>
created_at = <Date 2019-01-19.04:50:52.260>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = '`logger.warn` method is used in "Logging HOWTO" documentation though `logger.warn` method is deprecated in Python 3.7'
updated_at = <Date 2019-01-23.07:44:17.138>
user = 'https://bugs.python.org/yuji38kwmt'

bugs.python.org fields:

activity = <Date 2019-01-23.07:44:17.138>
actor = 'vinay.sajip'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-01-23.07:44:17.139>
closer = 'vinay.sajip'
components = ['Documentation']
creation = <Date 2019-01-19.04:50:52.260>
creator = 'yuji38kwmt'
dependencies = []
files = []
hgrepos = []
issue_num = 35781
keywords = ['patch', 'patch', 'patch']
message_count = 5.0
messages = ['334030', '334031', '334119', '334252', '334253']
nosy_count = 5.0
nosy_names = ['vinay.sajip', 'docs@python', 'xtreak', 'yuji38kwmt', 'Yuuji KAWAMATSU']
pr_nums = ['11654', '11657']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35781'
versions = ['Python 3.7', 'Python 3.8']

[yuji38kwmt]

### Target Documentation

https://docs.python.org/3/howto/logging.html#configuring-logging

### Actual Sample Code

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

### Expected Sample Code

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

### Reference

There is an obsolete method warn which is functionally identical to warning. As warn is deprecated, please do not use it - use warning instead.

https://docs.python.org/3.7/library/logging.html#logging.Logger.warning

[tirkarthi]

Thanks for the report. Would you like to propose a PR for this?

Cases of using warn method in documentation examples :

• https://github.com/python/cpython/blob/master/Doc/howto/logging.rst
• https://github.com/python/cpython/blob/master/Doc/howto/logging-cookbook.rst

Doc/howto/logging.rst
613: logger.warn('warn message')
643: logger.warn('warn message')

Doc/howto/logging-cookbook.rst
189: logger.warn('warn message')
298: logger.warn('warn message')

[yuji38kwmt]

Thank you!
I will create PR.

[vsajip]

New changeset cda73a5 by Vinay Sajip (yuji38kwmt) in branch 'master':
bpo-35781: Changed references to deprecated 'warn' method in logging documentation in favour of 'warning' (GH-11654)
cda73a5

[vsajip]

New changeset 3be19c0 by Vinay Sajip (Miss Islington (bot)) in branch '3.7':
bpo-35781: Changed references to deprecated 'warn' method in logging documentation in favour of 'warning' (GH-11654) (GH-11657)
3be19c0