Discourage logging f-strings due to security considerations

Open
#90,358 13 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation, security

Research direction

Review the Python library documentation related to logging and the linked BPO issue 46200, including its discussion of the security considerations. Identify where guidance about logging f-strings belongs; done means the documentation clearly discourages the practice and explains the relevant concern.

Written by the indexing model from the issue text.

Description

3.10 3.11 3.12 3.13 3.14 3.15 docs stdlib
BPO 46200
Nosy @rhettinger, @gpshead, @vsajip, @ericvsmith, @Tinche, @ariebovenberg

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 = None
created_at = <Date 2021-12-30.07:44:15.228>
labels = ['3.8', '3.9', '3.7', 'docs', 'type-security', '3.10', '3.11', 'library']
title = 'Discourage logging f-strings due to security considerations'
updated_at = <Date 2022-02-19.12:27:19.966>
user = 'https://github.com/ariebovenberg'

bugs.python.org fields:

activity = <Date 2022-02-19.12:27:19.966>
actor = 'ariebovenberg'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2021-12-30.07:44:15.228>
creator = 'ariebovenberg'
dependencies = []
files = []
hgrepos = []
issue_num = 46200
keywords = []
message_count = 13.0
messages = ['409352', '409416', '409418', '409495', '409499', '409505', '412357', '412473', '412474', '412496', '412504', '413519', '413547']
nosy_count = 7.0
nosy_names = ['rhettinger', 'gregory.p.smith', 'vinay.sajip', 'eric.smith', 'docs@python', 'tinchester', 'ariebovenberg']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'security'
url = 'https://bugs.python.org/issue46200'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10', 'Python 3.11']

Dominant language
Python
Stars
77.2k
Forks
36k
Avg merge
1d 9h
Merged PRs (30d)
558

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/cpython

All issues in python/cpython

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.