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.

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

Profile 'builtins' parameter documentation missing #84386

Open
bharel mannequin opened this issue Apr 6, 2020 · 2 comments
Open

Profile 'builtins' parameter documentation missing #84386

bharel mannequin opened this issue Apr 6, 2020 · 2 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir stdlib Python modules in the Lib dir

Comments

@bharel
Copy link
Mannequin

bharel mannequin commented Apr 6, 2020

BPO 40205
Nosy @terryjreedy, @bharel

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 2020-04-06.14:43:33.212>
labels = ['3.8', '3.7', 'library', '3.9', 'docs']
title = "Profile 'builtins' parameter documentation missing"
updated_at = <Date 2020-04-11.01:16:06.060>
user = 'https://github.com/bharel'

bugs.python.org fields:

activity = <Date 2020-04-11.01:16:06.060>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Library (Lib)']
creation = <Date 2020-04-06.14:43:33.212>
creator = 'bar.harel'
dependencies = []
files = []
hgrepos = []
issue_num = 40205
keywords = []
message_count = 2.0
messages = ['365859', '366173']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'docs@python', 'bar.harel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40205'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

@bharel
Copy link
Mannequin Author

bharel mannequin commented Apr 6, 2020

Profile and cProfile's documentation does not say anything about the builtins parameter.
Also, it exists only on cProfile, which means Profile is not a drop-in replacement.
Lastly, enable() method, that exists on cProfile, also accepts params, and are undocumented.

@bharel bharel mannequin added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Apr 6, 2020
@bharel bharel mannequin assigned docspython Apr 6, 2020
@bharel bharel mannequin added docs Documentation in the Doc dir stdlib Python modules in the Lib dir 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Apr 6, 2020
@bharel bharel mannequin assigned docspython Apr 6, 2020
@bharel bharel mannequin added the docs Documentation in the Doc dir label Apr 6, 2020
@terryjreedy
Copy link
Member

I verified the statements and notice that profile.Profile has many methods not in cProfile.Profile. Neither is a complete replacement for the other.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir stdlib Python modules in the Lib dir
Projects
None yet
Development

No branches or pull requests

1 participant