Make TextDocument.lines be a Sequence[str] rather than List[str]#553
Merged
Conversation
2a9d0aa to
e54c3da
Compare
The `PositionCodec` does not need a mutable sequence as it only does read-only operations. Additionally, `TextDocument.lines` can now return an immutable list (using tuple here for simplicity), which will enable `pygls` to cache the `lines` attribute later internally. The caching is not done in this commit as it would require us to figure out the cache invalidation rules, which will be after this has been accepted.
e54c3da to
2093116
Compare
tombh
approved these changes
Jun 18, 2025
Collaborator
|
This looks great. I've requested a review from Alex as well as he's done work on the types. |
alcarney
approved these changes
Jun 20, 2025
alcarney
left a comment
Collaborator
There was a problem hiding this comment.
Looks great - thank you!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
PositionCodecdoes not need a mutable sequence as it only does read-only operations. Additionally,TextDocument.linescan now return an immutable list (using tuple here for simplicity), which will enablepyglsto cache thelinesattribute later internally.The caching is not done in this commit as it would require us to figure out the cache invalidation rules, which will be after this has been accepted.
Description (e.g. "Related to ...", etc.)
See #551
Code review checklist (for code reviewer to complete)
Automated linters
You can run the lints that are run on CI locally with: