Skip to content

Commit

Permalink
Fix type Optional Union type hints
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElliottKasoar
ElliottKasoar committed Jun 11, 2024
1 parent fffe4fa commit 01e7a5f
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions abcd/backends/atoms_opensearch.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -317,13 +317,13 @@ def info(self):
"type": "opensearch",
}

def delete(self, query: Optional[dict, str] = None):
def delete(self, query: Optional[Union[dict, str]] = None):
"""
Deletes documents from the database.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to be deleted. Default is `None`.
"""
query = self.parser(query)
Expand Down Expand Up @@ -376,7 +376,7 @@ def save_bulk(self, actions: Iterable, **kwargs):
def push(
self,
atoms: Union[Atoms, Iterable],
extra_info: Optional[dict, str, list] = None,
extra_info: Optional[Union[dict, str, list]] = None,
store_calc: bool = True,
**kwargs,
):
Expand All @@ -386,7 +386,7 @@ def push(
Parameters
----------
atoms: Union[Atoms, Iterable]
extra_info: Optional[Union[dict, str]], optional
extra_info: [Union[dict, str, list]]
Extra information to store in the document with the atoms data.
Default is `None`.
store_calc: bool, optional
Expand Down Expand Up @@ -463,14 +463,14 @@ def upload(
self.push(data, extra_info, store_calc=store_calc)

def get_items(
self, query: Optional[dict, str] = None
self, query: Optional[Union[dict, str]] = None
) -> Generator[dict, None, None]:
"""
Get data as a dictionary from documents in the database.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to get data from. Default is `None`.
Returns
Expand All @@ -490,14 +490,14 @@ def get_items(
yield {"_id": hit["_id"], **hit["_source"]}

def get_atoms(
self, query: Optional[dict, str] = None
self, query: Optional[Union[dict, str]] = None
) -> Generator[Atoms, None, None]:
"""
Get data as Atoms object from documents in the database.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to get data from. Default is `None`.
Returns
Expand All @@ -516,13 +516,13 @@ def get_atoms(
):
yield AtomsModel(None, None, hit["_source"]).to_ase()

def count(self, query: Optional[dict, str] = None, timeout=30.0) -> int:
def count(self, query: Optional[Union[dict, str]] = None, timeout=30.0) -> int:
"""
Counts number of documents in the database.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to be counted. Default is `None`.
timeout: float
Timeout for request in seconds.
Expand All @@ -544,7 +544,7 @@ def count(self, query: Optional[dict, str] = None, timeout=30.0) -> int:
def _get_props_from_source(
self,
names: Union[str, list[str]],
query: Optional[dict, str] = None,
query: Optional[Union[dict, str]] = None,
) -> dict:
"""
Gets all values of specified properties using the original data from _source.
Expand All @@ -553,7 +553,7 @@ def _get_props_from_source(
----------
names: Union[str, list[str]]
Name or list of names of properties to return.
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to get properties from. Default is `None`.
Returns
Expand Down Expand Up @@ -581,7 +581,7 @@ def property(
self,
names: Union[str, list[str]],
allow_flatten: bool = True,
query: Optional[dict, str] = None,
query: Optional[Union[dict, str]] = None,
) -> Union[dict, list]:
"""
Gets all values of specified properties for matching documents in the database.
Expand All @@ -593,7 +593,7 @@ def property(
allow_flatten: bool = True
Whether to allow arrays to be returned flattened. There is no guarantee
for the order of returned values. Default is `True`.
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to get properties from. Default is `None`.
Returns
Expand Down Expand Up @@ -645,15 +645,15 @@ def property(
return props[names[0]]
return props

def count_property(self, name, query: Optional[dict, str] = None) -> dict:
def count_property(self, name, query: Optional[Union[dict, str]] = None) -> dict:
"""
Counts values of a specified property for matching documents in the
database. This method much faster than performing a Count on the list
returned by self.property, so this method should be used preferentially.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to count properties from. Default is `None`.
Returns
Expand Down Expand Up @@ -685,14 +685,14 @@ def count_property(self, name, query: Optional[dict, str] = None) -> dict:

return prop

def properties(self, query: Optional[dict, str] = None) -> dict:
def properties(self, query: Optional[Union[dict, str]] = None) -> dict:
"""
Gets lists of all properties from matching documents, separated into
info, derived, and array properties.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to get properties from. Default is `None`.
Returns
Expand Down Expand Up @@ -778,13 +778,13 @@ def get_type_of_property(self, prop: str, category: str) -> str:
return "vector({})".format(map_types[type(data[0])])
return "scalar({})".format(map_types[type(data)])

def count_properties(self, query: Optional[dict, str] = None) -> dict:
def count_properties(self, query: Optional[Union[dict, str]] = None) -> dict:
"""
Counts all properties from matching documents.
Parameters
----------
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to count properties from. Default is `None`.
Returns
Expand Down Expand Up @@ -837,15 +837,15 @@ def count_properties(self, query: Optional[dict, str] = None) -> dict:

return properties

def add_property(self, data: dict, query: Optional[dict, str] = None):
def add_property(self, data: dict, query: Optional[Union[dict, str]] = None):
"""
Adds properties to matching documents.
Parameters
----------
data: dict
Property key-value pairs to be added to matching documents.
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to add properties to. Default is `None`.
"""
query = self.parser(query)
Expand All @@ -870,7 +870,7 @@ def add_property(self, data: dict, query: Optional[dict, str] = None):
)

def rename_property(
self, name: str, new_name: str, query: Optional[dict, str] = None
self, name: str, new_name: str, query: Optional[Union[dict, str]] = None
):
"""
Renames property for all matching documents.
Expand All @@ -881,7 +881,7 @@ def rename_property(
Current name of property to be renamed.
new_name: str
New name of property to be renamed.
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to rename property. Default is `None`.
"""
query = self.parser(query)
Expand All @@ -907,15 +907,15 @@ def rename_property(

self.client.update_by_query(index=self.index_name, body=body)

def delete_property(self, name: str, query: Optional[dict, str] = None):
def delete_property(self, name: str, query: Optional[Union[dict, str]] = None):
"""
Deletes property from all matching documents.
Parameters
----------
name: str
Name of property to be deleted from documents.
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents to have property deleted. Default is `None`.
"""
query = self.parser(query)
Expand All @@ -941,7 +941,7 @@ def delete_property(self, name: str, query: Optional[dict, str] = None):
self.client.update_by_query(index=self.index_name, body=body)

def hist(
self, name: str, query: Optional[dict, str] = None, **kwargs
self, name: str, query: Optional[Union[dict, str]] = None, **kwargs
) -> Union[dict, None]:
"""
Calculate histogram statistics for a property from all matching documents.
Expand All @@ -950,7 +950,7 @@ def hist(
----------
name: str
Name of property.
query: Optional[dict, str]
query: Optional[Union[dict, str]]
Query to filter documents. Default is `None`.
Returns
Expand Down

0 comments on commit 01e7a5f

Please sign in to comment.