Method test_hint

tests/document/test_indexes.py:490–527

(self)

        assert indexes["categories_1__id_1"]["key"] == [("categories", 1), ("_id", 1)]

    def test_hint(self):
        TAGS_INDEX_NAME = "tags_1"

        class BlogPost(Document):
            tags = ListField(StringField())
            meta = {"indexes": [{"fields": ["tags"], "name": TAGS_INDEX_NAME}]}

        BlogPost.drop_collection()

        for i in range(10):
            tags = [("tag %i" % n) for n in range(i % 2)]
            BlogPost(tags=tags).save()

        # Hinting by shape should work.
        assert BlogPost.objects.hint([("tags", 1)]).count() == 10

        # Hinting by index name should work.
        assert BlogPost.objects.hint(TAGS_INDEX_NAME).count() == 10

        # Clearing the hint should work fine.
        assert BlogPost.objects.hint().count() == 10
        assert BlogPost.objects.hint([("ZZ", 1)]).hint().count() == 10

        # Hinting on a non-existent index shape should fail.
        with pytest.raises(OperationFailure):
            BlogPost.objects.hint([("ZZ", 1)]).count()

        # Hinting on a non-existent index name should fail.
        with pytest.raises(OperationFailure):
            BlogPost.objects.hint("Bad Name").count()

        # Invalid shape argument (missing list brackets) should fail.
        if PYMONGO_VERSION <= (4, 3):
            with pytest.raises(ValueError):
                BlogPost.objects.hint(("tags", 1)).count()
        else:
            with pytest.raises(TypeError):
                BlogPost.objects.hint(("tags", 1)).count()

    def test_collation(self):
        base = {"locale": "en", "strength": 2}