chore: import upstream snapshot with attribution

spacy/tests/doc/test_underscore.py

@@ -0,0 +1,174 @@
+import pytest
+from mock import Mock
+
+from spacy.tokens import Doc, Span, Token
+from spacy.tokens.underscore import Underscore
+
+
+@pytest.fixture(scope="function", autouse=True)
+def clean_underscore():
+    # reset the Underscore object after the test, to avoid having state copied across tests
+    yield
+    Underscore.doc_extensions = {}
+    Underscore.span_extensions = {}
+    Underscore.token_extensions = {}
+
+
+def test_create_doc_underscore():
+    doc = Mock()
+    doc.doc = doc
+    uscore = Underscore(Underscore.doc_extensions, doc)
+    assert uscore._doc is doc
+    assert uscore._start is None
+    assert uscore._end is None
+
+
+def test_doc_underscore_getattr_setattr():
+    doc = Mock()
+    doc.doc = doc
+    doc.user_data = {}
+    Underscore.doc_extensions["hello"] = (False, None, None, None)
+    doc._ = Underscore(Underscore.doc_extensions, doc)
+    assert doc._.hello is False
+    doc._.hello = True
+    assert doc._.hello is True
+
+
+def test_create_span_underscore():
+    span = Mock(doc=Mock(), start=0, end=2)
+    uscore = Underscore(
+        Underscore.span_extensions, span, start=span.start, end=span.end
+    )
+    assert uscore._doc is span.doc
+    assert uscore._start is span.start
+    assert uscore._end is span.end
+
+
+def test_span_underscore_getter_setter():
+    span = Mock(doc=Mock(), start=0, end=2)
+    Underscore.span_extensions["hello"] = (
+        None,
+        None,
+        lambda s: (s.start, "hi"),
+        lambda s, value: setattr(s, "start", value),
+    )
+    span._ = Underscore(
+        Underscore.span_extensions, span, start=span.start, end=span.end
+    )
+
+    assert span._.hello == (0, "hi")
+    span._.hello = 1
+    assert span._.hello == (1, "hi")
+
+
+def test_token_underscore_method():
+    token = Mock(doc=Mock(), idx=7, say_cheese=lambda token: "cheese")
+    Underscore.token_extensions["hello"] = (None, token.say_cheese, None, None)
+    token._ = Underscore(Underscore.token_extensions, token, start=token.idx)
+    assert token._.hello() == "cheese"
+
+
+@pytest.mark.parametrize("obj", [Doc, Span, Token])
+def test_doc_underscore_remove_extension(obj):
+    ext_name = "to_be_removed"
+    obj.set_extension(ext_name, default=False)
+    assert obj.has_extension(ext_name)
+    obj.remove_extension(ext_name)
+    assert not obj.has_extension(ext_name)
+
+
+@pytest.mark.parametrize("obj", [Doc, Span, Token])
+def test_underscore_raises_for_dup(obj):
+    obj.set_extension("test", default=None)
+    with pytest.raises(ValueError):
+        obj.set_extension("test", default=None)
+
+
+@pytest.mark.parametrize(
+    "invalid_kwargs",
+    [
+        {"getter": None, "setter": lambda: None},
+        {"default": None, "method": lambda: None, "getter": lambda: None},
+        {"setter": lambda: None},
+        {"default": None, "method": lambda: None},
+        {"getter": True},
+    ],
+)
+def test_underscore_raises_for_invalid(invalid_kwargs):
+    invalid_kwargs["force"] = True
+    with pytest.raises(ValueError):
+        Doc.set_extension("test", **invalid_kwargs)
+
+
+@pytest.mark.parametrize(
+    "valid_kwargs",
+    [
+        {"getter": lambda: None},
+        {"getter": lambda: None, "setter": lambda: None},
+        {"default": "hello"},
+        {"default": None},
+        {"method": lambda: None},
+    ],
+)
+def test_underscore_accepts_valid(valid_kwargs):
+    valid_kwargs["force"] = True
+    Doc.set_extension("test", **valid_kwargs)
+
+
+def test_underscore_mutable_defaults_list(en_vocab):
+    """Test that mutable default arguments are handled correctly (see #2581)."""
+    Doc.set_extension("mutable", default=[])
+    doc1 = Doc(en_vocab, words=["one"])
+    doc2 = Doc(en_vocab, words=["two"])
+    doc1._.mutable.append("foo")
+    assert len(doc1._.mutable) == 1
+    assert doc1._.mutable[0] == "foo"
+    assert len(doc2._.mutable) == 0
+    doc1._.mutable = ["bar", "baz"]
+    doc1._.mutable.append("foo")
+    assert len(doc1._.mutable) == 3
+    assert len(doc2._.mutable) == 0
+
+
+def test_underscore_mutable_defaults_dict(en_vocab):
+    """Test that mutable default arguments are handled correctly (see #2581)."""
+    Token.set_extension("mutable", default={})
+    token1 = Doc(en_vocab, words=["one"])[0]
+    token2 = Doc(en_vocab, words=["two"])[0]
+    token1._.mutable["foo"] = "bar"
+    assert len(token1._.mutable) == 1
+    assert token1._.mutable["foo"] == "bar"
+    assert len(token2._.mutable) == 0
+    token1._.mutable["foo"] = "baz"
+    assert len(token1._.mutable) == 1
+    assert token1._.mutable["foo"] == "baz"
+    token1._.mutable["x"] = []
+    token1._.mutable["x"].append("y")
+    assert len(token1._.mutable) == 2
+    assert token1._.mutable["x"] == ["y"]
+    assert len(token2._.mutable) == 0
+
+
+def test_underscore_dir(en_vocab):
+    """Test that dir() correctly returns extension attributes. This enables
+    things like tab-completion for the attributes in doc._."""
+    Doc.set_extension("test_dir", default=None)
+    doc = Doc(en_vocab, words=["hello", "world"])
+    assert "_" in dir(doc)
+    assert "test_dir" in dir(doc._)
+    assert "test_dir" not in dir(doc[0]._)
+    assert "test_dir" not in dir(doc[0:2]._)
+
+
+def test_underscore_docstring(en_vocab):
+    """Test that docstrings are available for extension methods, even though
+    they're partials."""
+
+    def test_method(doc, arg1=1, arg2=2):
+        """I am a docstring"""
+        return (arg1, arg2)
+
+    Doc.set_extension("test_docstrings", method=test_method)
+    doc = Doc(en_vocab, words=["hello", "world"])
+    assert test_method.__doc__ == "I am a docstring"
+    assert doc._.test_docstrings.__doc__.rsplit(". ")[-1] == "I am a docstring"