[typing] prefect.concurrency

[mjpieters]

References #16292

[codspeed-hq]

CodSpeed Performance Report

Merging #16441 will not alter performance

_{Comparing mjpieters:typing_pyright_concurrency (7b725d7) with main (b11b56f)}

Summary

✅ 3 untouched benchmarks

[zzstoatzz]

looking great! holding just for that ruff question and to give @desertaxle a chance to peek at that client context change

[zzstoatzz]

just realizing that prefect.concurrency.asyncio -> prefect.concurrency._asyncio etc would be a breaking change from an imports perspective, which I think we'd have to avoid

[mjpieters]

just realizing that prefect.concurrency.asyncio -> prefect.concurrency._asyncio etc would be a breaking change from an imports perspective, which I think we'd have to avoid

Darn. I'll put the public names from that module back then; until the client flow test failed I wasn't even aware there were other import locations outside of the concurrency package.

[mjpieters]

just realizing that prefect.concurrency.asyncio -> prefect.concurrency._asyncio etc would be a breaking change from an imports perspective, which I think we'd have to avoid

All the public prefect.concurrency.asyncio and prefect.concurrency.v1.asyncio names are firmly back in place, mea culpa!

[desertaxle]

I have two small comments on imports, but otherwise this looks great!

[desertaxle]

Could these lines be simplified to something like this?

from ._asyncio import (
    AcquireConcurrencySlotTimeoutError,
    ConcurrencySlotAcquisitionError,
    aacquire_concurrency_slots,
    arelease_concurrency_slots,
)

[mjpieters]

They could, but the 'import name as name' pattern explicitly marks the name as an export again. This is one way you can tell linters and type checkers an imported name is not unused and public.

The other way is to name the imported symbol in __all__, but that's more tedious as you have to name everything.

Without re-exporting these names they would remain private and lingers fish them as inaccessible if you try to import them from this location.

See the Pyright documentation on typed libraries:

Each module exposes a set of symbols. Some of these symbols are considered “private” — implementation details that are not part of the library’s interface. Type checkers like pyright use the following rules to determine which symbols are visible outside of the package.

• [...]
• Imported symbols are considered private by default. If they use the “import A as A” (a redundant module alias), “from X import A as A” (a redundant symbol alias), or “from . import A” forms, symbol “A” is not private unless the name begins with an underscore.

[desertaxle]

Could you use relative imports here to match prefect.concurrency.asyncio?

from ._asyncio import (
    AcquireConcurrencySlotTimeoutError,
    ConcurrencySlotAcquisitionError,
    acquire_concurrency_slots,
    release_concurrency_slots,
)
from ._events import (
    emit_concurrency_acquisition_events,
    emit_concurrency_release_events,
)
from prefect.concurrency.v1.context import ConcurrencyContext

[mjpieters]

See above: you could but then the name is no longer exported.