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
+61 −26
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
flatten sections
  • Loading branch information
@picnixz
picnixz committed Nov 29, 2024
commit 910fd7f2ad0d3bafeb3b26f187347b9871cc4836
10 changes: 5 additions & 5 deletions InternalDocs/code_objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,11 @@ The first byte has the following format:

The codes are enumerated in the `_PyCodeLocationInfoKind` enum.

#### Variable-length integer encodings
### Variable-length integer encodings

Integers are often encoded using a variable length integer encoding

##### Unsigned integers (`varint`)
#### Unsigned integers (`varint`)

Unsigned integers are encoded in 6-bit chunks, least significant first.
Each chunk but the last has bit 6 set.
Expand Down Expand Up @@ -128,7 +128,7 @@ def decode_varint(chunks):
return ret
```

##### Signed integers (`svarint`)
#### Signed integers (`svarint`)

Signed integers are encoded by converting them to unsigned integers, using the following function:

Expand All @@ -147,7 +147,7 @@ def varint_to_svarint(uval):
return -(uval >> 1) if uval & 1 else (uval >> 1)
```

#### Location entries
### Location entries

The meaning of the codes and the following bytes are as follows:

Expand All @@ -164,7 +164,7 @@ The Δ means the value is encoded as a delta from another value:
* Start line: Delta from the previous start line, or `co_firstlineno` for the first entry.
* End line: Delta from the start line.

##### The short forms
### The short forms

Codes 0-9 are the short forms. The short form consists of two bytes,
the second byte holding additional column information. The code is the
Expand Down