refactor: rename server Position to PositionCodec, instantiate it in Workspace

[RossBencina]

Description

Implement the refactoring discussed in #382

• Rename pygls Position type to PositionCodec
• Create a single PositionCodec instance in Workspace that is used by all TextDocument instances
• Add position_encoding and position_codec read-only properties to Workspace
• Make position_codec a read-only property of TextDocument
• Improve deprecation warning messages associated with the old position mapping functions that have been replaced by PositionCodec

Resolves #382

Code review checklist (for code reviewer to complete)

• Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
• Title summarizes what is changing
• Commit messages are meaningful (see this for details)
• Tests have been included and/or updated, as appropriate
• Docstrings have been included and/or updated, as appropriate
• Standalone docs have been updated accordingly

[RossBencina]

Fixed lint checks

[RossBencina]

There is a question as to whether we also want to roll back the recent changes that qualified lsprotocol symbols with types. to avoid collisions between the two Position types e.g. in e271ba5

If that's desirable I propose to do it in a separate PR.

[RossBencina]

fixed position = PositionCodec to codec = PositionCodec in test_document.py

Apologies for the forced updates. I am done now.

[RossBencina]

Failing CI/test-pyodide but so is the main branch. The reported problem looks unrelated to pygls.

[tombh]

This looks great! Thank you very much.

I think in general throughout the codebase we're trying to move towards qualifying all lsprotocol types with types.* anyway.

I'm a big fan of force pushing in PRs, so thanks for that too.

Yeah don't worry about the Pyodide test.

You can select me or @alcarney, or both, to review this.

[RossBencina]

^^^ force push: make all deprecation warnings consistent:

diff --git a/pygls/workspace/__init__.py b/pygls/workspace/__init__.py
index a18f9d5..4880ef4 100644
--- a/pygls/workspace/__init__.py
+++ b/pygls/workspace/__init__.py
@@ -17,9 +17,9 @@ Document = TextDocument

 def utf16_unit_offset(chars: str):
     warnings.warn(
-        "'utf16_unit_offset' has been deprecated, use "
+        "'utf16_unit_offset' has been deprecated, instead use "
         "'PositionCodec.utf16_unit_offset' via 'workspace.position_codec' "
-        "or 'text_document.position_codec' instead",
+        "or 'text_document.position_codec'",
         DeprecationWarning,
         stacklevel=2,
     )

[RossBencina]

You can select me or @alcarney, or both, to review this.

Thanks for the feedback! I don't believe that I have permissions to assign reviewers. I'm happy for both or either of you to review.

[RossBencina]

^^^ rebased to latest main

[alcarney]

Looks good to me :)

[tombh]

Thank you! ❤️