swcgeom 0.17.1__py3-none-any.whl → 0.18.1__py3-none-any.whl

swcgeom/core/population.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Neuron population is a set of tree."""
 
 import os
@@ -97,6 +112,19 @@ class ChainTrees:
         return (self[i] for i in range(self.__len__()))
 
 
+class NestTrees:
+    def __init__(self, trees: Trees, idx: Iterable[int], /) -> None:
+        super().__init__()
+        self.trees = trees
+        self.idx = list(idx)
+
+    def __getitem__(self, key: int, /) -> Tree:
+        return self.trees[self.idx[key]]
+
+    def __len__(self) -> int:
+        return len(self.idx)
+
+
 class Population:
     """Neuron population."""
 
@@ -135,13 +163,14 @@ class Population:
 
     # fmt:off
     @overload
-    def __getitem__(self, key: slice) -> list[Tree]: ...
+    def __getitem__(self, key: slice) -> Trees: ...
     @overload
     def __getitem__(self, key: int) -> Tree: ...
     # fmt:on
-    def __getitem__(self, key):
+    def __getitem__(self, key: int | slice):
         if isinstance(key, slice):
-            return [cast(Tree, self.trees[i]) for i in range(*key.indices(len(self)))]
+            trees = NestTrees(self.trees, range(*key.indices(len(self))))
+            return cast(Trees, trees)
 
         if isinstance(key, (int, np.integer)):
             return cast(Tree, self.trees[int(key)])
@@ -328,3 +357,14 @@ def _get_idx(key: int, length: int) -> int:
         key += length
 
     return key
+
+
+# experimental
+def filter_population(
+    pop: Population, predicate: Callable[[Tree], bool]
+) -> "Population":
+    """Filter trees in the population."""
+
+    # TODO: how to avoid load trees
+    idx = [i for i, t in enumerate(pop) if predicate(t)]
+    return Population(NestTrees(pop.trees, idx), root=pop.root)

swcgeom/core/swc.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """SWC format."""
 
 import warnings

swcgeom/core/swc_utils/__init__.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """SWC format utils.
 
 Notes
@@ -8,7 +23,6 @@ If you use the method here, please review the code more frequently, we
 will try to flag all breaking changes but NO promises.
 """
 
-
 from swcgeom.core.swc_utils.assembler import *
 from swcgeom.core.swc_utils.base import *
 from swcgeom.core.swc_utils.checker import *

swcgeom/core/swc_utils/assembler.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Assemble lines to swc.
 
 Notes

swcgeom/core/swc_utils/base.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Base SWC format utils."""
 
 from collections.abc import Callable

swcgeom/core/swc_utils/checker.py

@@ -1,11 +1,26 @@
-"""Check common """
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""Check common"""
 
-import warnings
 from collections import defaultdict
 from typing import Optional
 
 import numpy as np
 import pandas as pd
+from typing_extensions import deprecated
 
 from swcgeom.core.swc_utils.base import SWCNames, Topology, get_dsu, get_names, traverse
 from swcgeom.utils import DisjointSetUnion
@@ -81,6 +96,7 @@ def has_cyclic(topology: Topology) -> bool:
     return False
 
 
+@deprecated("Use `is_single_root` instead")
 def check_single_root(*args, **kwargs) -> bool:
     """Check if the tree is single root.
 
@@ -88,14 +104,10 @@ def check_single_root(*args, **kwargs) -> bool:
         Use :meth:`is_single_root` instead.
     """
 
-    warnings.warn(
-        "`check_single_root` has been renamed to `is_single_root` since"
-        "v0.5.0, and will be removed in next version",
-        DeprecationWarning,
-    )
     return is_single_root(*args, **kwargs)
 
 
+@deprecated("Use `is_bifurcate` instead")
 def is_binary_tree(
     df: pd.DataFrame, exclude_root: bool = True, *, names: Optional[SWCNames] = None
 ) -> bool:
@@ -105,11 +117,6 @@ def is_binary_tree(
         Use :meth:`is_bifurcate` instead.
     """
 
-    warnings.warn(
-        "`is_binary_tree` has been replaced by to `is_bifurcate` since"
-        "v0.8.0, and will be removed in next version",
-        DeprecationWarning,
-    )
     names = get_names(names)
     topo = (df[names.id].to_numpy(), df[names.pid].to_numpy())
     return is_bifurcate(topo, exclude_root=exclude_root)

