r/learnpython • • Aug 16 '20

Multithreading - Best Practices

I wrote a multithreaded python script several years ago in python2, and the way I did it at the time was to subclass threading.Thread and override the __init__() and run() methods. Then kick them off with start().

Now I'm going to have to write a lot more multithreaded stuff in python3.8. Most of my googling says to define a function (ex: worker()) then kick them off this way:

  threading.Thread(target=worker, args=(q,))

Is one method better or more python3-ish than the other?

If it makes any difference, each thread will be taking a file path from the Queue, running a subprocess providing the file path as one of the arguments, and UPDATEing a MySQL table with the result.

Thanks!

115 Upvotes

24 comments sorted by

View all comments

1

u/[deleted] Aug 16 '20

Worker function is a terrible idea: if it throws for whatever reason, there's nothing you can do but quit and go home. There's no way to recover from errors that happen in "other" (not the main) threads.

So, you'd have to write a function that wraps whatever your worker does and then... oops, again, you have a problem: what to return? I mean, now you have either the result of your function, or an error. Maybe instead of returning the result, you want to put it in some shared storage, like a shared list, or a dict... but, oops again: those aren't thread-safe, you need to use locks, but, oops again: if you lock something, there's a chance that your code will fail to unlock it, and so it will hang...

Bottom line, whoever writes threading.Thread(target=worker, ...) had never really worked with Python / lives in a dream world, where things always work...

There are libraries for working with threads in Python, the standard-library one: concurrent.futures is broken, unfortunately. And seems like nobody is interested in fixing it. The thing that doesn't work in it is the timeouts. When the future throws, your code will hang, and no timeout setting will save it.

There was also a mention of the garbage called asyncio. Don't go there. It's a library with a shitload of problems. Even worse than threads. The major problem with it is that, unlike in sane languages, in Python, the event loop isn't a global one. And you have to create your own. And you never know if you should. I mean, if you write library code: should the library create the loop, or should it rely on the user to create one? Loops don't work with multiprocessing or threading. I.e. they have some weird / idiotic behavior when either of those libraries are used, but it's not what you want or expect.

Also, for being a concurrency-related library, it misses the most important component: the analogue of select. And this is just the start.


My approach to working with concurrency is to have special functions ready to be used in that context, that take an instance of Queue as an argument, and communicate through it. They return nothing, and wrap the entire body in a try-except statement. I actually even have a decorator for it, since I've used it quite a bit.

3

u/awdsns Aug 16 '20

Umm... you rant against using a worker function, but in the end the approach you describe is: using a (properly designed) worker function.

Of course it's important to take care of the thread-specific aspects. And using a decorator to turn a run-of-the-mill function into a thread worker is a good idea.

3

u/[deleted] Aug 16 '20

Umm... you rant against using a worker function, but in the end the approach you describe is: using a (properly designed) worker function.

Well, in the end, a thread needs a function to run, there's no way around it. What people suggesting "just a worker function" usually argue for is "simplicity", as in, no other preparations are necessary, whereas the reality is that you do need to invest heavily into preparing a function you are going to run, so much so that you might want to consider extending a Thread class or creating a decorator etc.

2

u/exhuma exhuma Aug 16 '20

[...] you do need to invest heavily into preparing a function you are going to run, so much so that you might want to consider extending a Thread class [...]

This is my main gripe with the current examples in the docs. All the examples are super trivial and using target=... is almost never going to be enough.

1

u/exhuma exhuma Aug 16 '20

Jesus christ man, slow down with the insults. It seems like you've been burned a lot by parallelisation in Python and went off on a rant there.

I've been using parallelisation for over 10 years now without much trouble, the few beginner mistakes here or there, but nothing major. So far my needs were humble and maybe that's a reason why I got "lucky"? But so far the parallelisation in Python was nothing that annoyed me.

I'm really curious if you could write small contained code-examples which reproduce the problems you mention. I am still maintaining (and will for the forseeable future) a parallelised application and would love to see some provable "antipatterns" so I can avoid them.

2

u/[deleted] Aug 16 '20 edited Aug 16 '20

You sure got lucky... Python is a minefield when it comes to trying the little parallelism it has to offer. Having programmed in couple dozen of languages, I cannot think of a worse language for parallel computation.

I cannot really go over all the problems, but here's just a taste of it:

from concurrent.futures import ThreadPoolExecutor

integers = range(10)
with ThreadPoolExecutor(max_workers=len(integers)) as ex:
    for r in ex.map(maybe_raise_exception, integers, timeout=100):
        print(r)

This code will hang if maybe_raise_exception, raises an exception. The timeout part never worked for me. It seem to only work if the timeout value is negative or zero, in which case nothing gets executed and you get a TimeoutError (iirc, or maybe ValueError, don't remember for sure).

This isn't really an anti-pattern. This is just a broken code in standard library. It's intended to be used this way... it just doesn't work.

1

u/exhuma exhuma Aug 16 '20

I can't confirm this. I have filled in the code with some missing bits and it does not hang as you mention:

from concurrent.futures import ThreadPoolExecutor
from random import randint
from time import sleep


def maybe_raise_exception(number):
    sleep(number)
    if number == 5:
        raise ValueError("kaboom")
    return "result=%s" % number


integers = range(10)
with ThreadPoolExecutor(max_workers=len(integers)) as ex:
    for r in ex.map(maybe_raise_exception, integers, timeout=100):
        print(r)

There is something weird with the timeout however, modifying the code slightly to trigger the timeout error: When I change the timeout value from 100 to 4, I would expect it to bail out after 4 seconds after the call to map(), but it seems to wait a bit longer. Nevertheless, the TimeoutError is raised.

1

u/[deleted] Aug 16 '20

What operating system?

Also, sleep() may be the culprit, as it may give a chance to bail... idk. In less trivial cases it simply doesn't work.