Skip to content

Commit

Permalink
modernize (#634)
Browse files Browse the repository at this point in the history
* Hint that __repr__ dunders return a str

* Remove duplicate import of 'traceback' module

* Annotate parameters of __eq__, its return, and return NotImplemented

See: https://docs.python.org/3/library/constants.html#NotImplemented
  • Loading branch information
maxice8 committed Nov 23, 2023
1 parent 3d98c5a commit 2fbb736
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 44 deletions.
3 changes: 1 addition & 2 deletions vespa/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
from tenacity import retry, wait_exponential, stop_after_attempt
from time import sleep
from os import environ
import traceback

from vespa.exceptions import VespaError
from vespa.io import VespaQueryResponse, VespaResponse
Expand Down Expand Up @@ -166,7 +165,7 @@ def _check_for_running_loop_and_run_coroutine(coro):
def http(self, pool_maxsize: int = 10):
return VespaSync(app=self, pool_maxsize=pool_maxsize, pool_connections=pool_maxsize)

def __repr__(self):
def __repr__(self) -> str:
if self.port:
return "Vespa({}, {})".format(self.url, self.port)
else:
Expand Down
84 changes: 42 additions & 42 deletions vespa/package.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,17 +181,17 @@ def __init__(
self.max_links_per_node = max_links_per_node
self.neighbors_to_explore_at_insert = neighbors_to_explore_at_insert

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.distance_metric == other.distance_metric
and self.max_links_per_node == other.max_links_per_node
and self.neighbors_to_explore_at_insert
== other.neighbors_to_explore_at_insert
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3})".format(
self.__class__.__name__,
repr(self.distance_metric),
Expand Down Expand Up @@ -470,9 +470,9 @@ def add_struct_fields(self, *struct_fields: StructField) -> None:
for struct_field in struct_fields:
self._struct_fields.update({struct_field.name: struct_field})

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.name == other.name
and self.type == other.type
Expand All @@ -491,7 +491,7 @@ def __eq__(self, other):
and self.struct_fields == other.struct_fields
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3}, {4}, {5}, {6}, {7}, {8}, {9}, {10}, {11}, {12}, {13}, {14}, {15})".format(
self.__class__.__name__,
repr(self.name),
Expand Down Expand Up @@ -541,16 +541,16 @@ def __init__(
self.reference_field = reference_field
self.field_to_import = field_to_import

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.name == other.name
and self.reference_field == other.reference_field
and self.field_to_import == other.field_to_import
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3})".format(
self.__class__.__name__,
repr(self.name),
Expand Down Expand Up @@ -736,16 +736,16 @@ def add_structs(self, *structs: Struct) -> None:
for struct in structs:
self._structs.update({struct.name: struct})

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (self.fields, self.inherits, self.structs) == (
other.fields,
other.inherits,
other.structs,
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3})".format(
self.__class__.__name__,
repr(self.fields) if self.fields else None,
Expand Down Expand Up @@ -777,12 +777,12 @@ def fields_to_text(self):
if self.fields is not None:
return ", ".join(self.fields)

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return self.name == other.name and self.fields == other.fields

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2})".format(
self.__class__.__name__, repr(self.name), repr(self.fields)
)
Expand Down Expand Up @@ -836,16 +836,16 @@ def args_to_text(self) -> str:
else:
return ""

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.name == other.name
and self.expression == other.expression
and self.args == other.args
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3})".format(
self.__class__.__name__,
repr(self.name),
Expand Down Expand Up @@ -923,15 +923,15 @@ def __init__(self, expression: str, rerank_count: int = 100) -> None:
self.expression = expression
self.rerank_count = rerank_count

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.expression == other.expression
and self.rerank_count == other.rerank_count
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2})".format(
self.__class__.__name__,
repr(self.expression),
Expand All @@ -958,15 +958,15 @@ def __init__(self, expression: str, rerank_count: int = 100) -> None:
self.expression = expression
self.rerank_count = rerank_count

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.expression == other.expression
and self.rerank_count == other.rerank_count
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2})".format(
self.__class__.__name__,
repr(self.expression),
Expand Down Expand Up @@ -1198,17 +1198,17 @@ def __init__(
self.model_file_name = self.model_name + ".onnx"
self.file_path = os.path.join("files", self.model_file_name)

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return (
self.model_name == other.model_name
and self.model_file_path == other.model_file_path
and self.inputs == other.inputs
and self.outputs == other.outputs
)

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3}, {4})".format(
self.__class__.__name__,
repr(self.model_name),
Expand Down Expand Up @@ -1433,12 +1433,12 @@ def __init__(
self.name = name
self.type = type

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return self.name == other.name and self.type == other.type

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2})".format(
self.__class__.__name__,
repr(self.name),
Expand Down Expand Up @@ -1493,12 +1493,12 @@ def add_fields(self, *fields: QueryTypeField) -> None:
"""
self.fields.extend(fields)

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return self.fields == other.fields

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1})".format(
self.__class__.__name__, repr(self.fields) if self.fields else None
)
Expand All @@ -1522,12 +1522,12 @@ def __init__(
self.name = name
self.value = value

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return self.name == other.name and self.value == other.value

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2})".format(
self.__class__.__name__,
repr(self.name),
Expand Down Expand Up @@ -1568,12 +1568,12 @@ def add_fields(self, *fields: QueryField) -> None:
"""
self.fields.extend(fields)

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return self.fields == other.fields

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1})".format(
self.__class__.__name__, repr(self.fields) if self.fields else None
)
Expand Down Expand Up @@ -2118,12 +2118,12 @@ def to_files(self, root: Path) -> None:
with open(os.path.join(root, "validation-overrides.xml"), "w") as f:
f.write(self.validations_to_text)

def __eq__(self, other):
def __eq__(self, other: object) -> bool:
if not isinstance(other, self.__class__):
return False
return NotImplemented
return self.name == other.name and self._schema == other._schema

def __repr__(self):
def __repr__(self) -> str:
return "{0}({1}, {2}, {3}, {4})".format(
self.__class__.__name__,
repr(self.name),
Expand Down

0 comments on commit 2fbb736

Please sign in to comment.