python / python/cpython

Clean up the dtrace code and documentation for the hook is not using

Open
#125,914 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

interpreter-core type-bug
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Bug report

Bug description:

8 years ago, @ambv add dtrace support in CPython in https://github.com/python/cpython/commit/a785c87d6eacbed81543a8afe3cb098fabb9610a

For now, after check the code, I think the point following below is not used in CPython code

  • function__entry
  • function__return
  • instance__new__start
  • instance__new__done
  • instance__delete__start
  • instance__delete__done
  • line

I think we need to clean up the code and the document in https://docs.python.org/3/howto/instrumentation.html

cc @markshannon

CPython versions tested on:

CPython main branch

Operating systems tested on:

Linux

Linked PRs
  • gh-126246

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.

Research direction

Start by reviewing CPython's DTrace support and the instrumentation HOWTO at docs.python.org/3/howto/instrumentation.html, focusing on the listed hooks. Check linked PR gh-126246 before beginning; completion would mean the unused hooks and their documentation are consistently addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.