[Docs] Wrong type for Selection.add_all

[rchl]

Description of the bug

Selection.add_all can also take a Point since it calls Selection.add which takes a point.

    def add(self, x: Region | Point):
        """
        Add a `Region` or `Point` to the selection. It will be merged with the
        existing regions if intersecting.
        """
        if isinstance(x, Region):
            sublime_api.view_selection_add_region(self.view_id, x.a, x.b, x.xpos)
        else:
            sublime_api.view_selection_add_point(self.view_id, x)

    def add_all(self, regions: Iterator[Region]):
        """ Add all the regions from the given iterable. """
        for r in regions:
            self.add(r)

And also, Iterator should be Iterable since List is not a subset of Iterator due to missing the __next__ implementation so passing plain list to add_all will show a type error.

I believe the type should thus be Iterable[Region | Point]

Sublime Text build number

4147

Operating system & version

macOS

[rchl]

Same issue I've just noticed in PhantomSet.update method. It's def update(self, phantoms: Iterator[Phantom]): , should be def update(self, phantoms: Iterable[Phantom]):

[rchl]

Should be a a quick fix.

[rchl]

BTW. It's not only the add_all method. Also update:

And while at it, this also jumps out as wrong:

(Though if we'd apply the strict Pyright checking then there would be much more to report...)

[BenjaminSchaaf]

Fixed in build 4157.

[rchl]

The type of region in Selection.add_all was updated to Iterator[Region | Point] but as I've mentioned in this issue, it's not an Iterator but Iterable. A plain list is not compatible with Iterator type so you can't pass it to add_all which is clearly supported.

And also the same issue applies to: PhantomSet.update.

And the [Phantom] in self.phantoms: [Phantom] = [] is an invalid annotation. Should be List[Phantom]. Unless it is allowed in some latest Python versions but still the more compatible way would be using List.