├── .coveragerc ├── .github └── workflows │ ├── mypy.yml │ ├── publish_package.yml │ └── unittests.yml ├── .gitignore ├── LICENSE ├── README.md ├── bucketratelimiter ├── __init__.py ├── bucket_rate_limiters │ ├── __init__.py │ ├── asyncio_bucket.py │ ├── bucket_abc.py │ └── mthreaded_bucket.py └── version.py ├── examples ├── __init__.py ├── asyncio_complete_example.py └── multithreading_complete_example.py ├── setup.py └── tests ├── __init__.py ├── test_asyncio_bucket.py └── test_mthreaded_bucket.py /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | source = bucketratelimiter 3 | branch = TRUE 4 | parallel = TRUE 5 | omit = tests/* , bucketratelimiter/version.py 6 | 7 | [report] 8 | show_missing = True 9 | exclude_lines = 10 | # default 11 | pragma: no cover 12 | # python debug/internals 13 | def __repr__ 14 | if __debug__: 15 | assert 16 | raise AssertionError 17 | raise NotImplementedError 18 | return NotImplemented 19 | if __name__ == "__main__" 20 | if __name__ == '__main__' 21 | @overload 22 | @abstractmethod 23 | if TYPE_CHECKING -------------------------------------------------------------------------------- /.github/workflows/mypy.yml: -------------------------------------------------------------------------------- 1 | name: MyPy 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v3 16 | - name: Set up Python 3.9 17 | uses: actions/setup-python@v4 18 | with: 19 | python-version: '3.9' 20 | - name: Install dependencies 21 | run: | 22 | python -m pip install --upgrade pip 23 | pip install .[develop] 24 | - name: MyPy test 25 | run: | 26 | mypy --strict bucketratelimiter -------------------------------------------------------------------------------- /.github/workflows/publish_package.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | deploy: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v3 12 | - name: Set up Python 13 | uses: actions/setup-python@v4 14 | with: 15 | python-version: '3.9' 16 | - name: Install dependencies 17 | run: | 18 | python -m pip install --upgrade pip 19 | pip install build 20 | - name: Build package 21 | run: python -m build 22 | - name: Publish package 23 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 24 | with: 25 | user: __token__ 26 | password: ${{ secrets.PYPI_API_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/unittests.yml: -------------------------------------------------------------------------------- 1 | name: UNITTESTS 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"] 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | - name: Set up Python ${{ matrix.python-version }} 20 | uses: actions/setup-python@v4 21 | with: 22 | python-version: ${{ matrix.python-version }} 23 | - name: Install dependencies 24 | run: | 25 | python -m pip install --upgrade pip 26 | pip install .[develop] 27 | - name: Test with pytest 28 | run: | 29 | pytest --durations=0 --cov=bucketratelimiter 30 | - name: Upload coverage to Codecov 31 | uses: codecov/codecov-action@v1 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) 2 | [![UNITTESTS](https://github.com/ArtyomKozyrev8/BucketRateLimiter/actions/workflows/unittests.yml/badge.svg)](https://github.com/ArtyomKozyrev8/BucketRateLimiter/actions/workflows/unittests.yml) 3 | [![codecov](https://codecov.io/gh/ArtyomKozyrev8/BucketRateLimiter/branch/main/graph/badge.svg?token=7LHFJ0UJYQ)](https://codecov.io/gh/ArtyomKozyrev8/BucketRateLimiter) 4 | [![MyPy](https://github.com/ArtyomKozyrev8/BucketRateLimiter/actions/workflows/mypy.yml/badge.svg)](https://github.com/ArtyomKozyrev8/BucketRateLimiter/actions/workflows/mypy.yml) 5 | 6 | # BucketRateLimiter 7 | 8 | **BucketRateLimiter** is the collection of rate limiters, which are based on **Bucket** conception. 9 | 10 | Rate Limiters are used when you want some function to be executed the concrete amount of times per time unit. 11 | The most widespread use case of Rate Limiters is when you use external APIs, e.g. website API. Some websites allows 12 | to make only a limited number of requests per second and Rate Limiters solves the issue. 13 | 14 | 15 | ### How to install: 16 | 17 | `pip install bucketratelimiter` 18 | 19 | ### Examples: 20 | 21 | You can find complete examples on how to use `AsyncioBucketTimeRateLimiter` and `MThreadedBucketTimeRateLimiter` in 22 | folder **examples** of this repository. Also you can check **tests** folder and get some tricks from unittests. 23 | 24 | ### How to use: 25 | 26 | ##### Create rate limiter: 27 | 28 | ```python 29 | from bucketratelimiter import AsyncioBucketTimeRateLimiter 30 | 31 | # max_size = 4 and recovery_time = 1.0 32 | # means that we would like to limit something to 4 attempts per second 33 | # max_size - is a size of internal bucket 34 | # recovery_time - time to make bucket full again 35 | # rest_time - is the time to sleep for workers which can not proceed further due to rate limiter 36 | # callback - is a function which should be called after task will be completed 37 | ASYNC_LIMITER = AsyncioBucketTimeRateLimiter( 38 | max_size=4, 39 | recovery_time=1.0, 40 | rest_time=0.2, 41 | callback=None, 42 | ) 43 | ``` 44 | 45 | ```python 46 | from bucketratelimiter import MThreadedBucketTimeRateLimiter 47 | 48 | ASYNC_LIMITER = MThreadedBucketTimeRateLimiter( 49 | max_size=4, 50 | recovery_time=1.0, 51 | rest_time=0.2, 52 | callback=None, 53 | ) 54 | ``` 55 | 56 | ##### "Wrap" some function in ratelimiter: 57 | 58 | ```python 59 | import asyncio 60 | from bucketratelimiter import AsyncioBucketTimeRateLimiter 61 | 62 | limiter = AsyncioBucketTimeRateLimiter() 63 | 64 | @limiter # we use decorator to limit the function to a certain number of attempts per second 65 | async def some_func_to_limit(sleep_time: float = 1.0) -> None: 66 | await asyncio.sleep(sleep_time) 67 | ``` 68 | 69 | 70 | ```python 71 | import time 72 | from bucketratelimiter import MThreadedBucketTimeRateLimiter 73 | 74 | limiter = MThreadedBucketTimeRateLimiter() 75 | 76 | @limiter # we use decorator to limit the function to a certain number of attempts per second 77 | def some_func_to_limit(sleep_time: float = 1.0) -> None: 78 | time.sleep(sleep_time) 79 | ``` 80 | 81 | ##### Activate ratelimiter logic: 82 | 83 | ```python 84 | limiter = AsyncioBucketTimeRateLimiter() 85 | 86 | async def main_entry_point() -> None: 87 | """Main entry point of our asyncio app.""" 88 | q = asyncio.Queue() 89 | for task in TASKS_TO_COMPLETE: 90 | await q.put(task) 91 | 92 | # use LIMITER as context manager to ensure its correct activation and end of work 93 | async with limiter: 94 | for w in [worker(q) for _ in range(1, WORKER_NUM + 1)]: 95 | asyncio.create_task(w) 96 | 97 | await q.join() 98 | ``` 99 | 100 | ```python 101 | limiter = MThreadedBucketTimeRateLimiter() 102 | 103 | def main_entry_point() -> None: 104 | """Main entry point of our multithreading app.""" 105 | q = Queue() 106 | for task in TASKS_TO_COMPLETE: 107 | q.put(task) 108 | 109 | # use LIMITER as context manager to ensure its correct activation and end of work 110 | with LIMITER: 111 | for _ in range(1, WORKER_NUM + 1): 112 | Thread(target=worker, args=(q, ), daemon=True).start() 113 | 114 | q.join() 115 | ``` 116 | 117 | ### HOW TO USE LOW LEVEL API: 118 | 119 | ##### Use without context manager: 120 | 121 | ```python 122 | # Use RateLimiter's method to activate and deactivate it's inner logic 123 | # instead of using context managers 124 | try: 125 | limiter.activate() 126 | finally: 127 | limiter.deactivate() 128 | ``` 129 | 130 | ##### Use without functions decoration: 131 | 132 | ```python 133 | import asyncio 134 | from bucketratelimiter import AsyncioBucketTimeRateLimiter 135 | 136 | limiter = AsyncioBucketTimeRateLimiter() 137 | 138 | async def some_func_to_limit(sleep_time: float = 1.0) -> None: 139 | await asyncio.sleep(sleep_time) 140 | ... 141 | async with limiter: 142 | await limiter.wrap_operation(some_func_to_limit, sleep_time=1.0) 143 | 144 | # ATTENTION ! 145 | # Do not use wrap_operation to some function more than once 146 | # Do not apply decorator to some function if you use wrap_operation 147 | # It can lead to unexpected results 148 | ``` 149 | 150 | ```python 151 | import time 152 | from bucketratelimiter import MThreadedBucketTimeRateLimiter 153 | 154 | limiter = MThreadedBucketTimeRateLimiter() 155 | 156 | def some_func_to_limit(sleep_time: float = 1.0) -> None: 157 | time.sleep(sleep_time) 158 | ... 159 | with limiter: 160 | limiter.wrap_operation(some_func_to_limit, sleep_time=1.0) 161 | ``` 162 | 163 | ### FOR CONTRIBUTORS: 164 | 165 | Clone the project: 166 | ```commandline 167 | https://github.com/ArtyomKozyrev8/BucketRateLimiter.git 168 | cd BucketRateLimiter 169 | ``` 170 | Create a new virtualenv: 171 | ```commandline 172 | python3 -m venv env 173 | source env/bin/activate 174 | ``` 175 | Install all requirements: 176 | ```commandline 177 | pip install -e '.[develop]' 178 | ``` 179 | 180 | **Run Tests:** 181 | 182 | 183 | ```commandline 184 | mypy --strict bucketratelimiter 185 | 186 | pytest --cov=bucketratelimiter tests/ 187 | 188 | coverage report 189 | 190 | coverage html 191 | ``` 192 | -------------------------------------------------------------------------------- /bucketratelimiter/__init__.py: -------------------------------------------------------------------------------- 1 | from .bucket_rate_limiters import ( 2 | AsyncioBucketTimeRateLimiter, 3 | MThreadedBucketTimeRateLimiter, 4 | ) 5 | 6 | __all__ = [ 7 | "AsyncioBucketTimeRateLimiter", 8 | "MThreadedBucketTimeRateLimiter", 9 | ] 10 | -------------------------------------------------------------------------------- /bucketratelimiter/bucket_rate_limiters/__init__.py: -------------------------------------------------------------------------------- 1 | from .asyncio_bucket import AsyncioBucketTimeRateLimiter 2 | from .mthreaded_bucket import MThreadedBucketTimeRateLimiter 3 | 4 | 5 | __all__ = [ 6 | "AsyncioBucketTimeRateLimiter", 7 | "MThreadedBucketTimeRateLimiter", 8 | ] 9 | -------------------------------------------------------------------------------- /bucketratelimiter/bucket_rate_limiters/asyncio_bucket.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from functools import wraps 3 | from typing import Any, Awaitable, Callable, Coroutine, Optional, Union 4 | 5 | from .bucket_abc import AsyncTimeRateLimiterABC, BucketTimeRateLimiterABC 6 | 7 | AsyncFuncType = Callable[..., Union[Awaitable, Coroutine]] 8 | 9 | 10 | class AsyncioBucketTimeRateLimiter(BucketTimeRateLimiterABC, AsyncTimeRateLimiterABC): 11 | def __init__( 12 | self, 13 | max_size: int = 4, 14 | recovery_time: float = 1.0, 15 | rest_time: float = 0.2, 16 | callback: Optional[Callable[..., Any]] = None, 17 | ) -> None: 18 | self.max_size: int = max_size 19 | self.active_slots: int = max_size # number of active slots at the moment 20 | self.recovery_time: float = recovery_time 21 | self.rest_time: float = rest_time 22 | # used to signal "external" workers that bucket is "empty" 23 | self.event_bucket_empty: asyncio.Event = asyncio.Event() 24 | # separate asyncio task to return bucket to full size 25 | self.reactivate_task: Optional[asyncio.Task[Any]] = None 26 | self.callback: Optional[Callable[..., Any]] = callback 27 | 28 | def _decrement(self) -> None: 29 | if self.active_slots > 0: 30 | self.active_slots -= 1 31 | 32 | async def _reactivate_slots(self) -> None: 33 | while True: 34 | await asyncio.sleep(self.recovery_time) 35 | self.active_slots = self.max_size 36 | self.event_bucket_empty.set() 37 | 38 | async def wrap_operation(self, func: AsyncFuncType, *args: Any, **kwargs: Any) -> Any: 39 | while True: 40 | if self.event_bucket_empty.is_set(): # if bucket is not empty do work 41 | if self.active_slots == 0: 42 | self.event_bucket_empty.clear() 43 | else: 44 | self._decrement() 45 | res = await func(*args, **kwargs) 46 | if self.callback is not None: 47 | self.callback() 48 | return res 49 | else: 50 | await asyncio.sleep(self.rest_time) 51 | 52 | def activate(self) -> None: 53 | if self.reactivate_task is None: # prevents creation of several activate tasks 54 | self.event_bucket_empty.set() # set event flag that bucket is ready 55 | self.reactivate_task = asyncio.ensure_future(self._reactivate_slots()) 56 | 57 | def deactivate(self) -> None: 58 | if self.reactivate_task is not None: 59 | if self.reactivate_task.done() is False: 60 | try: 61 | self.reactivate_task.cancel() 62 | except asyncio.CancelledError: # pragma: no cover 63 | pass 64 | 65 | def __call__(self, f: AsyncFuncType) -> AsyncFuncType: 66 | @wraps(f) 67 | async def wrapper(*args: Any, **kwargs: Any) -> Any: 68 | self.activate() 69 | return await self.wrap_operation(f, *args, **kwargs) 70 | 71 | return wrapper 72 | 73 | async def __aenter__(self) -> "AsyncioBucketTimeRateLimiter": 74 | self.activate() 75 | return self 76 | 77 | async def __aexit__(self, exc_type: Any, exc: Any, tb: Any) -> None: 78 | self.deactivate() 79 | -------------------------------------------------------------------------------- /bucketratelimiter/bucket_rate_limiters/bucket_abc.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from typing import Any, Callable, Optional 3 | 4 | 5 | class BucketTimeRateLimiterABC(ABC): 6 | @abstractmethod 7 | def __init__( 8 | self, 9 | max_size: int, 10 | recovery_time: float, 11 | rest_time: float, 12 | callback: Optional[Callable[..., Any]], 13 | ) -> None: 14 | """ 15 | BucketRateLimiter is used to limit number of "simultaneous" operations to the specified number. 16 | e.g. some external API allows you to make only 4 requests per second. 17 | BucketRateLimiter can help to achieve the goal. 18 | :param max_size: max size of Bucket. Should be positive integer number. 19 | This is the maximum number of operations (e.g. requests) you can launch in the provided time 20 | interval (recovery_time). 21 | e.g. API allows you to make 4 requests per second, hereby max_size = 4 22 | :param recovery_time: time in seconds to recover Bucket to full size. 23 | e.g. API allows to make 4 requests per second, hereby recovery_time = 1.0 24 | :param rest_time: time to give "workers" who use bucket to sleep if bucket is empty at the moment. 25 | BucketRateLimiter deliberately does not use any internal pool of workers to make 26 | it responsibility of user how to implement "workers" 27 | :param callback: not "awaitable" function which is called when any of workers have finished task. 28 | """ 29 | ... 30 | 31 | @abstractmethod 32 | def _decrement(self) -> None: 33 | """Decrements internal counter self.active_slots by one.""" 34 | ... 35 | 36 | @abstractmethod 37 | def activate(self) -> None: 38 | """The method "activates" BucketRateLimiter internal logic.""" 39 | ... 40 | 41 | @abstractmethod 42 | def deactivate(self) -> None: 43 | """The method stops self.reactivate_task operations.""" 44 | ... 45 | 46 | @abstractmethod 47 | def __call__(self, f: Any) -> Any: 48 | """The method is created in order to use BucketRateLimiter instance as decorator.""" 49 | ... 50 | 51 | 52 | class AsyncTimeRateLimiterABC(ABC): 53 | @abstractmethod 54 | async def _reactivate_slots(self) -> None: 55 | """Every n seconds (self.recovery_time) refresh number of self.active_slots to max number.""" 56 | ... 57 | 58 | @abstractmethod 59 | async def wrap_operation(self, func: Any, *args: Any, **kwargs: Any) -> Any: 60 | """ 61 | Wrapper around some async function which is used in "workers". 62 | It limits number of attempts to a certain maximum number. 63 | :param func: async function we would like to limit. 64 | :param args: this async function args. 65 | :param kwargs: this async function kwargs. 66 | :return: returns the same result as func is supposed to return. 67 | """ 68 | ... 69 | 70 | @abstractmethod 71 | async def __aenter__(self) -> Any: 72 | """Implemented to use the BucketRateLimiter instance as context manager.""" 73 | ... 74 | 75 | @abstractmethod 76 | async def __aexit__(self, exc_type: Any, exc: Any, tb: Any) -> None: 77 | """Implemented to use the BucketRateLimiter instance as context manager.""" 78 | ... 79 | 80 | 81 | class MThreadedBucketTimeRateLimiterABC(ABC): 82 | @abstractmethod 83 | def _reactivate_slots(self) -> None: 84 | """Every n seconds (self.recovery_time) refresh number of self.active_slots to max number.""" 85 | ... 86 | 87 | @abstractmethod 88 | def wrap_operation(self, func: Any, *args: Any, **kwargs: Any) -> Any: 89 | """ 90 | Wrapper around some sync function which is used in "workers". 91 | It limits number of attempts to a certain maximum number. 92 | :param func: some sync function we would like to apply rate limit to. 93 | :param args: the sync function args. 94 | :param kwargs: the sync function kwargs. 95 | :return: returns the same result as the func is supposed to return. 96 | """ 97 | ... 98 | 99 | @abstractmethod 100 | def __enter__(self) -> Any: 101 | """Implemented to use the BucketRateLimiter instance as context manager.""" 102 | ... 103 | 104 | @abstractmethod 105 | def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> None: 106 | """Implemented to use the BucketRateLimiter instance as context manager.""" 107 | ... 108 | -------------------------------------------------------------------------------- /bucketratelimiter/bucket_rate_limiters/mthreaded_bucket.py: -------------------------------------------------------------------------------- 1 | import threading as th 2 | from functools import wraps 3 | from time import sleep 4 | from typing import Any, Callable, Optional 5 | 6 | from .bucket_abc import BucketTimeRateLimiterABC, MThreadedBucketTimeRateLimiterABC 7 | 8 | 9 | class MThreadedBucketTimeRateLimiter(BucketTimeRateLimiterABC, MThreadedBucketTimeRateLimiterABC): 10 | def __init__( 11 | self, 12 | max_size: int = 4, 13 | recovery_time: float = 1.0, 14 | rest_time: float = 0.2, 15 | callback: Optional[Callable[..., Any]] = None, 16 | ) -> None: 17 | self.max_size: int = max_size 18 | self.active_slots: int = max_size # number of active slots at the moment 19 | self.recovery_time: float = recovery_time 20 | self.rest_time: float = rest_time 21 | # used to signal "external" workers that bucket is "empty" 22 | self.event_bucket_empty: th.Event = th.Event() 23 | # separate asyncio task to return bucket to full size 24 | self.reactivate_task: Optional[th.Thread] = None 25 | self.callback: Optional[Callable[..., Any]] = callback 26 | self.sync_lock = th.Lock() 27 | self.event_full_stop = th.Event() 28 | 29 | def _decrement(self) -> None: 30 | with self.sync_lock: 31 | if self.active_slots > 0: 32 | self.active_slots -= 1 33 | 34 | def _reactivate_slots(self) -> None: 35 | while self.event_full_stop.is_set(): 36 | sleep(self.recovery_time) 37 | with self.sync_lock: 38 | self.active_slots = self.max_size 39 | self.event_bucket_empty.set() 40 | 41 | def wrap_operation(self, func: Callable[..., Any], *args: Any, **kwargs: Any) -> Any: 42 | while True: 43 | if self.event_bucket_empty.is_set(): # if bucket is not empty do work 44 | if self.active_slots == 0: 45 | self.event_bucket_empty.clear() 46 | else: 47 | self._decrement() 48 | res = func(*args, **kwargs) 49 | if self.callback is not None: 50 | self.callback() 51 | return res 52 | else: 53 | sleep(self.rest_time) 54 | 55 | def activate(self) -> None: 56 | if self.reactivate_task is None: # prevents creation of several activate tasks 57 | self.event_full_stop.set() # prepare full stop event 58 | self.event_bucket_empty.set() # set event flag that bucket is ready 59 | self.reactivate_task = th.Thread(target=self._reactivate_slots, daemon=True) 60 | self.reactivate_task.start() 61 | 62 | def deactivate(self) -> None: 63 | if self.reactivate_task is not None: 64 | self.event_full_stop.clear() 65 | 66 | def __call__(self, f: Callable[..., Any]) -> Callable[..., Any]: 67 | @wraps(f) 68 | def wrapper(*args: Any, **kwargs: Any) -> Any: 69 | self.activate() 70 | return self.wrap_operation(f, *args, **kwargs) 71 | 72 | return wrapper 73 | 74 | def __enter__(self) -> "MThreadedBucketTimeRateLimiter": 75 | self.activate() 76 | return self 77 | 78 | def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> None: 79 | self.deactivate() 80 | -------------------------------------------------------------------------------- /bucketratelimiter/version.py: -------------------------------------------------------------------------------- 1 | __version__ = "1.0.0" 2 | 3 | __author__ = "Artyom Viktorovich Kozyrev" 4 | 5 | author_email = "kozirev8@gmail.com" 6 | 7 | package_license = "GNU GENERAL PUBLIC LICENSE" 8 | 9 | package_info = "Collection of BucketRateLimiters. Allows to limit number of ops to the certain number." 10 | -------------------------------------------------------------------------------- /examples/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ArtyomKozyrev8/BucketRateLimiter/36507e3cf0fe1072a71d7744d5ad0f88f3dccf32/examples/__init__.py -------------------------------------------------------------------------------- /examples/asyncio_complete_example.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from typing import NamedTuple 3 | from datetime import datetime 4 | import time 5 | from functools import partial 6 | 7 | from bucketratelimiter import AsyncioBucketTimeRateLimiter 8 | 9 | 10 | TASKS_TO_COMPLETE = [(i, i, i) for i in range(20)] 11 | WORKER_NUM = 30 12 | 13 | 14 | class TestResult(NamedTuple): 15 | res: int 16 | start: str 17 | end: str 18 | 19 | 20 | def some_callback(x: int, y: int, z: int) -> None: 21 | """This is some callback function""" 22 | print(f"Callback result: {x + y + z}") 23 | 24 | 25 | LIMITER = AsyncioBucketTimeRateLimiter(callback=partial(some_callback, 1, 2, 3)) # declare rate limiter here 26 | 27 | 28 | @LIMITER # use limiter as a decorator to rate limit some_func 29 | async def some_func(x: int, y: int, z: int, *, time_to_complete: float = 1) -> TestResult: 30 | """Imagine it is a fetch function and we would like to implement rate limiter to it.""" 31 | format_time = "%H:%M:%S" 32 | start = datetime.utcnow().strftime(format_time) 33 | await asyncio.sleep(time_to_complete) 34 | end = datetime.utcnow().strftime(format_time) 35 | result = x + y + z - z - y # = x 36 | 37 | return TestResult(result, start, end) 38 | 39 | 40 | async def worker(q: asyncio.Queue) -> None: 41 | """Workers which do some stuff.""" 42 | while True: 43 | item = await q.get() 44 | res = await some_func(*item) 45 | print(f"Result: {res.res} | {res.start} - {res.end}") 46 | q.task_done() 47 | 48 | 49 | async def main_entry_point() -> None: 50 | """Main entry point of our asyncio app.""" 51 | q = asyncio.Queue() 52 | for task in TASKS_TO_COMPLETE: 53 | await q.put(task) 54 | 55 | tasks_to_cancel = [] 56 | # use LIMITER as context manager to ensure its correct activation and end of work 57 | async with LIMITER: 58 | for w in [worker(q) for _ in range(1, WORKER_NUM + 1)]: 59 | tasks_to_cancel.append(asyncio.ensure_future(w)) 60 | 61 | await q.join() 62 | 63 | [t.cancel() for t in tasks_to_cancel] # cancel "daemon" tasks 64 | 65 | 66 | if __name__ == '__main__': 67 | start_t = time.monotonic() 68 | loop = asyncio.get_event_loop() 69 | try: 70 | loop.run_until_complete(main_entry_point()) 71 | finally: 72 | loop.close() 73 | print(f"Time passed: {time.monotonic() - start_t}") 74 | -------------------------------------------------------------------------------- /examples/multithreading_complete_example.py: -------------------------------------------------------------------------------- 1 | from threading import Thread 2 | from queue import Queue 3 | from typing import NamedTuple 4 | from datetime import datetime 5 | import time 6 | from functools import partial 7 | 8 | from bucketratelimiter import MThreadedBucketTimeRateLimiter 9 | 10 | 11 | TASKS_TO_COMPLETE = [(i, i, i) for i in range(20)] 12 | WORKER_NUM = 30 13 | 14 | 15 | class TestResult(NamedTuple): 16 | res: int 17 | start: str 18 | end: str 19 | 20 | 21 | def some_callback(x: int, y: int, z: int) -> None: 22 | """This is some callback function""" 23 | print(f"Callback result: {x + y + z}") 24 | 25 | 26 | LIMITER = MThreadedBucketTimeRateLimiter(callback=partial(some_callback, 1, 2, 3)) # declare rate limiter here 27 | 28 | 29 | @LIMITER # use limiter as a decorator to rate limit some_func 30 | def some_func(x: int, y: int, z: int, *, time_to_complete: float = 1) -> TestResult: 31 | """Imagine it is a fetch function and we would like to implement rate limiter to it.""" 32 | format_time = "%H:%M:%S" 33 | start = datetime.utcnow().strftime(format_time) 34 | time.sleep(time_to_complete) 35 | end = datetime.utcnow().strftime(format_time) 36 | result = x + y + z - z - y # = x 37 | 38 | return TestResult(result, start, end) 39 | 40 | 41 | def worker(q: Queue) -> None: 42 | """Workers which do some stuff.""" 43 | while True: 44 | item = q.get() 45 | res = some_func(*item) 46 | print(f"Result: {res.res} | {res.start} - {res.end}") 47 | q.task_done() 48 | 49 | 50 | def main_entry_point() -> None: 51 | """Main entry point of our multithreading app.""" 52 | q = Queue() 53 | for task in TASKS_TO_COMPLETE: 54 | q.put(task) 55 | 56 | # use LIMITER as context manager to ensure its correct activation and end of work 57 | with LIMITER: 58 | for _ in range(1, WORKER_NUM + 1): 59 | Thread(target=worker, args=(q, ), daemon=True).start() 60 | 61 | q.join() 62 | 63 | 64 | if __name__ == '__main__': 65 | start_t = time.monotonic() 66 | main_entry_point() 67 | print(f"Time passed: {time.monotonic() - start_t}") 68 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup, find_packages 3 | from importlib.machinery import SourceFileLoader 4 | 5 | 6 | module = SourceFileLoader( 7 | "bucketratelimiter", os.path.join("bucketratelimiter", "version.py") 8 | ).load_module() 9 | 10 | 11 | setup( 12 | name=module.__name__, 13 | version=module.__version__, 14 | author=module.__author__, 15 | author_email=module.author_email, 16 | license=module.package_license, 17 | description=module.package_info, 18 | long_description_content_type="text/markdown", 19 | long_description=open("README.md").read(), 20 | platforms="all", 21 | classifiers=[ 22 | "License :: OSI Approved :: GNU Affero General Public License v3", 23 | "Topic :: Internet", 24 | "Topic :: Software Development", 25 | "Topic :: Software Development :: Libraries", 26 | "Intended Audience :: Developers", 27 | "Natural Language :: English", 28 | "Operating System :: MacOS", 29 | "Operating System :: POSIX", 30 | "Operating System :: Microsoft", 31 | "Programming Language :: Python", 32 | "Programming Language :: Python :: 3", 33 | "Programming Language :: Python :: 3.6", 34 | "Programming Language :: Python :: 3.7", 35 | "Programming Language :: Python :: 3.8", 36 | "Programming Language :: Python :: 3.9", 37 | "Programming Language :: Python :: 3.10", 38 | "Programming Language :: Python :: Implementation :: CPython", 39 | ], 40 | packages=find_packages(exclude=["tests", "examples"]), 41 | package_data={"bucketratelimiter": ["py.typed"]}, 42 | install_requires=[], 43 | python_requires=">=3.6, <4", 44 | extras_require={ 45 | "develop": [ 46 | "mypy", 47 | "pytest-cov", 48 | "pytest-asyncio", 49 | ], 50 | }, 51 | project_urls={ 52 | "Documentation": "https://github.com/ArtyomKozyrev8/BucketRateLimiter/", 53 | "Source": "https://github.com/ArtyomKozyrev8/BucketRateLimiter/", 54 | }, 55 | ) 56 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ArtyomKozyrev8/BucketRateLimiter/36507e3cf0fe1072a71d7744d5ad0f88f3dccf32/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_asyncio_bucket.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from time import monotonic 3 | from typing import NamedTuple, Callable, Union, Awaitable, Coroutine 4 | 5 | import pytest 6 | 7 | from bucketratelimiter import AsyncioBucketTimeRateLimiter 8 | 9 | 10 | AsyncFuncType = Callable[..., Union[Awaitable, Coroutine]] 11 | 12 | 13 | class EnvironmentParams(NamedTuple): 14 | max_bucket_size: int 15 | recovery_time: float 16 | use_callback_func: bool 17 | workers_number: int 18 | tasks_number: int 19 | time_to_finish_one_task: float 20 | expected_finish_time: int 21 | 22 | 23 | def callback_func() -> None: 24 | return 25 | 26 | 27 | async def worker(q: asyncio.Queue, func: AsyncioBucketTimeRateLimiter, sleep_time: float = 1.0) -> None: 28 | while True: 29 | await q.get() 30 | await func(sleep_time) 31 | q.task_done() 32 | 33 | 34 | async def main_entry_point(env_params: EnvironmentParams, broken_reactivate_task: bool = False) -> int: 35 | """Main entry point of our asyncio tests.""" 36 | e = env_params 37 | 38 | callback = None 39 | if e.use_callback_func: 40 | callback = callback_func 41 | 42 | bucket = AsyncioBucketTimeRateLimiter(max_size=e.max_bucket_size, recovery_time=e.recovery_time, callback=callback) 43 | 44 | @bucket 45 | async def some_func_to_limit(sleep_time: float = 1.0) -> None: 46 | await asyncio.sleep(sleep_time) 47 | return 48 | 49 | start = monotonic() 50 | print(start) 51 | q = asyncio.Queue() 52 | for task in range(e.tasks_number): 53 | await q.put(task) # send all tasks to the Queue 54 | 55 | asyncio_tasks_to_cancel = [] 56 | async with bucket: 57 | for w in [ 58 | worker(q, some_func_to_limit, e.time_to_finish_one_task) for _ in range(e.workers_number) 59 | ]: 60 | asyncio_tasks_to_cancel.append(asyncio.ensure_future(w)) 61 | 62 | await q.join() # wait until all task in queue were done 63 | if broken_reactivate_task: 64 | bucket.reactivate_task = None 65 | 66 | [i.cancel() for i in asyncio_tasks_to_cancel] 67 | return int(monotonic() - start) 68 | 69 | 70 | @pytest.mark.asyncio 71 | async def test_wrapper_main_entry_point_1(): 72 | e = EnvironmentParams( 73 | max_bucket_size=4, 74 | recovery_time=1.0, 75 | use_callback_func=True, 76 | workers_number=30, 77 | tasks_number=20, 78 | time_to_finish_one_task=1.0, 79 | expected_finish_time=5, 80 | ) 81 | res = await main_entry_point(e) 82 | assert e.expected_finish_time == res 83 | 84 | 85 | @pytest.mark.asyncio 86 | async def test_wrapper_main_entry_point_2(): 87 | e = EnvironmentParams( 88 | max_bucket_size=10, 89 | recovery_time=1.0, 90 | use_callback_func=False, 91 | workers_number=30, 92 | tasks_number=20, 93 | time_to_finish_one_task=1.0, 94 | expected_finish_time=2, 95 | ) 96 | res = await main_entry_point(e) 97 | assert e.expected_finish_time == res 98 | 99 | 100 | @pytest.mark.asyncio 101 | async def test_wrapper_main_entry_point_3(): 102 | e = EnvironmentParams( 103 | max_bucket_size=2, 104 | recovery_time=1.0, 105 | use_callback_func=False, 106 | workers_number=30, 107 | tasks_number=20, 108 | time_to_finish_one_task=1.0, 109 | expected_finish_time=10, 110 | ) 111 | res = await main_entry_point(e) 112 | assert e.expected_finish_time == res 113 | 114 | 115 | @pytest.mark.asyncio 116 | async def test_wrapper_main_entry_point_4(): 117 | e = EnvironmentParams( 118 | max_bucket_size=10, 119 | recovery_time=1.0, 120 | use_callback_func=False, 121 | workers_number=30, 122 | tasks_number=20, 123 | time_to_finish_one_task=1.0, 124 | expected_finish_time=2, 125 | ) 126 | res = await main_entry_point(e, broken_reactivate_task=True) 127 | assert e.expected_finish_time == res 128 | 129 | 130 | @pytest.mark.asyncio 131 | async def test_wrapper_main_entry_point_5(): 132 | e = EnvironmentParams( 133 | max_bucket_size=10, 134 | recovery_time=1.0, 135 | use_callback_func=False, 136 | workers_number=30, 137 | tasks_number=60, 138 | time_to_finish_one_task=1.0, 139 | expected_finish_time=6, 140 | ) 141 | res = await main_entry_point(e) 142 | assert e.expected_finish_time == res 143 | 144 | 145 | @pytest.mark.asyncio 146 | async def test_wrapper_main_entry_point_6(): 147 | e = EnvironmentParams( 148 | max_bucket_size=10, 149 | recovery_time=1.0, 150 | use_callback_func=False, 151 | workers_number=30, 152 | tasks_number=20, 153 | time_to_finish_one_task=2.0, 154 | expected_finish_time=3, 155 | ) 156 | res = await main_entry_point(e) 157 | assert e.expected_finish_time == res 158 | 159 | 160 | @pytest.mark.asyncio 161 | async def test_wrapper_main_entry_point_7(): 162 | e = EnvironmentParams( 163 | max_bucket_size=10, 164 | recovery_time=1.0, 165 | use_callback_func=False, 166 | workers_number=30, 167 | tasks_number=20, 168 | time_to_finish_one_task=5.0, 169 | expected_finish_time=6, 170 | ) 171 | res = await main_entry_point(e) 172 | assert e.expected_finish_time == res 173 | 174 | 175 | @pytest.mark.asyncio 176 | async def test_wrapper_main_entry_point_8(): 177 | e = EnvironmentParams( 178 | max_bucket_size=5, 179 | recovery_time=1.0, 180 | use_callback_func=False, 181 | workers_number=30, 182 | tasks_number=20, 183 | time_to_finish_one_task=5.0, 184 | expected_finish_time=8, 185 | ) 186 | res = await main_entry_point(e) 187 | assert e.expected_finish_time == res 188 | 189 | 190 | def test__decrement(): 191 | bucket = AsyncioBucketTimeRateLimiter(max_size=1) 192 | for i in range(10): 193 | bucket._decrement() 194 | -------------------------------------------------------------------------------- /tests/test_mthreaded_bucket.py: -------------------------------------------------------------------------------- 1 | from queue import Queue 2 | from typing import NamedTuple 3 | from time import sleep, monotonic 4 | from threading import Thread 5 | 6 | from bucketratelimiter import MThreadedBucketTimeRateLimiter 7 | 8 | 9 | def test__decrement(): 10 | bucket = MThreadedBucketTimeRateLimiter(max_size=4) 11 | for i in range(10): 12 | bucket._decrement() 13 | 14 | 15 | class EnvironmentParams(NamedTuple): 16 | max_bucket_size: int 17 | recovery_time: float 18 | use_callback_func: bool 19 | workers_number: int 20 | tasks_number: int 21 | time_to_finish_one_task: float 22 | expected_finish_time: int 23 | 24 | 25 | def callback_func() -> None: 26 | return 27 | 28 | 29 | def worker(q: Queue, func: MThreadedBucketTimeRateLimiter, sleep_time: float = 1.0) -> None: 30 | while True: 31 | q.get() 32 | func(sleep_time) 33 | q.task_done() 34 | 35 | 36 | def main_entry_point(env_params: EnvironmentParams, broken_reactivate_task: bool = False) -> int: 37 | """Main entry point of our asyncio tests.""" 38 | e = env_params 39 | 40 | callback = None 41 | if e.use_callback_func: 42 | callback = callback_func 43 | 44 | bucket = MThreadedBucketTimeRateLimiter( 45 | max_size=e.max_bucket_size, 46 | recovery_time=e.recovery_time, 47 | callback=callback, 48 | ) 49 | 50 | @bucket 51 | def some_func_to_limit(sleep_time: float = 1.0) -> None: 52 | sleep(sleep_time) 53 | return 54 | 55 | start = monotonic() 56 | q = Queue() 57 | for task in range(e.tasks_number): 58 | q.put(task) # send all tasks to the Queue 59 | 60 | with bucket: 61 | for w in range(e.workers_number): 62 | Thread(target=worker, args=(q, some_func_to_limit, e.time_to_finish_one_task, ), daemon=True).start() 63 | 64 | q.join() # wait until all task in queue were done 65 | 66 | if broken_reactivate_task: 67 | bucket.event_full_stop.clear() 68 | bucket.reactivate_task = None 69 | 70 | return int(monotonic() - start) 71 | 72 | 73 | def test_wrapper_main_entry_point_1(): 74 | e = EnvironmentParams( 75 | max_bucket_size=4, 76 | recovery_time=1.0, 77 | use_callback_func=True, 78 | workers_number=30, 79 | tasks_number=20, 80 | time_to_finish_one_task=1.0, 81 | expected_finish_time=5, 82 | ) 83 | res = main_entry_point(e) 84 | assert e.expected_finish_time == res 85 | 86 | 87 | def test_wrapper_main_entry_point_2(): 88 | e = EnvironmentParams( 89 | max_bucket_size=10, 90 | recovery_time=1.0, 91 | use_callback_func=False, 92 | workers_number=30, 93 | tasks_number=20, 94 | time_to_finish_one_task=1.0, 95 | expected_finish_time=2, 96 | ) 97 | res = main_entry_point(e) 98 | assert e.expected_finish_time == res 99 | 100 | 101 | def test_wrapper_main_entry_point_3(): 102 | e = EnvironmentParams( 103 | max_bucket_size=2, 104 | recovery_time=1.0, 105 | use_callback_func=False, 106 | workers_number=30, 107 | tasks_number=20, 108 | time_to_finish_one_task=1.0, 109 | expected_finish_time=10, 110 | ) 111 | res = main_entry_point(e) 112 | assert e.expected_finish_time == res 113 | 114 | 115 | def test_wrapper_main_entry_point_4(): 116 | e = EnvironmentParams( 117 | max_bucket_size=10, 118 | recovery_time=1.0, 119 | use_callback_func=False, 120 | workers_number=30, 121 | tasks_number=20, 122 | time_to_finish_one_task=1.0, 123 | expected_finish_time=2, 124 | ) 125 | res = main_entry_point(e, broken_reactivate_task=True) 126 | assert e.expected_finish_time == res 127 | 128 | 129 | def test_wrapper_main_entry_point_5(): 130 | e = EnvironmentParams( 131 | max_bucket_size=10, 132 | recovery_time=1.0, 133 | use_callback_func=False, 134 | workers_number=30, 135 | tasks_number=60, 136 | time_to_finish_one_task=1.0, 137 | expected_finish_time=6, 138 | ) 139 | res = main_entry_point(e) 140 | assert e.expected_finish_time == res 141 | 142 | 143 | def test_wrapper_main_entry_point_6(): 144 | e = EnvironmentParams( 145 | max_bucket_size=10, 146 | recovery_time=1.0, 147 | use_callback_func=False, 148 | workers_number=30, 149 | tasks_number=20, 150 | time_to_finish_one_task=2.0, 151 | expected_finish_time=3, 152 | ) 153 | res = main_entry_point(e) 154 | assert e.expected_finish_time == res 155 | 156 | 157 | def test_wrapper_main_entry_point_7(): 158 | e = EnvironmentParams( 159 | max_bucket_size=10, 160 | recovery_time=1.0, 161 | use_callback_func=False, 162 | workers_number=30, 163 | tasks_number=20, 164 | time_to_finish_one_task=5.0, 165 | expected_finish_time=6, 166 | ) 167 | res = main_entry_point(e) 168 | assert e.expected_finish_time == res 169 | 170 | 171 | def test_wrapper_main_entry_point_8(): 172 | e = EnvironmentParams( 173 | max_bucket_size=5, 174 | recovery_time=1.0, 175 | use_callback_func=False, 176 | workers_number=30, 177 | tasks_number=20, 178 | time_to_finish_one_task=5.0, 179 | expected_finish_time=8, 180 | ) 181 | res = main_entry_point(e) 182 | assert e.expected_finish_time == res 183 | --------------------------------------------------------------------------------