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
address review
  • Loading branch information
@picnixz
picnixz committed Aug 21, 2024
commit 40281635f702e33628bf71e458664be6ac0fe24c
36 changes: 17 additions & 19 deletions InternalDocs/locations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ zero or more bytes with most significant bit unset.

Each entry contains the following information:

* The number of code units covered by this entry (length).
* The number of code units covered by this entry (length)
* The start line
* The end line
* The start column
Expand Down Expand Up @@ -40,7 +40,7 @@ For example:
The following helper can be used to convert an integer into a `varint`:

```py
def write_varint(s):
def encode_varint(s):
ret = []
while s >= 64:
ret.append(((s & 0x3F) | 0x40) & 0x3F)
Expand All @@ -52,7 +52,7 @@ def write_varint(s):
To convert a `varint` into an unsigned integer:

```py
def read_varint(chunks):
def decode_varint(chunks):
ret = 0
for chunk in reversed(chunks):
ret = (ret << 6) | chunk
Expand All @@ -64,19 +64,17 @@ def read_varint(chunks):
Signed integers are encoded by converting them to unsigned integers, using the following function:

```py
def write_svarint(s):
def svarint_to_varint(s):
if s < 0:
uval = ((-s) << 1) | 1
return ((-s) << 1) | 1
else:
uval = s << 1
return write_varint(uval)
return s << 1
```

To convert a `svarint` into a signed integer:
To convert a varint into a signed integer:

```py
def read_svarint(s):
uval = read_varint(s)
def varint_to_svarint(uval):
return -(uval >> 1) if uval & 1 else (uval >> 1)
Comment thread
picnixz marked this conversation as resolved.
Outdated
```

Expand Down Expand Up @@ -120,16 +118,16 @@ 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
*write_svarint(2), # start line delta
(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
*write_svarint(5), # relative start line delta
*write_varint(12), # end line delta
*write_varint(3), # start column (starts from 1)
*write_varint(8), # end column (starts from 1)
(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)
])
)

Expand Down