Skip to content

Commit

Permalink
Add python stub with type hints. (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
mocobeta authored Dec 9, 2023
1 parent 314b436 commit eede48a
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 0 deletions.
Empty file added tantivy/py.typed
Empty file.
94 changes: 94 additions & 0 deletions tantivy/tantivy.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
class Schema:
pass

class SchemaBuilder:
def add_text_field(
self,
name: str,
stored: bool = False,
tokenizer_name: str = "default",
index_option: str = "position",
) -> SchemaBuilder:
pass

def add_integer_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
) -> SchemaBuilder:
pass

def add_float_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
) -> SchemaBuilder:
pass

def add_unsigned_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
) -> SchemaBuilder:
pass

def add_boolean_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
) -> SchemaBuilder:
pass

def add_date_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
) -> SchemaBuilder:
pass

def add_json_field(
self,
name: str,
stored: bool = False,
tokenizer_name: str = "default",
index_option: str = "position",
) -> SchemaBuilder:
pass

def add_facet_field(
self,
name: str,
) -> SchemaBuilder:
pass

def add_bytes_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
index_option: str = "position",
) -> SchemaBuilder:
pass

def add_ip_addr_field(
self,
name: str,
stored: bool = False,
indexed: bool = False,
fast: bool = False,
) -> SchemaBuilder:
pass

def build(self) -> Schema:
pass

0 comments on commit eede48a

Please sign in to comment.