Resource.__iter__() produces the wrong type

[igalic]

in implementing #131, i've tried typing this __iter__() method for Resource:

    def __iter__(
        self
    ) -> typing.Generator[Resource, None, None]:

        for child_dataset in self.dataset.children:

            name = self._get_asset_name_from_dataset(child_dataset)
            if self._filters is not None and \
               self._filters.match_key("name", name) is not True:
                # Skip all jails that do not even match the name
                continue

            # ToDo: Do not load jail if filters do not require to
            resource = self._get_resource_from_dataset(child_dataset)
            if self._filters is not None and \
               self._filters.match_resource(resource):
                yield resource  # <= 💣💣💣💣

the 💣 marks where the issue is:

iocage/lib/Resource.py:379:16: error: Incompatible types in "yield" (actual type "Generator[Resource, None, None]", expected type "Resource")

This is caused by the (supposedly abstract;) function _create_resource_instance. In the Jails.py this function returns a Jail (not a JailGenerator) — so, whom do we believe?? ;)

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[gronke]

JailGenerator is correct internally. We only provide a class Jail that wraps JailGenerator to ease using the lib non-async.

[igalic]

the problem is yield, at this point, expects a $Resource, not a $ResourceGenerator, or it won't be able to produce a iterable that __iter__() is supposed to iterate…

[gronke]

Both JailGenerator and Jail are Resources. The return type of _get_resource_from_dataset depends on whether it was called on Jails or JailsGenerator. The interface https://github.com/iocage/libiocage/blob/e683b412e947cb7b078341f6313c2fe16568174f/iocage/lib/Jails.py#L63-L68 is lying when calling Jail._get_resource_from_dataset().

[igalic]

related errors:

iocage/lib/Resource.py:377:15: error: Argument 1 to "match_resource" of "Terms" has incompatible type "Generator[Resource, None, None]"; expected "Resource"
iocage/lib/Resource.py:378:16: error: Incompatible types in "yield" (actual type "Generator[Resource, None, None]", expected type "Resource")
iocage/cli/list.py:115:8: error: Argument 1 to "_print_list" has incompatible type "ReleasesGenerator"; expected "Generator[JailsGenerator, None, None]"
iocage/cli/list.py:117:8: error: Argument 1 to "_print_list" has incompatible type "ReleasesGenerator"; expected "Generator[JailsGenerator, None, None]"
iocage/cli/list.py:119:8: error: Argument 1 to "_print_json" has incompatible type "ReleasesGenerator"; expected "Generator[JailsGenerator, None, None]"
iocage/cli/list.py:121:8: error: Argument 1 to "_print_table" has incompatible type "ReleasesGenerator"; expected "Generator[ListableResource, None, None]"

[gronke]

The PR #131 was fixed and merged.