Initial commit (Clean history)
This commit is contained in:
anhduy-tech
@@ -0,0 +1 @@
|
||||
pip
|
||||
@@ -0,0 +1,188 @@
|
||||
Metadata-Version: 2.4
|
||||
Name: django-db-geventpool
|
||||
Version: 4.0.8
|
||||
Summary: Add a DB connection pool using gevent to django
|
||||
Project-URL: Homepage, https://github.com/jneight/django-db-geventpool
|
||||
Author-email: Javier Cordero Martinez <j@jcmz.me>
|
||||
License-Expression: Apache-2.0
|
||||
License-File: AUTHORS.rst
|
||||
License-File: LICENSE
|
||||
Classifier: Environment :: Web Environment
|
||||
Classifier: Framework :: Django
|
||||
Classifier: Framework :: Django :: 3.2
|
||||
Classifier: Framework :: Django :: 4.2
|
||||
Classifier: Framework :: Django :: 5.0
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: License :: OSI Approved :: Apache Software License
|
||||
Classifier: Operating System :: OS Independent
|
||||
Classifier: Programming Language :: Python
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
||||
Requires-Dist: django>=4.2
|
||||
Description-Content-Type: text/markdown
|
||||
|
||||
django-db-geventpool
|
||||
====================
|
||||
|
||||
[](https://github.com/jneight/django-db-geventpool/actions/workflows/ci.yml)
|
||||
|
||||
[](https://pypi.python.org/pypi/django-db-geventpool)
|
||||
|
||||
[](https://pypi.python.org/pypi/django-db-geventpool)
|
||||
|
||||
Another DB pool using gevent for PostgreSQL DB.
|
||||
|
||||
|
||||
psycopg3
|
||||
---------
|
||||
|
||||
Django, since 4.2, supports psycopg3. One of the advantages is that gevent is supported without needing extra patches, just install the package
|
||||
|
||||
```
|
||||
$ pip install psycopg[binary]
|
||||
```
|
||||
|
||||
|
||||
psycopg2
|
||||
--------
|
||||
|
||||
If **gevent** is not installed, the pool will use **eventlet** as fallback.
|
||||
|
||||
- `psycopg2>=2.5.1` for CPython 2 and 3 (or
|
||||
[psycopg2-binary](https://pypi.org/project/psycopg2-binary/)---see
|
||||
[notes in the psycopg2 2.7.4
|
||||
release](http://initd.org/psycopg/articles/2018/02/08/psycopg-274-released/))
|
||||
- `psycopg2cffi>=2.7` for PyPy
|
||||
|
||||
Patch psycopg2
|
||||
--------------
|
||||
|
||||
Before using the pool, psycopg2 must be patched with psycogreen, if you
|
||||
are using [gunicorn webserver](http://www.gunicorn.org/), a good place
|
||||
is the
|
||||
[post\_fork()](http://docs.gunicorn.org/en/latest/settings.html#post-fork)
|
||||
function at the config file:
|
||||
|
||||
``` {.python}
|
||||
from psycogreen.gevent import patch_psycopg # use this if you use gevent workers
|
||||
from psycogreen.eventlet import patch_psycopg # use this if you use eventlet workers
|
||||
|
||||
def post_fork(server, worker):
|
||||
patch_psycopg()
|
||||
worker.log.info("Made Psycopg2 Green")
|
||||
```
|
||||
|
||||
Settings
|
||||
--------
|
||||
|
||||
> - Set *ENGINE* in your database settings to:
|
||||
>
|
||||
> - For psycopg3: 'django_db_geventpool.backends.postgresql_psycopg3'
|
||||
> - For psycopg2: 'django_db_geventpool.backends.postgresql_psycopg2'
|
||||
> - For postgis: 'django_db_geventpool.backends.postgis'
|
||||
>
|
||||
> - Add *MAX\_CONNS* to *OPTIONS* to set the maximun number of
|
||||
> connections allowed to database (default=4)
|
||||
>
|
||||
> - Add *REUSE\_CONNS* to *OPTIONS* to indicate how many of the
|
||||
> MAX\_CONNS should be reused by new requests. Will fallback to the
|
||||
> same value as MAX\_CONNS if not defined
|
||||
>
|
||||
> - Add *\'CONN\_MAX\_AGE\': 0* to settings to disable default django
|
||||
> persistent connection feature. And read below note if you are
|
||||
> manually spawning greenlets
|
||||
|
||||
For Django < 5.1:
|
||||
|
||||
``` {.python}
|
||||
DATABASES = {
|
||||
'default': {
|
||||
'ENGINE': 'django_db_geventpool.backends.postgresql_psycopg',
|
||||
'NAME': 'db',
|
||||
'USER': 'postgres',
|
||||
'PASSWORD': 'postgres',
|
||||
'HOST': '',
|
||||
'PORT': '',
|
||||
'ATOMIC_REQUESTS': False,
|
||||
'CONN_MAX_AGE': 0,
|
||||
'OPTIONS': {
|
||||
'MAX_CONNS': 20,
|
||||
'REUSE_CONNS': 10
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For Django >= 5.1, native pool support should be disabled:
|
||||
|
||||
``` {.python}
|
||||
DATABASES = {
|
||||
'default': {
|
||||
'ENGINE': 'django_db_geventpool.backends.postgresql_psycopg',
|
||||
'NAME': 'db',
|
||||
'USER': 'postgres',
|
||||
'PASSWORD': 'postgres',
|
||||
'HOST': '',
|
||||
'PORT': '',
|
||||
'ATOMIC_REQUESTS': False,
|
||||
'CONN_MAX_AGE': 0,
|
||||
'OPTIONS': {
|
||||
'MAX_CONNS': 20,
|
||||
'REUSE_CONNS': 10.
|
||||
'pool': False,
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Using ORM when not serving requests
|
||||
-----------------------------------
|
||||
|
||||
If you are using django with celery (or other), or have code that
|
||||
manually spawn greenlets it will not be sufficient to set CONN\_MAX\_AGE
|
||||
to 0. Django only checks for long-live connections when finishing a
|
||||
request - So if you manually spawn a greenlet (or task spawning one) its
|
||||
connections will not get cleaned up and will live until timeout. In
|
||||
production this can cause quite some open connections and while
|
||||
developing it can hamper your tests cases.
|
||||
|
||||
To solve it make sure that each greenlet function (or task) either sends
|
||||
the django.core.signals.request\_finished signal or calls
|
||||
django.db.close\_old\_connections() right before it ends
|
||||
|
||||
The decorator method with your function is preferred, but the other
|
||||
alternatives are also valid
|
||||
|
||||
``` {.python}
|
||||
from django_db_geventpool.utils import close_connection
|
||||
|
||||
@close_connection
|
||||
def foo_func()
|
||||
...
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
``` {.python}
|
||||
from django.core.signals import request_finished
|
||||
|
||||
def foo_func():
|
||||
...
|
||||
request_finished.send(sender="greenlet")
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
``` {.python}
|
||||
from django.db import close_old_connections
|
||||
|
||||
def foo_func():
|
||||
...
|
||||
close_old_connections()
|
||||
```
|
||||
|
||||
Other pools
|
||||
-----------
|
||||
|
||||
- [django-db-pool](https://github.com/gmcguire/django-db-pool)
|
||||
- [django-postgresql](https://github.com/kennethreitz/django-postgrespool)
|
||||
@@ -0,0 +1,31 @@
|
||||
django_db_geventpool-4.0.8.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
django_db_geventpool-4.0.8.dist-info/METADATA,sha256=6c048jca3bn3F1IT5K-If6Ne_g9SVVndW52afvoRcrw,5649
|
||||
django_db_geventpool-4.0.8.dist-info/RECORD,,
|
||||
django_db_geventpool-4.0.8.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
django_db_geventpool-4.0.8.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
|
||||
django_db_geventpool-4.0.8.dist-info/licenses/AUTHORS.rst,sha256=cJSqvVjrx4lrLeyqyTJW_a6SApVUiep8y21wca0GP64,105
|
||||
django_db_geventpool-4.0.8.dist-info/licenses/LICENSE,sha256=c7p036pSC0mkAbXSFFmoUjoUbzt1GKgz7qXvqFEwv2g,10273
|
||||
django_db_geventpool/__init__.py,sha256=LkIZ8qJ4SWjb6UMf6Cd-PGfNWSuVapFgDd22X4rXaog,19
|
||||
django_db_geventpool/__pycache__/__init__.cpython-312.pyc,,
|
||||
django_db_geventpool/__pycache__/utils.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
django_db_geventpool/backends/__pycache__/__init__.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/__pycache__/base.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/__pycache__/creation.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/__pycache__/pool.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/base.py,sha256=qP4TXsiJ04AAGiQAoOG-LkbgPsIOWaQPG4eeiPdjPGk,3049
|
||||
django_db_geventpool/backends/creation.py,sha256=me8NWTJz7cDMVewSHgYy-3Ky7TIdceGFfAgHBCNcpFw,530
|
||||
django_db_geventpool/backends/pool.py,sha256=jq5P401tptpk3S2K1ZwDT-Tw3wiEHltmpW0n0_qg4Ew,2510
|
||||
django_db_geventpool/backends/postgis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
django_db_geventpool/backends/postgis/__pycache__/__init__.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/postgis/__pycache__/base.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/postgis/base.py,sha256=IZGChu5PDa38iOkne30g3b7QhYIhlwuNAWI7BtUBEF4,622
|
||||
django_db_geventpool/backends/postgresql_psycopg2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
django_db_geventpool/backends/postgresql_psycopg2/__pycache__/__init__.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/postgresql_psycopg2/__pycache__/base.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/postgresql_psycopg2/base.py,sha256=6yShQ40Tz7CRD9mymkAEYPW4rSy4H7Ubkj2xBjDUkRo,1302
|
||||
django_db_geventpool/backends/postgresql_psycopg3/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
django_db_geventpool/backends/postgresql_psycopg3/__pycache__/__init__.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/postgresql_psycopg3/__pycache__/base.cpython-312.pyc,,
|
||||
django_db_geventpool/backends/postgresql_psycopg3/base.py,sha256=g0FPB0KeZuEiL2vhwASS6QC7uFyFnKuMr2MGqkXWylQ,1149
|
||||
django_db_geventpool/utils.py,sha256=K_pi8vEYydIjPErt4e3T6S-mAx5UaNgZjXvHRBxLAag,537
|
||||
@@ -0,0 +1,5 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: hatchling 1.27.0
|
||||
Root-Is-Purelib: true
|
||||
Tag: py2-none-any
|
||||
Tag: py3-none-any
|
||||
@@ -0,0 +1,2 @@
|
||||
Javier Cordero / jneight <https://github.com/jneight>
|
||||
Rajiv Makhijani / rajivm <http://github.com/rajivm>
|
||||
@@ -0,0 +1,191 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, and
|
||||
distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
||||
owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all other entities
|
||||
that control, are controlled by, or are under common control with that entity.
|
||||
For the purposes of this definition, "control" means (i) the power, direct or
|
||||
indirect, to cause the direction or management of such entity, whether by
|
||||
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
||||
permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications, including
|
||||
but not limited to software source code, documentation source, and configuration
|
||||
files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical transformation or
|
||||
translation of a Source form, including but not limited to compiled object code,
|
||||
generated documentation, and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or Object form, made
|
||||
available under the License, as indicated by a copyright notice that is included
|
||||
in or attached to the work (an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object form, that
|
||||
is based on (or derived from) the Work and for which the editorial revisions,
|
||||
annotations, elaborations, or other modifications represent, as a whole, an
|
||||
original work of authorship. For the purposes of this License, Derivative Works
|
||||
shall not include works that remain separable from, or merely link (or bind by
|
||||
name) to the interfaces of, the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including the original version
|
||||
of the Work and any modifications or additions to that Work or Derivative Works
|
||||
thereof, that is intentionally submitted to Licensor for inclusion in the Work
|
||||
by the copyright owner or by an individual or Legal Entity authorized to submit
|
||||
on behalf of the copyright owner. For the purposes of this definition,
|
||||
"submitted" means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems, and
|
||||
issue tracking systems that are managed by, or on behalf of, the Licensor for
|
||||
the purpose of discussing and improving the Work, but excluding communication
|
||||
that is conspicuously marked or otherwise designated in writing by the copyright
|
||||
owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
||||
of whom a Contribution has been received by Licensor and subsequently
|
||||
incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License.
|
||||
|
||||
Subject to the terms and conditions of this License, each Contributor hereby
|
||||
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
||||
irrevocable copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the Work and such
|
||||
Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License.
|
||||
|
||||
Subject to the terms and conditions of this License, each Contributor hereby
|
||||
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
||||
irrevocable (except as stated in this section) patent license to make, have
|
||||
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
|
||||
such license applies only to those patent claims licensable by such Contributor
|
||||
that are necessarily infringed by their Contribution(s) alone or by combination
|
||||
of their Contribution(s) with the Work to which such Contribution(s) was
|
||||
submitted. If You institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
|
||||
Contribution incorporated within the Work constitutes direct or contributory
|
||||
patent infringement, then any patent licenses granted to You under this License
|
||||
for that Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution.
|
||||
|
||||
You may reproduce and distribute copies of the Work or Derivative Works thereof
|
||||
in any medium, with or without modifications, and in Source or Object form,
|
||||
provided that You meet the following conditions:
|
||||
|
||||
You must give any other recipients of the Work or Derivative Works a copy of
|
||||
this License; and
|
||||
You must cause any modified files to carry prominent notices stating that You
|
||||
changed the files; and
|
||||
You must retain, in the Source form of any Derivative Works that You distribute,
|
||||
all copyright, patent, trademark, and attribution notices from the Source form
|
||||
of the Work, excluding those notices that do not pertain to any part of the
|
||||
Derivative Works; and
|
||||
If the Work includes a "NOTICE" text file as part of its distribution, then any
|
||||
Derivative Works that You distribute must include a readable copy of the
|
||||
attribution notices contained within such NOTICE file, excluding those notices
|
||||
that do not pertain to any part of the Derivative Works, in at least one of the
|
||||
following places: within a NOTICE text file distributed as part of the
|
||||
Derivative Works; within the Source form or documentation, if provided along
|
||||
with the Derivative Works; or, within a display generated by the Derivative
|
||||
Works, if and wherever such third-party notices normally appear. The contents of
|
||||
the NOTICE file are for informational purposes only and do not modify the
|
||||
License. You may add Your own attribution notices within Derivative Works that
|
||||
You distribute, alongside or as an addendum to the NOTICE text from the Work,
|
||||
provided that such additional attribution notices cannot be construed as
|
||||
modifying the License.
|
||||
You may add Your own copyright statement to Your modifications and may provide
|
||||
additional or different license terms and conditions for use, reproduction, or
|
||||
distribution of Your modifications, or for any such Derivative Works as a whole,
|
||||
provided Your use, reproduction, and distribution of the Work otherwise complies
|
||||
with the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions.
|
||||
|
||||
Unless You explicitly state otherwise, any Contribution intentionally submitted
|
||||
for inclusion in the Work by You to the Licensor shall be under the terms and
|
||||
conditions of this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify the terms of
|
||||
any separate license agreement you may have executed with Licensor regarding
|
||||
such Contributions.
|
||||
|
||||
6. Trademarks.
|
||||
|
||||
This License does not grant permission to use the trade names, trademarks,
|
||||
service marks, or product names of the Licensor, except as required for
|
||||
reasonable and customary use in describing the origin of the Work and
|
||||
reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty.
|
||||
|
||||
Unless required by applicable law or agreed to in writing, Licensor provides the
|
||||
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
|
||||
including, without limitation, any warranties or conditions of TITLE,
|
||||
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
|
||||
solely responsible for determining the appropriateness of using or
|
||||
redistributing the Work and assume any risks associated with Your exercise of
|
||||
permissions under this License.
|
||||
|
||||
8. Limitation of Liability.
|
||||
|
||||
In no event and under no legal theory, whether in tort (including negligence),
|
||||
contract, or otherwise, unless required by applicable law (such as deliberate
|
||||
and grossly negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special, incidental,
|
||||
or consequential damages of any character arising as a result of this License or
|
||||
out of the use or inability to use the Work (including but not limited to
|
||||
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
|
||||
any and all other commercial damages or losses), even if such Contributor has
|
||||
been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability.
|
||||
|
||||
While redistributing the Work or Derivative Works thereof, You may choose to
|
||||
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
|
||||
other liability obligations and/or rights consistent with this License. However,
|
||||
in accepting such obligations, You may act only on Your own behalf and on Your
|
||||
sole responsibility, not on behalf of any other Contributor, and only if You
|
||||
agree to indemnify, defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason of your
|
||||
accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work
|
||||
|
||||
To apply the Apache License to your work, attach the following boilerplate
|
||||
notice, with the fields enclosed by brackets "[]" replaced with your own
|
||||
identifying information. (Don't include the brackets!) The text should be
|
||||
enclosed in the appropriate comment syntax for the file format. We also
|
||||
recommend that a file or class name and description of purpose be included on
|
||||
the same "printed page" as the copyright notice for easier identification within
|
||||
third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
Reference in New Issue
Block a user