Skip to content

Instantly share code, notes, and snippets.

@kgaughan
Created June 10, 2013 16:13
Show Gist options
  • Save kgaughan/5750023 to your computer and use it in GitHub Desktop.
Save kgaughan/5750023 to your computer and use it in GitHub Desktop.
All the thread pool mixins for SocketServer are, well, not that good, so I knocked together my own. This one can cleanly shut down the pool
"""
Thread pool extensions to SocketServer.
"""
import Queue
import SocketServer
import sys
import threading
class ThreadPoolMixin:
"""
Mixin to use a fixed pool of threads to handle requests.
.. note::
When shutting down the server, please ensure you call this mixin's
`join()` to shut down the pool along with the server's `shutdown()`
method. The order in which these are performed is not significant,
but both actions must be performed.
"""
# Size of pool.
pool_size = 5
# How long to wait on an empty queue, in seconds. Can be a float.
timeout_on_get = 0.5
def __init__(self):
self._request_queue = Queue.Queue(self.pool_size)
# This beastie serves a different purpose than __shutdown_request
# and __is_shut_down: those are superprivate so we can't touch them,
# and even if we could, they're not really useful in shutting down
# the pool.
self._shutdown_event = threading.Event()
for _ in xrange(self.pool_size):
thread = threading.Thread(target=self.process_request_thread)
thread.setDaemon(1)
thread.start()
def process_request_thread(self):
"""Same as in BaseServer, but as a thread."""
while True:
try:
request, client_address = self._request_queue.get(
timeout=self.timeout_on_get,
)
except Queue.Empty:
# You wouldn't believe how much crap this can end up leaking,
# so we clear the exception.
sys.exc_clear()
if self._shutdown_event.isSet():
return
continue
try:
self.finish_request(request, client_address)
self.shutdown_request(request)
except:
self.handle_error(request, client_address)
self.shutdown_request(request)
self._request_queue.task_done()
def process_request(self, request, client_address):
"""Queue the given request."""
self._request_queue.put((request, client_address))
def join(self):
"""Wait on the pool to clear and shut down the worker threads."""
# A nicer place for this would be shutdown(), but this being a mixin,
# that method can't safely do anything with that method, thus we add
# an extra method explicitly for clearing the queue and shutting
# down the workers.
self._request_queue.join()
self._shutdown_event.set()
class ThreadPoolTCPServer(ThreadPoolMixin, SocketServer.TCPServer):
"""Implementation of TCPServer with a thread pool for incoming requests."""
def __init__(self, server_address, request_class, bind_and_activate=True):
ThreadPoolMixin.__init__(self)
SocketServer.TCPServer.__init__(
self,
server_address,
request_class,
bind_and_activate)
class ThreadPoolUDPServer(ThreadPoolMixin, SocketServer.UDPServer):
"""Implementation of UDPServer with a thread pool for incoming requests."""
def __init__(self, server_address, request_class):
ThreadPoolMixin.__init__(self)
SocketServer.UDPServer.__init__(self, server_address, request_class)
@consen
Copy link

consen commented Nov 10, 2016

Thanks

Copy link

ghost commented Feb 8, 2021

I'm new to networking with python, and i was researching threading and queuing with ThreadingMixIn and i found your gist. I was wondering, why did you create a pool? is creating a new thread for every request a bad practice?
Thanks in advance...

@kgaughan
Copy link
Author

Yes, creating a thread for every request isn't a great idea, and not for reasons to do with networking. It's expensive in terms of memory, especially if the server is under load. While Python uses reference counting to help release resources as quickly as possible, the threads and the resources associated with them can hang around much longer than you might like. There's also the startup and teardown cost associated with each thread, which, while not the same as forking a whole process, is still not cheap. It also increases the likelihood that you'll end up with some kind of resource starvation, be it due to lock contention or some other issues. You're best off limiting the number of threads to some fixed multiple of the number of available cores.

ThreadingMixIn is intended for simple servers. This mixin is a simplified version of a thread pool mixin was intended for something that got an awful lot of traffic.

The the full implementation, the thread pool size was configurable, and only spun up threads on demand if the queue reached a certain size. It also has a bunch of other optimisations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment