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

Incorrect format specified for the "style" key in the configuration file format formatter example #90326

Closed
bokunogf mannequin opened this issue Dec 23, 2021 · 4 comments
Closed

Incorrect format specified for the "style" key in the configuration file format formatter example #90326

bokunogf mannequin opened this issue Dec 23, 2021 · 4 comments
Labels
3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir easy

Comments

@bokunogf
Copy link
Mannequin

bokunogf mannequin commented Dec 23, 2021

BPO 46168
Nosy @devdanzin, @ianw, @slateny

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-23.20:58:06.416>
labels = ['easy', '3.11', '3.10', 'docs']
title = 'Incorrect format specified for the "style" key in the configuration file format formatter example'
updated_at = <Date 2022-04-05.09:41:04.042>
user = 'https://bugs.python.org/bokunogf'

bugs.python.org fields:

activity = <Date 2022-04-05.09:41:04.042>
actor = 'slateny'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-12-23.20:58:06.416>
creator = 'bokunogf'
dependencies = []
files = []
hgrepos = []
issue_num = 46168
keywords = ['easy']
message_count = 4.0
messages = ['409108', '409111', '409238', '416765']
nosy_count = 6.0
nosy_names = ['ajaksu2', 'docs@python', 'iwienand', 'bokunogf', 'samriddhi.bhardwaj', 'slateny']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue46168'
versions = ['Python 3.10', 'Python 3.11']
@bokunogf
Copy link
Mannequin Author

bokunogf mannequin commented Dec 23, 2021

Documentation link: https://docs.python.org/3/library/logging.config.html#configuration-file-format

It seems that the example for the "formatter_form01" formatter section specifies following for the style(please note the single-quotes around the value).
style='%'

This seems to raise a ValueError with the message "Style must be one of..." when parsing the configuration file. Removing the single quotes seems to fix the issue:
style=%

@bokunogf bokunogf mannequin added the 3.8 only security fixes label Dec 23, 2021
@bokunogf bokunogf mannequin assigned docspython Dec 23, 2021
@bokunogf bokunogf mannequin added docs Documentation in the Doc dir 3.8 only security fixes labels Dec 23, 2021
@bokunogf bokunogf mannequin assigned docspython Dec 23, 2021
@bokunogf bokunogf mannequin added the docs Documentation in the Doc dir label Dec 23, 2021
@devdanzin
Copy link
Mannequin

devdanzin mannequin commented Dec 23, 2021

This example was added in bpo-43047. It only seems to affect 3.10+ docs. Ian, is this something you'd like to tackle?

@devdanzin devdanzin mannequin added easy 3.10 only security fixes 3.11 only security fixes and removed 3.8 only security fixes labels Dec 23, 2021
@samriddhibhardwaj
Copy link
Mannequin

samriddhibhardwaj mannequin commented Dec 27, 2021

I would like to help with this issue. It should take me less than 5 days.

@slateny
Copy link
Contributor

slateny commented Apr 5, 2022

Samriddhi, are you still working on this?

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@slateny slateny mentioned this issue Apr 14, 2022
Merged
vsajip pushed a commit that referenced this issue Apr 14, 2022
@slateny
gh-90326: Remove quotes for logging config (GH-91516)
45e8c9d
@vsajip vsajip closed this as completed Apr 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vsajip @slateny