Skip to content

Commit

Permalink
type: mark types of extra_repr returns
Browse files Browse the repository at this point in the history
  • Loading branch information
yzx9 committed Aug 21, 2024
1 parent d3a8b93 commit 1b4c59e
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions swcgeom/transforms/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def __repr__(self) -> str:
repr_ = self.extra_repr()
return f"{classname}({repr_})"

def extra_repr(self):
def extra_repr(self) -> str:
"""Provides a human-friendly representation of the module.
This method extends the basic string representation provided by
Expand All @@ -48,7 +48,7 @@ class Foo(Transform[T, K]):
def __init__(self, my_parameter: int = 1):
self.my_parameter = my_parameter
def extra_repr(self):
def extra_repr(self) -> str:
return f"my_parameter={self.my_parameter}"
Notes
Expand Down
4 changes: 2 additions & 2 deletions swcgeom/transforms/branch.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def resample(self, xyzr: npt.NDArray[np.float32]) -> npt.NDArray[np.float32]:
r = np.interp(xvals, xp, xyzr[:, 3])
return cast(npt.NDArray[np.float32], np.stack([x, y, z, r], axis=1))

def extra_repr(self):
def extra_repr(self) -> str:
return f"n_nodes={self.n_nodes}"


Expand Down Expand Up @@ -100,7 +100,7 @@ def __call__(self, x: Branch) -> Branch[DictSWC]:

return x

def extra_repr(self):
def extra_repr(self) -> str:
return f"n_nodes={self.n_nodes}"


Expand Down
14 changes: 7 additions & 7 deletions swcgeom/transforms/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def __call__(self, x: T) -> T:
new_tree.ndata[new_tree.names.r] = r
return new_tree

def extra_repr(self):
def extra_repr(self) -> str:
return f"r={self.r:.4f}"


Expand Down Expand Up @@ -141,7 +141,7 @@ def __init__(self, tx: float, ty: float, tz: float, **kwargs) -> None:
super().__init__(translate3d(tx, ty, tz), **kwargs)
self.tx, self.ty, self.tz = tx, ty, tz

def extra_repr(self):
def extra_repr(self) -> str:
return f"tx={self.tx:.4f}, ty={self.ty:.4f}, tz={self.tz:.4f}"

@classmethod
Expand Down Expand Up @@ -194,8 +194,8 @@ def __init__(
self.theta = theta
self.center = center

def extra_repr(self):
return f"n={self.n}, theta={self.theta:.4f}, center={self.center}" # TODO: imporve format of n
def extra_repr(self) -> str:
return f"n={self.n}, theta={self.theta:.4f}, center={self.center}" # TODO: improve format of n

@classmethod
def transform(
Expand All @@ -216,7 +216,7 @@ def __init__(self, theta: float, center: Center = "root", **kwargs) -> None:
super().__init__(rotate3d_x(theta), center=center, **kwargs)
self.theta = theta

def extra_repr(self):
def extra_repr(self) -> str:
return f"center={self.center}, theta={self.theta:.4f}"

@classmethod
Expand All @@ -232,7 +232,7 @@ def __init__(self, theta: float, center: Center = "root", **kwargs) -> None:
self.theta = theta
self.center = center

def extra_repr(self):
def extra_repr(self) -> str:
return f"theta={self.theta:.4f}, center={self.center}"

@classmethod
Expand All @@ -248,7 +248,7 @@ def __init__(self, theta: float, center: Center = "root", **kwargs) -> None:
self.theta = theta
self.center = center

def extra_repr(self):
def extra_repr(self) -> str:
return f"theta={self.theta:.4f}, center={self.center}"

@classmethod
Expand Down
2 changes: 1 addition & 1 deletion swcgeom/transforms/image_stack.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ def transform_population(
if not os.path.isfile(tif):
self.transform_and_save(tif, tree, verbose=False)

def extra_repr(self):
def extra_repr(self) -> str:
res = ",".join(f"{a:.4f}" for a in self.resolution)
return f"resolution=({res})"

Expand Down
6 changes: 3 additions & 3 deletions swcgeom/transforms/tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def __call__(self, x: Tree) -> Tree:

return x

def extra_repr(self):
def extra_repr(self) -> str:
return f"n_nodes={self.n_nodes}"


Expand Down Expand Up @@ -104,7 +104,7 @@ def leave(n: Tree.Node, keep_children: list[bool]) -> bool:
y = to_subtree(x, removals)
return y

def extra_repr(self):
def extra_repr(self) -> str:
return f"type={self.type}"


Expand Down Expand Up @@ -195,7 +195,7 @@ def __call__(self, x: Tree) -> Tree:
self.callbacks.pop()
return to_subtree(x, removals)

def extra_repr(self):
def extra_repr(self) -> str:
return f"threshold={self.thre}"

def _leave(
Expand Down
8 changes: 4 additions & 4 deletions swcgeom/transforms/tree_assembler.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def __init__(self, *, thre: float = 0.2, undirected: bool = True):

def __call__(
self, lines: Iterable[pd.DataFrame], *, names: Optional[SWCNames] = None
):
): # TODO check this
return self.assemble(lines, names=names)

def assemble(
Expand All @@ -56,8 +56,8 @@ def assemble(
Parameters
----------
lines : List of ~pd.DataFrame
An array of tables containing a line, columns should follwing
the swc.
An array of tables containing a line, columns should
following the swc.
undirected : bool, default `True`
Forwarding to `self.try_assemble`.
names : SWCNames, optional
Expand Down Expand Up @@ -170,5 +170,5 @@ def try_assemble(

return tree, lines

def extra_repr(self):
def extra_repr(self) -> str:
return f"thre={self.thre}, undirected={self.undirected}"

0 comments on commit 1b4c59e

Please sign in to comment.