Skip to content

Commit 01e7a5f

Browse files
ElliottKasoarElliottKasoar
committed
Fix type Optional Union type hints
1 parent fffe4fa commit 01e7a5f

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎abcd/backends/atoms_opensearch.py‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -317,13 +317,13 @@ def info(self):
317317
"type": "opensearch",
318318
}
319319

320-
def delete(self, query: Optional[dict, str] = None):
320+
def delete(self, query: Optional[Union[dict, str]] = None):
321321
"""
322322
Deletes documents from the database.
323323
324324
Parameters
325325
----------
326-
query: Optional[dict, str]
326+
query: Optional[Union[dict, str]]
327327
Query to filter documents to be deleted. Default is `None`.
328328
"""
329329
query = self.parser(query)
@@ -376,7 +376,7 @@ def save_bulk(self, actions: Iterable, **kwargs):
376376
def push(
377377
self,
378378
atoms: Union[Atoms, Iterable],
379-
extra_info: Optional[dict, str, list] = None,
379+
extra_info: Optional[Union[dict, str, list]] = None,
380380
store_calc: bool = True,
381381
**kwargs,
382382
):
@@ -386,7 +386,7 @@ def push(
386386
Parameters
387387
----------
388388
atoms: Union[Atoms, Iterable]
389-
extra_info: Optional[Union[dict, str]], optional
389+
extra_info: [Union[dict, str, list]]
390390
Extra information to store in the document with the atoms data.
391391
Default is `None`.
392392
store_calc: bool, optional
@@ -463,14 +463,14 @@ def upload(
463463
self.push(data, extra_info, store_calc=store_calc)
464464

465465
def get_items(
466-
self, query: Optional[dict, str] = None
466+
self, query: Optional[Union[dict, str]] = None
467467
) -> Generator[dict, None, None]:
468468
"""
469469
Get data as a dictionary from documents in the database.
470470
471471
Parameters
472472
----------
473-
query: Optional[dict, str]
473+
query: Optional[Union[dict, str]]
474474
Query to filter documents to get data from. Default is `None`.
475475
476476
Returns
@@ -490,14 +490,14 @@ def get_items(
490490
yield {"_id": hit["_id"], **hit["_source"]}
491491

492492
def get_atoms(
493-
self, query: Optional[dict, str] = None
493+
self, query: Optional[Union[dict, str]] = None
494494
) -> Generator[Atoms, None, None]:
495495
"""
496496
Get data as Atoms object from documents in the database.
497497
498498
Parameters
499499
----------
500-
query: Optional[dict, str]
500+
query: Optional[Union[dict, str]]
501501
Query to filter documents to get data from. Default is `None`.
502502
503503
Returns
@@ -516,13 +516,13 @@ def get_atoms(
516516
):
517517
yield AtomsModel(None, None, hit["_source"]).to_ase()
518518

519-
def count(self, query: Optional[dict, str] = None, timeout=30.0) -> int:
519+
def count(self, query: Optional[Union[dict, str]] = None, timeout=30.0) -> int:
520520
"""
521521
Counts number of documents in the database.
522522
523523
Parameters
524524
----------
525-
query: Optional[dict, str]
525+
query: Optional[Union[dict, str]]
526526
Query to filter documents to be counted. Default is `None`.
527527
timeout: float
528528
Timeout for request in seconds.
@@ -544,7 +544,7 @@ def count(self, query: Optional[dict, str] = None, timeout=30.0) -> int:
544544
def _get_props_from_source(
545545
self,
546546
names: Union[str, list[str]],
547-
query: Optional[dict, str] = None,
547+
query: Optional[Union[dict, str]] = None,
548548
) -> dict:
549549
"""
550550
Gets all values of specified properties using the original data from _source.
@@ -553,7 +553,7 @@ def _get_props_from_source(
553553
----------
554554
names: Union[str, list[str]]
555555
Name or list of names of properties to return.
556-
query: Optional[dict, str]
556+
query: Optional[Union[dict, str]]
557557
Query to filter documents to get properties from. Default is `None`.
558558
559559
Returns
@@ -581,7 +581,7 @@ def property(
581581
self,
582582
names: Union[str, list[str]],
583583
allow_flatten: bool = True,
584-
query: Optional[dict, str] = None,
584+
query: Optional[Union[dict, str]] = None,
585585
) -> Union[dict, list]:
586586
"""
587587
Gets all values of specified properties for matching documents in the database.
@@ -593,7 +593,7 @@ def property(
593593
allow_flatten: bool = True
594594
Whether to allow arrays to be returned flattened. There is no guarantee
595595
for the order of returned values. Default is `True`.
596-
query: Optional[dict, str]
596+
query: Optional[Union[dict, str]]
597597
Query to filter documents to get properties from. Default is `None`.
598598
599599
Returns
@@ -645,15 +645,15 @@ def property(
645645
return props[names[0]]
646646
return props
647647

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

686686
return prop
687687

688-
def properties(self, query: Optional[dict, str] = None) -> dict:
688+
def properties(self, query: Optional[Union[dict, str]] = None) -> dict:
689689
"""
690690
Gets lists of all properties from matching documents, separated into
691691
info, derived, and array properties.
692692
693693
Parameters
694694
----------
695-
query: Optional[dict, str]
695+
query: Optional[Union[dict, str]]
696696
Query to filter documents to get properties from. Default is `None`.
697697
698698
Returns
@@ -778,13 +778,13 @@ def get_type_of_property(self, prop: str, category: str) -> str:
778778
return "vector({})".format(map_types[type(data[0])])
779779
return "scalar({})".format(map_types[type(data)])
780780

781-
def count_properties(self, query: Optional[dict, str] = None) -> dict:
781+
def count_properties(self, query: Optional[Union[dict, str]] = None) -> dict:
782782
"""
783783
Counts all properties from matching documents.
784784
785785
Parameters
786786
----------
787-
query: Optional[dict, str]
787+
query: Optional[Union[dict, str]]
788788
Query to filter documents to count properties from. Default is `None`.
789789
790790
Returns
@@ -837,15 +837,15 @@ def count_properties(self, query: Optional[dict, str] = None) -> dict:
837837

838838
return properties
839839

840-
def add_property(self, data: dict, query: Optional[dict, str] = None):
840+
def add_property(self, data: dict, query: Optional[Union[dict, str]] = None):
841841
"""
842842
Adds properties to matching documents.
843843
844844
Parameters
845845
----------
846846
data: dict
847847
Property key-value pairs to be added to matching documents.
848-
query: Optional[dict, str]
848+
query: Optional[Union[dict, str]]
849849
Query to filter documents to add properties to. Default is `None`.
850850
"""
851851
query = self.parser(query)
@@ -870,7 +870,7 @@ def add_property(self, data: dict, query: Optional[dict, str] = None):
870870
)
871871

872872
def rename_property(
873-
self, name: str, new_name: str, query: Optional[dict, str] = None
873+
self, name: str, new_name: str, query: Optional[Union[dict, str]] = None
874874
):
875875
"""
876876
Renames property for all matching documents.
@@ -881,7 +881,7 @@ def rename_property(
881881
Current name of property to be renamed.
882882
new_name: str
883883
New name of property to be renamed.
884-
query: Optional[dict, str]
884+
query: Optional[Union[dict, str]]
885885
Query to filter documents to rename property. Default is `None`.
886886
"""
887887
query = self.parser(query)
@@ -907,15 +907,15 @@ def rename_property(
907907

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

910-
def delete_property(self, name: str, query: Optional[dict, str] = None):
910+
def delete_property(self, name: str, query: Optional[Union[dict, str]] = None):
911911
"""
912912
Deletes property from all matching documents.
913913
914914
Parameters
915915
----------
916916
name: str
917917
Name of property to be deleted from documents.
918-
query: Optional[dict, str]
918+
query: Optional[Union[dict, str]]
919919
Query to filter documents to have property deleted. Default is `None`.
920920
"""
921921
query = self.parser(query)
@@ -941,7 +941,7 @@ def delete_property(self, name: str, query: Optional[dict, str] = None):
941941
self.client.update_by_query(index=self.index_name, body=body)
942942

943943
def hist(
944-
self, name: str, query: Optional[dict, str] = None, **kwargs
944+
self, name: str, query: Optional[Union[dict, str]] = None, **kwargs
945945
) -> Union[dict, None]:
946946
"""
947947
Calculate histogram statistics for a property from all matching documents.
@@ -950,7 +950,7 @@ def hist(
950950
----------
951951
name: str
952952
Name of property.
953-
query: Optional[dict, str]
953+
query: Optional[Union[dict, str]]
954954
Query to filter documents. Default is `None`.
955955
956956
Returns

0 commit comments

Comments
 (0)