From 539129154160e850d3e7d9a8ec5bc358b9b121d7 Mon Sep 17 00:00:00 2001
From: Tomoko Uchida <tomoko.uchida.1111@gmail.com>
Date: Mon, 11 Dec 2023 20:53:27 +0900
Subject: [PATCH] Add all Python stubs in tantivy.pyi (#169)

---
 tantivy/tantivy.pyi | 252 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 251 insertions(+), 1 deletion(-)

diff --git a/tantivy/tantivy.pyi b/tantivy/tantivy.pyi
index 7da14b2..3d2c580 100644
--- a/tantivy/tantivy.pyi
+++ b/tantivy/tantivy.pyi
@@ -1,7 +1,17 @@
+import datetime
+from enum import Enum
+from typing import Any, Optional
+
+
 class Schema:
     pass
 
 class SchemaBuilder:
+
+    @staticmethod
+    def is_valid_field_name(name: str) -> bool:
+        pass
+
     def add_text_field(
             self,
             name: str,
@@ -91,4 +101,244 @@ class SchemaBuilder:
         pass
 
     def build(self) -> Schema:
-        pass
\ No newline at end of file
+        pass
+
+
+class Facet:
+    @staticmethod
+    def from_encoded(encoded_bytes: bytes) -> Facet:
+        pass
+
+    @classmethod
+    def root(cls) -> Facet:
+        pass
+
+    @classmethod
+    def from_string(cls, facet_string: str) -> Facet:
+        pass
+
+    @property
+    def is_root(self) -> bool:
+        pass
+
+    def is_prefix_of(self, other: Facet) -> bool:
+        pass
+
+    def to_path(self) -> list[str]:
+        pass
+
+    def to_path_str(self) -> str:
+        pass
+
+
+class Document:
+
+    def __new__(cls, **kwargs) -> Document:
+        pass
+
+    def extend(self, py_dict: dict, schema: Optional[Schema]) -> None:
+        pass
+
+    @staticmethod
+    def from_dict(py_dict: dict, schema: Optional[Schema]) -> Document:
+        pass
+
+    def to_dict(self) -> Any:
+        pass
+
+    def add_text(self, field_name: str, text: str) -> None:
+        pass
+
+    def add_unsigned(self, field_name: str, value: int) -> None:
+        pass
+
+    def add_integer(self, field_name: str, value: int) -> None:
+        pass
+
+    def add_float(self, field_name: str, value: float) -> None:
+        pass
+
+    def add_boolean(self, field_name: str, value: bool) -> None:
+        pass
+
+    def add_date(self, field_name: str, value: datetime.datetime) -> None:
+        pass
+
+    def add_facet(self, field_name: str, facet: Facet) -> None:
+        pass
+
+    def add_bytes(self, field_name: str, bytes: bytes) -> None:
+        pass
+
+    def add_json(self, field_name: str, value: Any) -> None:
+        pass
+
+    @property
+    def num_fields(self) -> int:
+        pass
+
+    @property
+    def is_empty(self) -> bool:
+        pass
+
+    def get_first(self, field_name: str) -> Optional[Any]:
+        pass
+
+    def get_all(self, field_name: str) -> list[Any]:
+        pass
+
+
+class Query:
+    pass
+
+
+class Order(Enum):
+    Asc = 1
+    Desc = 2
+
+
+class DocAddress:
+
+    def __new__(cls, segment_ord: int, doc: int) -> DocAddress:
+        pass
+
+    @property
+    def segment_ord(self) -> int:
+        pass
+
+    @property
+    def doc(self) -> int:
+        pass
+
+class SearchResult:
+
+    @property
+    def hits(self) -> list[tuple[Any, DocAddress]]:
+        pass
+
+
+class Searcher:
+
+    def search(
+            self,
+            query: Query,
+            limit: int = 10,
+            count: bool = True,
+            order_by_field: Optional[str] = None,
+            offset: int = 0,
+            order: Order = Order.Desc,
+    ) -> SearchResult:
+        pass
+
+    @property
+    def num_docs(self) -> int:
+        pass
+
+    @property
+    def num_segments(self) -> int:
+        pass
+
+    def doc(self, doc_address: DocAddress) -> Document:
+        pass
+
+
+class IndexWriter:
+
+    def add_document(self, doc: Document) -> int:
+        pass
+
+    def add_json(self, json: str) -> int:
+        pass
+
+    def commit(self) -> int:
+        pass
+
+    def rollback(self) -> int:
+        pass
+
+    def garbage_collect_files(self) -> None:
+        pass
+
+    def delete_all_documents(self) -> None:
+        pass
+
+    @property
+    def commit_opstamp(self) -> int:
+        pass
+
+    def delete_documents(self, field_name: str, field_value: Any) -> int:
+        pass
+
+    def wait_merging_threads(self) -> None:
+        pass
+
+
+class Index:
+
+    def __new__(cls, schema: Schema, path: Optional[str] = None, reuse: bool = True) -> Index:
+        pass
+
+    @staticmethod
+    def open(path: str) -> Index:
+        pass
+
+    def writer(self, heap_size: int = 128_000_000, num_threads: int = 0) -> IndexWriter:
+        pass
+
+    def config_reader(self, reload_policy: str = "commit", num_warmers: int = 0) -> None:
+        pass
+
+    def searcher(self) -> Searcher:
+        pass
+
+    @staticmethod
+    def exists(path: str) -> bool:
+        pass
+
+    @property
+    def schema(self) -> Schema:
+        pass
+
+    def reload(self) -> None:
+        pass
+
+    def parse_query(self, query: str, default_field_names: Optional[list[str]] = None) -> Query:
+        pass
+
+    def parse_query_lenient(self, query: str, default_field_names: Optional[list[str]] = None) -> Query:
+        pass
+
+
+class Range:
+
+    @property
+    def start(self) -> int:
+        pass
+
+    @property
+    def end(self) -> int:
+        pass
+
+
+class Snippet:
+
+    def to_html(self) -> str:
+        pass
+
+    def highlighted(self) -> list[Range]:
+        pass
+
+
+class SnippetGenerator:
+
+    @staticmethod
+    def create(
+        searcher: Searcher,
+        query: Query,
+        schema: Schema,
+        field_name: str
+    ) -> SnippetGenerator:
+        pass
+
+    def snippet_from_doc(self, doc: Document) -> Snippet:
+        pass