mirror of
https://github.com/psycopg/psycopg2.git
synced 2025-08-01 02:50:08 +03:00
PostgreSQL database adapter for the Python programming language
This follows the semantics of Python file objects. When the object is garbage collected and it has not been closed, emit a ResourceWarning. This allows library users to notice inconsistent and non-deterministic resource management and fix it. Users should use context managers and finally blocks to always close cursors and connections when they are not longer required. For example, in Python, not closing a file results in the following: $ python3 -Walways >>> f = open('foo', 'w') >>> del f __main__:1: ResourceWarning: unclosed file <_io.TextIOWrapper name='foo' mode='w' encoding='UTF-8'> ResourceWarning: Enable tracemalloc to get the object allocation traceback psycopg now acts the same way: $ python3 -Walways >>> import psycopg2 >>> c = psycopg2.connect(database='psycopg2_test') >>> del c <stdin>:1: ResourceWarning: unclosed connection <connection object at 0x7fc4aec38d50; dsn: 'dbname=psycopg2_test', closed: 0> ResourceWarning: Enable tracemalloc to get the object allocation traceback All warnings noticed during testing has been fixed. |
||
---|---|---|
doc | ||
lib | ||
psycopg | ||
scripts | ||
tests | ||
.appveyor.yml | ||
.gitignore | ||
.travis.yml | ||
AUTHORS | ||
INSTALL | ||
LICENSE | ||
Makefile | ||
MANIFEST.in | ||
NEWS | ||
psycopg2.cproj | ||
README.rst | ||
setup.cfg | ||
setup.py | ||
tox.ini |
psycopg2 - Python-PostgreSQL Database Adapter ============================================= Psycopg is the most popular PostgreSQL database adapter for the Python programming language. Its main features are the complete implementation of the Python DB API 2.0 specification and the thread safety (several threads can share the same connection). It was designed for heavily multi-threaded applications that create and destroy lots of cursors and make a large number of concurrent "INSERT"s or "UPDATE"s. Psycopg 2 is mostly implemented in C as a libpq wrapper, resulting in being both efficient and secure. It features client-side and server-side cursors, asynchronous communication and notifications, "COPY TO/COPY FROM" support. Many Python types are supported out-of-the-box and adapted to matching PostgreSQL data types; adaptation can be extended and customized thanks to a flexible objects adaptation system. Psycopg 2 is both Unicode and Python 3 friendly. Documentation ------------- Documentation is included in the ``doc`` directory and is `available online`__. .. __: https://www.psycopg.org/docs/ For any other resource (source code repository, bug tracker, mailing list) please check the `project homepage`__. .. __: https://psycopg.org/ Installation ------------ Building Psycopg requires a few prerequisites (a C compiler, some development packages): please check the install_ and the faq_ documents in the ``doc`` dir or online for the details. If prerequisites are met, you can install psycopg like any other Python package, using ``pip`` to download it from PyPI_:: $ pip install psycopg2 or using ``setup.py`` if you have downloaded the source package locally:: $ python setup.py build $ sudo python setup.py install You can also obtain a stand-alone package, not requiring a compiler or external libraries, by installing the `psycopg2-binary`_ package from PyPI:: $ pip install psycopg2-binary The binary package is a practical choice for development and testing but in production it is advised to use the package built from sources. .. _PyPI: https://pypi.org/project/psycopg2/ .. _psycopg2-binary: https://pypi.org/project/psycopg2-binary/ .. _install: https://www.psycopg.org/docs/install.html#install-from-source .. _faq: https://www.psycopg.org/docs/faq.html#faq-compile :Linux/OSX: |travis| :Windows: |appveyor| .. |travis| image:: https://travis-ci.org/psycopg/psycopg2.svg?branch=master :target: https://travis-ci.org/psycopg/psycopg2 :alt: Linux and OSX build status .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/psycopg/psycopg2?branch=master&svg=true :target: https://ci.appveyor.com/project/psycopg/psycopg2/branch/master :alt: Windows build status