Code object comparison could lead to monitoring issue
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Bug report
Bug description:
Currently we compare code objects with a lot of its features, but not the file it is defined in - that might make some sense because the two code objects are "equivalent" as long as all their features match. However, the two code objects could still be two different ones - for example, if they are two exact same functions defined in two different files (this is a real case for me and it took me a while to figure it out).
The problem is, code objects can be used as keys. When we have "equal but not the same" code objects, it could affect monitoring. We thought we were monitoring one code object while we are actually monitoring another one.
The code was like this:
@cache
def get_code_lineno(code):
...
return {code: [...]}
assert code1 == code2 # two code objects in two different files
for c, linenos in get_code_lineno(code1):
sys.monitoring.set_local_events(tool, c, E.LINE)
for c, linenos in get_code_lineno(code2):
# This does not instrument code2! This instruments code1 because of the cache!
sys.monitoring.set_local_events(tool, c, E.LINE)
Do we consider this an expected behavior? Should we just "live with it" as it's not that common? (Again, this is a real issue I had when I was working on a project).
@markshannon
CPython versions tested on:
3.12, CPython main branch, 3.13, 3.14
Operating systems tested on:
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The report names no source file or test. Start by reproducing the cached lookup with equivalent code objects from different files, then inspect code-object comparison and the sys.monitoring.set_local_events entry point. The intended behavior must be decided before a regression test can verify that monitoring does not target the wrong code object.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100