swcgeom/core/swc_utils/io.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Read and write swc format."""
 
 import re
@@ -172,7 +187,8 @@ def parse_swc(
         RE_FLOAT,  # r
         r"(-?[0-9]+)",  # pid
     ] + [
-        RE_FLOAT for _ in extras  # assert float
+        RE_FLOAT
+        for _ in extras  # assert float
     ]
 
     re_swc_cols_str = r"\s+".join(re_swc_cols)

swcgeom/core/swc_utils/normalizer.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """SWC format utils.
 
 Methods ending with a underline imply an in-place transformation.
@@ -77,7 +92,7 @@ def link_roots_to_nearest_(
         vs = df[[names.x, names.y, names.z]] - row[[names.x, names.y, names.z]]
         dis = np.linalg.norm(vs.to_numpy(), axis=1)
         subtree = dsu == dsu[i]  # type: ignore
-        dis = np.where(subtree, np.Infinity, dis)  # avoid link to same tree
+        dis = np.where(subtree, np.inf, dis)  # avoid link to same tree
         dsu = np.where(subtree, dsu[dis.argmin()], dsu)  # merge set
         df.loc[i, names.pid] = df[names.id].iloc[dis.argmin()]  # type: ignore
 

swcgeom/core/swc_utils/subtree.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Cut subtree.
 
 This module provides a series of low-level topological subtree methods,

swcgeom/core/tree.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Neuron tree."""
 
 import itertools
@@ -8,6 +23,7 @@ from typing import Literal, Optional, TypeVar, Union, overload
 import numpy as np
 import numpy.typing as npt
 import pandas as pd
+from typing_extensions import deprecated
 
 from swcgeom.core.branch import Branch
 from swcgeom.core.compartment import Compartment, Compartments
@@ -38,11 +54,11 @@ class Tree(DictSWC):
 
         def branch(self) -> "Tree.Branch":
             ns: list["Tree.Node"] = [self]
-            while not ns[-1].is_bifurcation() and (p := ns[-1].parent()) is not None:
+            while not ns[-1].is_furcation() and (p := ns[-1].parent()) is not None:
                 ns.append(p)
 
             ns.reverse()
-            while not (ns[-1].is_bifurcation() or ns[-1].is_tip()):
+            while not (ns[-1].is_furcation() or ns[-1].is_tip()):
                 ns.append(ns[-1].children()[0])
 
             return Tree.Branch(self.attach, [n.id for n in ns])
@@ -187,16 +203,28 @@ class Tree(DictSWC):
             raise ValueError(f"no soma found in: {self.source}")
         return n
 
-    def get_bifurcations(self) -> list[Node]:
-        """Get all node of bifurcations."""
-        bifurcations: list[int] = []
+    def get_furcations(self) -> list[Node]:
+        """Get all node of furcations."""
+        furcations: list[int] = []
 
-        def collect_bifurcations(n: Tree.Node, children: list[None]) -> None:
+        def collect_furcations(n: Tree.Node, children: list[None]) -> None:
             if len(children) > 1:
-                bifurcations.append(n.id)
+                furcations.append(n.id)
+
+        self.traverse(leave=collect_furcations)
+        return [self.node(i) for i in furcations]
 
-        self.traverse(leave=collect_bifurcations)
-        return [self.node(i) for i in bifurcations]
+    @deprecated("Use `get_furcations` instead")
+    def get_bifurcations(self) -> list[Node]:
+        """Get all node of furcations.
+
+        Notes
+        -----
+        Deprecated due to the wrong spelling of furcation. For now, it
+        is just an alias of `get_furcations` and raise a warning. It
+        will be change to raise an error in the future.
+        """
+        return self.get_furcations()
 
     def get_tips(self) -> list[Node]:
         """Get all node of tips."""

swcgeom/core/tree_utils.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """SWC util wrapper for tree."""
 
 import warnings
@@ -5,6 +20,7 @@ from collections.abc import Callable, Iterable
 from typing import Optional, TypeVar, overload
 
 import numpy as np
+from typing_extensions import deprecated
 
 from swcgeom.core.swc import SWCLike
 from swcgeom.core.swc_utils import (
@@ -95,6 +111,7 @@ def cut_tree(tree: Tree, *, enter=None, leave=None):
     return to_subtree(tree, removals)
 
 
+@deprecated("Use `to_subtree` instead")
 def to_sub_tree(swc_like: SWCLike, sub: Topology) -> tuple[Tree, dict[int, int]]:
     """Create subtree from origin tree.
 
@@ -111,13 +128,6 @@ def to_sub_tree(swc_like: SWCLike, sub: Topology) -> tuple[Tree, dict[int, int]]
     id_map : dict[int, int]
     """
 
-    warnings.warn(
-        "`to_sub_tree` will be removed in v0.6.0, it is replaced by "
-        "`to_subtree` beacuse it is easy to use, and this will be "
-        "removed in next version",
-        DeprecationWarning,
-    )
-
     sub = propagate_removal(sub)
     (new_id, new_pid), id_map_arr = to_sub_topology(sub)
 

swcgeom/core/tree_utils_impl.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """SWC util wrapper for tree, split to avoid circle imports.
 
 Notes

swcgeom/images/__init__.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Image Stack Related."""
 
 from swcgeom.images.folder import *

swcgeom/images/augmentation.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Play augment in image stack.
 
 Notes

swcgeom/images/contrast.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """The contrast of an image.
 
 Notes

swcgeom/images/folder.py

@@ -1,9 +1,23 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Image stack folder."""
 
 import math
 import os
 import re
-import warnings
 from collections.abc import Callable, Iterable
 from dataclasses import dataclass
 from typing import Generic, Literal, Optional, TypeVar, overload
@@ -11,7 +25,7 @@ from typing import Generic, Literal, Optional, TypeVar, overload
 import numpy as np
 import numpy.typing as npt
 from tqdm import tqdm
-from typing_extensions import Self
+from typing_extensions import Self, deprecated
 
 from swcgeom.images.io import ScalarType, read_imgs
 from swcgeom.transforms import Identity, Transform
@@ -65,6 +79,7 @@ class ImageStackFolderBase(Generic[ScalarType, T]):
         return fs
 
     @staticmethod
+    @deprecated("Use `~swcgeom.images.io.read_imgs(fname).get_full()` instead")
     def read_imgs(fname: str) -> npt.NDArray[np.float32]:
         """Read images.
 
@@ -72,14 +87,6 @@ class ImageStackFolderBase(Generic[ScalarType, T]):
             Use :meth:`~swcgeom.images.io.read_imgs(fname).get_full()` instead.
         """
 
-        warnings.warn(
-            "`ImageStackFolderBase.read_imgs` serves as a "
-            "straightforward wrapper for `~swcgeom.images.io.read_imgs(fname).get_full()`. "
-            "However, as it is not utilized within our internal "
-            "processes, it is scheduled for removal in the "
-            "forthcoming version.",
-            DeprecationWarning,
-        )
         return read_imgs(fname).get_full()
 
 

swcgeom/images/io.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Read and write image stack."""
 
 import os
@@ -12,6 +27,7 @@ import nrrd
 import numpy as np
 import numpy.typing as npt
 import tifffile
+from typing_extensions import deprecated
 from v3dpy.loaders import PBD, Raw
 
 __all__ = ["read_imgs", "save_tiff", "read_images"]
@@ -537,7 +553,7 @@ class TeraflyImageStack(ImageStack[ScalarType]):
             if (invalid := diff > 10 * v).all():
                 return None, None
 
-            diff[invalid] = np.NINF  # remove values which greate than v
+            diff[invalid] = -np.inf  # remove values which greater than v
 
             # find the index of the value smaller than v and closest to v
             idx = np.argmax(diff)
@@ -601,6 +617,7 @@ class GrayImageStack:
         return self.imgs.shape[:-1]
 
 
+@deprecated("Use `read_imgs` instead")
 def read_images(*args, **kwargs) -> GrayImageStack:
     """Read images.
 
@@ -608,9 +625,4 @@ def read_images(*args, **kwargs) -> GrayImageStack:
         Use :meth:`read_imgs` instead.
     """
 
-    warnings.warn(
-        "`read_images` has been replaced by `read_imgs` because it"
-        "provide rgb support, and this will be removed in next version",
-        DeprecationWarning,
-    )
     return GrayImageStack(read_imgs(*args, **kwargs))

swcgeom/transforms/__init__.py

@@ -1,7 +1,23 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """A series of transformations to compose codes."""
 
 from swcgeom.transforms.base import *
 from swcgeom.transforms.branch import *
+from swcgeom.transforms.branch_tree import *
 from swcgeom.transforms.geometry import *
 from swcgeom.transforms.image_preprocess import *
 from swcgeom.transforms.image_stack import *

swcgeom/transforms/base.py

@@ -1,3 +1,18 @@
+# Copyright 2022-2025 Zexin Yuan
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """Transformation in tree."""
 
 from abc import ABC, abstractmethod
@@ -33,7 +48,7 @@ class Transform(ABC, Generic[T, K]):
         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
@@ -48,7 +63,7 @@ class Transform(ABC, Generic[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