Task.map interaction with optional arguments

Archive
, ,
1

For mapped tasks with optional single value arguments is it intended to have to wrap the optional argument values with unmapped as shown below? It seems unintuitive to have to set the unmapping on the task when it can be invoked with or without .map. Also, the unmapped optional task parameter forces the task to be invoked with .map or it fails.

from typing import List
from prefect import task, flow
from prefect.utilities.annotations import unmapped

@task
def mytask(x: int, y: int = unmapped(5)) -> int:
    return x + y

@flow
def myflow(c: int) -> List[int]:
    return mytask.map(list(range(c)))

if __name__ == "__main__":
    res = myflow(4)
    print(res)
2

Is there some specific question do you want to ask in this thread? The purpose of unmapped is to supply additional arguments to the map function which should not be mapped over. Without it you would only be able to call a task with the arguments that provide an iterable, no extra static arguments would be allowed.

3

Understood, the question is why do I have to put the unmapped in the @task / function definition for my example to work?

4

to provide non-mapped arguments, check those docs, it should make it clearer:

5

Yes I read that, it doesn’t cover this scenario where the task function definition has an optional argument with a default value. Let me contrast with how this works in v1 and maybe that helps clarify the question/issue.

from typing import List
from prefect import task, Flow, unmapped

@task
# NOTE that unmapped(5) is not needed on the y optional input
# to make this work in v1
def mytask(x: int, y: int = 5) -> int: 
    return x + y

if __name__ == "__main__":
    with Flow("MyFlow") as flow:
        mytask.map(list(range(4)))

    state = flow.run()
    print(state.result[flow.get_tasks()[0]].result)
6

so you mean that the default value must still be explicitly passed, otherwise mapping fails? if so, this is more a candidate for a GitHub issue, feel free to create one

7

Yes, default must be explicitly passed or I have to apply unmapped on it at the task level as a workaround. I’ll open an issue on GH, thanks.