Use document path instead of an instance

[dhruvmanila]

Summary

The TextDocument instance will always exists, so we can remove the | None
from the type signature. The reason being that pygls will always return a
TextDocument instance via workspace.get_text_document method.

Also, the document.path field can never be None so the check is useless as
well.

[dhruvmanila]

Current dependencies on/for this PR:

• main
  • PR Use document path instead of an instance #265 👈

This comment was auto-generated by Graphite.

[dhruvmanila]

This part becomes irrelevant as it's never executed.

[charliermarsh]

Can we not pass a Document in here and then call Path on it internally? What's the motivation for passing in Path?

[dhruvmanila]

So, for notebook we have a different type NotebookDocument. The motivation being that the event handler will pass in either the notebook or file path along with the source code to the _lint_document_impl. The source code for a notebook will be a JSON string which we need to construct as per the schema (only the required fields).

We could create a type NotebookOrTextDocument which would abstract out the path and source field since that's the only thing we use. Or, we could use a Protocol.

[dhruvmanila]

I'm actually thinking of using str here instead and use Path whenever required instead of instantiating it early on.

[dhruvmanila]

I'm actually thinking of using str here instead and use Path whenever required instead of instantiating it early on.

[charliermarsh]

Got it, what you have here seems reasonable.