Skip to content

gh-119786: improve internal docs on co_linetable #123198

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

Merged
iritkatriel merged 9 commits into from
Nov 30, 2024
Merged

gh-119786: improve internal docs on co_linetable #123198

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9ae4eb2
improve internal docs on `co_linetable`
picnixz Aug 21, 2024
3db4e67
improve docs
picnixz Aug 21, 2024
4028163
address review
picnixz Aug 21, 2024
6632fa9
add missing imports
picnixz Aug 21, 2024
588e81c
simplify
picnixz Aug 22, 2024
8e1c669
Merge branch 'main' into improve-internal-docs-on-co-linetable
picnixz Nov 15, 2024
2fef85f
Merge branch 'main' into doc/internal/co-linetable-119786
picnixz Nov 29, 2024
0ce4c26
update docs
picnixz Nov 29, 2024
910fd7f
flatten sections
picnixz Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
simplify
  • Loading branch information
@picnixz
picnixz committed Aug 22, 2024
commit 588e81cdd90656d313a6a24093346c1460041a88
44 changes: 0 additions & 44 deletions InternalDocs/locations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,47 +103,3 @@ start column divided by 8 (and rounded down).

* Start column: `(code*8) + ((second_byte>>4)&7)`
* End column: `start_column + (second_byte&15)`

## Artificial constructions

When constructing artificial `co_linetable` values, only non-None values should
be specified. For instance:

```py
import dis

def foo():
pass

co_firstlineno = 42
foo.__code__ = foo.__code__.replace(
co_firstlineno=co_firstlineno,
co_linetable=bytes([
# RESUME
(1 << 7) | (13 << 3) | (1 - 1),
# sentinel # no column info # number of units - 1
*encode_varint(svarint_to_varint(2)), # relative start line delta
# RETURN_CONST (None)
(1 << 7) | (14 << 3) | (1 - 1),
# sentinel # has column info # number of units - 1
*encode_varint(svarint_to_varint(5)), # relative start line delta
*encode_varint(12), # end line delta
*encode_varint(3), # start column (starts from 1)
*encode_varint(8), # end column (starts from 1)
])
)

instructions = list(dis.get_instructions(foo))
assert len(instructions) == 2

assert instructions[0].opname == 'RESUME'
assert instructions[1].opname == 'RETURN_CONST'

ip0, ip1 = instructions[0].positions, instructions[1].positions
assert ip0 == (co_firstlineno + 2, co_firstlineno + 2, None, None)
assert ip1 == (ip0.lineno + 5, ip1.lineno + 12, (3 - 1), (8 - 1))
```

Note that the indexation of the start and end column values are assumed to
start from 1 and are absolute but that `dis.Positions` is using 0-based values
for the column start and end offsets, when available.