7 ms·
Exactly-Once Initialization in Asynchronous Python
- cheez 6y agoBeen coming across lot of these issues. Asyncio requires slightly different thought processes. As soon as you have an `await` anywhere in the code, you've got to assume that your code will be re-entered. Lots of asyncio.Locks all over the place for me. Glad people are bringing this up. I had to learn this on my own.
- pansa2 6y ago> As soon as you have an `await` anywhere in the code, you've got to assume that your code will be re-entered. At least the re-entry points are explicitly marked with `await`. IMO that's the main benefit of async-await (stackless coroutines) over stackful coroutines or threads, which allow your code to be suspended and re-entered almost anywhere. Of course the drawback of async-await is the "function color" issue [0], in which it's difficult for functions that don't suspend to call those which do. [0] http://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function/ http://journal.stuffwithstuff.com/2015/02/01/what-color-is-y...
- cheez 6y agoThat's a good perspective.
- nurettin 6y agoI've wrestled with this. A cleaner solution seems to be: using an asyncio.Queue. So when your function is not reentrant, params = await command.get() runs in a loop inside a task ( command.put_nowait(params) is called elsewhere) you can also use this to distribute tasks to different class methods
- cheez 6y agoI will keep this in mind!
- alpineidyll3 6y agoEvery time I find something that seems unnecessarily awk in asyncio, I eventually find out there's a good reason. But plenty of things that are written with it aren't using it exactly right.
- mgraczyk 6y agoIf you're using cpython since python 3.2, you don't need to lock. You can use `dict.setdefaut` or another similar method that is guaranteed to be atomic. initialized = D.setdefault('initialized', True) ...
- 6a74 6y agoNeat. I was going to ask for a source saying that `dict.setdefault` is atomic, but I found it myself: Ticket: https://bugs.python.org/issue13521 https://bugs.python.org/issue13521 Patch: https://hg.python.org/cpython/rev/90572ccda12c https://hg.python.org/cpython/rev/90572ccda12c
- sicromoft 6y agodict.setdefault doesn’t solve the problem that he’s using the lock for (atomicity is not the problem).
- mgraczyk 6y agoSomething like this should work, no? Only run the coroutine if you won the race. D = {} async def maybe_initialize(): global D this_setup = asyncio.ensure_future(one_time_setup()) actual_setup = D.setdefault('initializer', this_setup) if this_setup is not actual_setup: this_setup.cancel() await actual_setup return complete example: https://gist.github.com/mgraczyk/e251443bccfe54505e75b6526550c113 https://gist.github.com/mgraczyk/e251443bccfe54505e75b652655...
- sicromoft 6y agoI think something might be off in your mental model of python coroutines. They work via cooperative multitasking. Atomic operations aren't really necessary or relevant in such a system where you are in complete control of all yield points (i.e., calls to `await`). If you read the full blog post, the author solves the problem without setdefault, and without having to cancel any futures.
- 6y ago
- smabie 6y agoHow about we just use actors instead? Preemptable actors are the only good concurrency model I've ever come across. Everything else has massive problems
- mgraczyk 6y agoAsync await scales well to codebases with millions of lines and thousands of developers. As a result, large companies and ecosystems have mostly adopted async/await and the tooling and runtimes in those languages is now much more mature.
- pansa2 6y ago> Async await scales well to codebases with millions of lines Interesting - do you think there's a better solution than async-await for smaller codebases?
- CraigJPerry 6y agoActors aren’t a panacea either - your logic ends up more spread out. You’re still able to shoot yourself in the foot quite easily too, e.g. when deciding whether to use a “pull” or “push” model for concurrency. I found async testing in python to be annoying, although i found a couple of libraries to make it nicer (pytest-async and i forget the name of the other).
- odiroot 6y agoI never understood this whole "actor" thing until I had to write an extension for Mopidy. Then it really clicked with me. It's very boilerplate-y (Mopidy uses Pykka) though and takes some time getting used to coming from other frameworks.
- rburhum 6y agoI would add a note that if you are running in a cluster environment like Kubernetes this won’t work because your containers would be running potentially in different machines. In those scenarios you would need another service just for the locks.
- jordic 6y agoOn k8s, for example running multiple parallel jobs that need to initialize only once, It used to work for me the redis redlock (it's around with multiple implementations). The first job takes the lock while initializing, the rest just waits the release, to start working on prepared items by the first. On asyncio, caches, we used a lock to prevent dogpiling on cache initialization.. prevent multiple tasks cashing the same in parallel.
- alexchamberlain 6y agoI'd just call the function once by avoiding the global; construct your database access object at the start of your asynchronous main method and dependency inject it to other tasks.
- orf 6y agoThis. Your code often becomes easier to read and test as well.
- np_tedious 6y agoCan you clarify what you mean by dependency injection in python? Did you mean a DI framework or something more informal? I've seen DI frameworks in python but not really used them. At a glance they don't strike me as pythonic. Rolling your own kind of inversion of control can result in unruly "config" or "context" objects that bring difficulties as well.
- oweiler 6y agoPass the fully constructed object as parameter. No need for a DI framework.
- idclip 6y agoI must say i havnt done any dependency injection in python. Did so in scala and JS though. So i assume he means initilize it once in program entry and Pass in the pointer to the object that needs it via including it the constructor or a function call. Do you think There’s a pythonic way of doing these things?
- fulafel 6y agoDI is just a convoluted synonym for passing in arguments.
- alexchamberlain 6y agoIndeed. If you want it to be cleaner, a discipline of constructor arguments for injection and __call__ arguments for semantic input is really all you need.
- natch 6y agoTrying out the last snippet. What am I doing wrong here? Python 3.7.7 https://pastebin.com/E9KWCmky https://pastebin.com/E9KWCmky
- zeronone 6y agoIndentation is wrong in following statement ``` return once_wrapper ```
- natch 6y agoDuh, thanks! Now I have a new one but I think it just means the script needs to stay running longer so the coroutine can have time to do its thing. ./once.py:29: RuntimeWarning: coroutine 'once. <locals>.once_wrapper' was never awaited one_time_setup()
- prashnts 6y agoYour main function needs to be async as well, since the one_time_setup is async. Linking this SO answer that also links to the docs (may come handy!). https://stackoverflow.com/questions/57399157/runtimewarning-coroutine-main-was-never-awaited https://stackoverflow.com/questions/57399157/runtimewarning-... Edit: Also tangentially relevant is the article linked by pansa2 in another thread, which was also discussed on HN a few months ago: http://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function/ http://journal.stuffwithstuff.com/2015/02/01/what-color-is-y...
- natch 6y agoThanks!
- Bloggerzune 6y agoI think something might be off in your mental model of python coroutines. They work via cooperative multitasking. Atomic operations aren't really necessary or relevant in such a system where you are in complete control of all yield points (i.e., calls to `await`). If you read the full blog post, the author solves the problem without setdefault, and without having to cancel any futures. https://www.bloggerzune.com/2020/06/Off-page-seo.html?m=1 https://www.bloggerzune.com/2020/06/Off-page-seo.html?m=1 Every time I find something that seems unnecessarily awk in asyncio, I eventually find out there's a good reason. But plenty of things that are written with it aren't using it exactly right.
- reedwolf 6y ago>"global" Please write classes, people!
- zbentley 6y agoWhy? To hide the fact that something is global behind mutation by reference? "global" is a fine way to do that when you need it. Simple and says what it means.
- OrangeTux 6y ago> Unfortunately this has a serious downside: asyncio locks are associated with the loop where they were created. Since the lock variable is global, maybe_initialize() can only be called from the same loop that loaded the module. asyncio.run() creates a new loop so it’s incompatible. I work on several async projects, but I never had to use multiple event loops. What are use cases for using multiple event loops?
- itayperl 6y agoThere may be other use cases, but it can be a useful pattern for mixing async code into a non-async project. In the specific places where using async for some task makes sense, you would just spawn a thread with an event loop, then push work into the new loop from non-async code using run_coroutine_threadsafe.
- nhumrich 6y agoThis can be a lot simpler. Just set "one_time_setup" to a single instance of the method, and all calls are waiting for the exact same run. If that doesnt work, then set it to an 'asyncio.event`, and run the one_time_setup "in the background" (create_task), and when its done it marks the event as complete.
- waterside81 6y agoGo offers this out of the box via the sync.Once function. Do other languages? Kind of surprised python doesn’t as this sort of pattern is common in applications dealing with concurrency
- ninkendo 6y agoApple’s Grand Central Dispatch concurrency library has dispatch_once [0], which does something similar. It relies on non-standard “block” extensions to C, which are a way of defining lambda functions, and in practice you only see it used in Apple platforms. [0] https://developer.apple.com/documentation/dispatch/1447169-dispatch_once https://developer.apple.com/documentation/dispatch/1447169-d...
- fishywang 6y agolazy init in kotlin and scala is essentially the same thing. the good thing with go's sync.Once is that it's implemented as a library instead of something in the language itself, so it's easy for curious user to see how it's actually implemented. they even have comments there pointing out wrong implementations, which I have seen people make the exact same mistake during code reviews (in other language).
- dnautics 6y agoErlang has features for this baked in. What's more, if initialization of any subcomponent fails (say one of its dependencies hadn't completed booting yet due to race condition), if the author made it throw, the dependent subcomponent will automatically restart itself and try again. There are also one line strategies for trying again later, etc, so you don't even have to worry about blocking to prevent those race conditions. > Kind of surprised python doesn’t as this sort of pattern is common in applications dealing with concurrency Well yeah, python was not designed for that.
- lmeyerov 6y agoThere is more than one way to make awaitables in asyncio -- at the core, this is about sharing a single future, for which there's a joyfully boring native standard constructor. For example, when working w/ immutable GPU dataframes to represent our user's datasets, we often get into variants where loading a dataset may take a bit and thus get multiple services requesting it before ETL is done. So, we want to only trigger the parser once per file and have any subsequent calls wait on the first one: datasets = {} async def load_once(name): if not (name in datasets): # sync, many fut = asyncio.create_future() # sync, once datasets[name] = fut # sync, once fut.set_result(await load(name)) # async, once return await datasets[name] # async, many And then throw in an async lru.. :)
- jaen 6y agoUnfortunately, this naive method is buggy, I have had to debug and fix this exact code in production :) The issue is with exception safety - first, this does not handle exceptions in load() properly, but that is a trivial fix. The more insidious problem is due to the fact that Python future are cancellable - and exceptions cancel futures. What this means is that if two callers call load_once() in parallel, and the first caller encounters an exception (eg. from calling something else in parallel), the load() future will be cancelled for _all_ callers (eg. the second one), and will remain in a permanently wedged state. Fixing that is, well, quite a bit more code...
- lmeyerov 6y agoYep, we see the same, good to point out! So load() needs a try/except, and except is either kill process / retry / clear / cancel, and the other loader should also expect an exn depending on that choice. All of that is app/use-case dependent. Usefully, Futures and async/await natively represent most of these. The case we find missing is around back pressure, retry, etc., but I haven't seen a good lang construct for that. We used to do a lot of Rx for that, and now a lot of HTTP headers/libs when a remote call, but it all feels messy. This is somewhat orthogonal to futures for load once tho.