iro/controller/pool.py
author Sandro Knauß <bugs@sandroknauss.de>
Tue, 15 Apr 2025 01:22:19 +0200
changeset 316 63c681b8e92c
parent 294 0e75bd39767d
permissions -rw-r--r--
fix link to about.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
294
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     1
# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net>
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     2
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     3
# This file is part of Iro.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     4
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     5
# Permission is hereby granted, free of charge, to any person obtaining a copy of
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     6
# this software and associated documentation files (the "Software"), to deal in
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     7
# the Software without restriction, including without limitation the rights to use,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     8
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
     9
# #Software, and to permit persons to whom the Software is furnished to do so,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    10
# subject to the following conditions:
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    11
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    12
# The above copyright notice and this permission notice shall be included in
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    13
# all copies or substantial portions of the Software.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    14
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    15
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    16
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    17
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    18
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    19
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    20
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 264
diff changeset
    21
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
from twisted.python.threadpool import ThreadPool
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
from twisted.internet import threads
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
class Pool:
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    26
    """wrapper class to handles a twisted threadpool"""
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
    def __init__(self,name,maxthreads):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    28
        """
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    29
        :param string name: name of the threadpool
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    30
        :param integer maxthreads: how many thread a allowed at maximum
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    31
        """
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
        self.maxthreads = maxthreads
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
        self.pool =  ThreadPool(minthreads=1, maxthreads=maxthreads, name=name)
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    34
        self.reactor = None
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
    def start(self, reactor):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    37
        """stats the pool and adds the pool.stop function to the stop procedure.
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    38
        
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    39
        :param reactor: a valid twisted reactor
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    40
        """
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    41
        self.pool.start()
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    42
        self.reactor = reactor
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    43
        self.reactor.addSystemEventTrigger('before', 'shutdown', self.pool.stop)
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
    def run(self,f,*args,**kwargs):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    46
        """run a function in Twisted's thread pool"""
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    47
        return threads.deferToThreadPool(self.reactor, self.pool, f, *args, **kwargs)
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
taskPool = Pool('task',5)
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    50
"""taskpool to handle sending data"""
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 132
diff changeset
    51
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
dbPool = Pool('database',5)
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    53
"""pool to handle database connection via sqlalchemy""" 
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
pools=[taskPool,dbPool]
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    56
"""all available pools"""
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    58
def startPool(reactor):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    59
    '''run start function for all items in :attr:`pools`'''
132
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
    for pool in pools:
80a334e2aae7 moving pool to controller
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
        pool.start(reactor)
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    62
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
    63
__all__=["Pool", "startPool", "dbPool", "taskPool", "pools"]