Allow requests for documents not managed by the server (#296)

Author: gatesn

pyls/workspace.py

@@ -107,14 +107,14 @@ def is_local(self):
         return (self._root_uri_scheme == '' or self._root_uri_scheme == 'file') and os.path.exists(self._root_path)
 
     def get_document(self, doc_uri):
-        return self._docs[doc_uri]
+        """Return a managed document if-present, else create one pointing at disk.
 
-    def put_document(self, doc_uri, content, version=None):
-        path = uris.to_fs_path(doc_uri)
-        self._docs[doc_uri] = Document(
-            doc_uri, content,
-            extra_sys_path=self.source_roots(path), version=version, rope=self._rope
-        )
+        See https://github.com/Microsoft/language-server-protocol/issues/177
+        """
+        return self._docs.get(doc_uri) or self._create_document(doc_uri)
+
+    def put_document(self, doc_uri, source, version=None):
+        self._docs[doc_uri] = self._create_document(doc_uri, source=source, version=version)
 
     def rm_document(self, doc_uri):
         self._docs.pop(doc_uri)
@@ -140,6 +140,13 @@ def source_roots(self, document_path):
         files = _utils.find_parents(self._root_path, document_path, ['setup.py']) or []
         return [os.path.dirname(setup_py) for setup_py in files]
 
+    def _create_document(self, doc_uri, source=None, version=None):
+        path = uris.to_fs_path(doc_uri)
+        return Document(
+            doc_uri, source=source,
+            extra_sys_path=self.source_roots(path), rope=self._rope, version=version
+        )
+
 
 class Document(object):
 

test/test_workspace.py

@@ -1,6 +1,5 @@
 # Copyright 2017 Palantir Technologies, Inc.
 import os
-import pytest
 from pyls import uris
 
 DOC_URI = uris.from_fs_path(__file__)
@@ -21,17 +20,19 @@ def test_get_document(pyls):
     assert pyls.workspace.get_document(DOC_URI).source == 'TEXT'
 
 
+def test_get_missing_document(tmpdir, pyls):
+    source = 'TEXT'
+    doc_path = tmpdir.join("test_document.py")
+    doc_path.write(source)
+    doc_uri = uris.from_fs_path(str(doc_path))
+    assert pyls.workspace.get_document(doc_uri).source == 'TEXT'
+
+
 def test_rm_document(pyls):
     pyls.workspace.put_document(DOC_URI, 'TEXT')
     assert pyls.workspace.get_document(DOC_URI).source == 'TEXT'
     pyls.workspace.rm_document(DOC_URI)
-    with pytest.raises(KeyError):
-        pyls.workspace.get_document(DOC_URI)
-
-
-def test_bad_get_document(pyls):
-    with pytest.raises(KeyError):
-        pyls.workspace.get_document("BAD_URI")
+    assert pyls.workspace.get_document(DOC_URI)._source is None
 
 
 def test_non_root_project(pyls):