pax_global_header00006660000000000000000000000064150311756570014524gustar00rootroot0000000000000052 comment=ab20a3aebda9f59f2d2cb92d6b0069e04982037c jazzband-dj-database-url-ab20a3a/000077500000000000000000000000001503117565700167375ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/.flake8000066400000000000000000000001631503117565700201120ustar00rootroot00000000000000[flake8] max-line-length = 88 extend-ignore = E203 per-file-ignores= tests/test_dj_database_url.py: E501, E265 jazzband-dj-database-url-ab20a3a/.github/000077500000000000000000000000001503117565700202775ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/.github/workflows/000077500000000000000000000000001503117565700223345ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/.github/workflows/release.yml000066400000000000000000000017611503117565700245040ustar00rootroot00000000000000name: Release on: push: tags: - '*' jobs: build: if: github.repository == 'jazzband/dj-database-url' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.10' - name: Install dependencies run: | python -m pip install -U pip python -m pip install -U setuptools wheel twine - name: Build package run: | python setup.py --version python setup.py sdist --format=gztar bdist_wheel twine check dist/* - name: Upload packages to Jazzband if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') uses: pypa/gh-action-pypi-publish@release/v1 with: user: jazzband password: ${{ secrets.JAZZBAND_RELEASE_KEY }} repository_url: https://jazzband.co/projects/dj-database-url/upload jazzband-dj-database-url-ab20a3a/.github/workflows/test.yml000066400000000000000000000031031503117565700240330ustar00rootroot00000000000000name: test on: [push, pull_request] jobs: test: runs-on: ubuntu-latest strategy: fail-fast: false matrix: python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] django-version: ["4.2", "5.1"] exclude: # Python 3.11 is not compatible with 3.2 - python-version: "3.11" django-version: "3.2" - python-version: "3.12" django-version: "3.2" - python-version: "3.13" django-version: "3.2" # django 5.x is not compatible with python 3.9 or lower - python-version: "3.9" django-version: "5.1" steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} cache: 'pip' - name: Install dependencies run: | pip install -r requirements.txt pip install "Django~=${{ matrix.django-version }}.0" . - name: Run type checking run: | python -m mypy dj_database_url python -m pyright dj_database_url - name: Run Tests run: | echo "$(python --version) / Django $(django-admin --version)" coverage run --source=dj_database_url --branch -m unittest discover -v coverage report coverage xml - uses: codecov/codecov-action@v4 - name: Check types installation run: | pip install . cd tests python -m mypy . python -m pyright . jazzband-dj-database-url-ab20a3a/.gitignore000066400000000000000000000010621503117565700207260ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] # C extensions *.so # Distribution / packaging .Python env/ bin/ build/ develop-eggs/ dist/ eggs/ lib/ lib64/ parts/ sdist/ var/ *.egg-info/ .installed.cfg *.egg # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports .tox/ .coverage .cache nosetests.xml coverage.xml # Translations *.mo # Mr Developer .mr.developer.cfg .project .pydevproject # Rope .ropeproject # Django stuff: *.log *.pot # Sphinx documentation docs/_build/ # Virtualenv env/ .vscode/ jazzband-dj-database-url-ab20a3a/.isort.cfg000066400000000000000000000000331503117565700206320ustar00rootroot00000000000000[settings] profile = black jazzband-dj-database-url-ab20a3a/.pre-commit-config.yaml000066400000000000000000000007571503117565700232310ustar00rootroot00000000000000repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v5.0.0 hooks: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/isort rev: "6.0.1" hooks: - id: isort args: ["--profile", "black"] - repo: https://github.com/psf/black rev: 25.1.0 hooks: - id: black args: [--target-version=py38] - repo: https://github.com/pycqa/flake8 rev: '7.2.0' hooks: - id: flake8 jazzband-dj-database-url-ab20a3a/CHANGELOG.md000066400000000000000000000122211503117565700205460ustar00rootroot00000000000000# CHANGELOG ## v3.0.1 (2025-07-01) * Drop dependency on `typing_extensions`. ## v3.0.0 (2025-05-18) > Bumping to version 3; changes to code do break some API compatability. * Implement a new decorator registry pattern to impement checks on database connection string. * You can now support and implement your own database strings by extending the @register functionality. * Update supported python versions and django versions. ## v2.3.0 (2024-10-23) * Remove Python 3.8 support. * Remove Django 3 support. * Add python 3.13 support. * Add Django 5.1 to the testing library. ## v2.2.0 (2024-05-28) * Add disable_server_side_cursors parameter * Enhance Query String Parsing for Server-Side Binding in Django 4.2 with psycopg 3.1.8+ * Update django 5.0 python compatability by @mattseymour in #239 * Improved internals * Improved documentation ## v2.1.0 (2023-08-15) * Add value to int parsing when deconstructing url string. ## v2.0.0 (2023-04-27) * Update project setup such that we now install as a package. _Notes_: while this does not alter the underlying application code, we are bumping to 2.0 incase there are unforeseen knock on use-case issues. ## v1.3.0 (2023-03-27) * Cosmetic changes to the generation of schemes. * Bump isort version - 5.11.5. * raise warning message if database_url is not set. * CONN_MAX_AGE fix type - Optional[int]. ## v1.2.0 (2022-12-13) * Add the ability to add test databases. * Improve url parsing and encoding. * Fix missing parameter conn_health_check in check function. ## v1.1.0 (2022-12-12) * Option for connection health checks parameter. * Update supported version python 3.11. * Code changes, various improvments. * Add project links to setup.py ## v1.0.0 (2022-06-18) Initial release of code now dj-database-urls is part of jazzband. * Add support for cockroachdb. * Add support for the offical MSSQL connector. * Update License to be compatible with Jazzband. * Remove support for Python < 3.5 including Python 2.7 * Update source code to Black format. * Update CI using pre-commit ## v0.5.0 (2018-03-01) - Use str port for mssql - Added license - Add mssql to readme - Add mssql support using pyodbc - Fix RST schemas - Django expects Oracle Ports as strings - Fix IPv6 address parsing - Add testing for Python 3.6 - Revert "Add setup.cfg for wheel support" - added option of postgis backend to also add path parsing. (test added also) - Support schema definition for redshift - add redshift support - Add testing for Python 3.5 - Drop testing for Python 2.6 - Fixes issue with unix file paths being turned to lower case - add Redis support - Added SpatiaLite in README.rst ## v0.4.1 (2016-04-06) - Enable CA providing for MySQL URIs - Update Readme - Update trove classifiers - Updated setup.py description ## v0.4.0 (2016-02-04) - Update readme - Fix for python3 - Handle search path config in connect url for postgres - Add tox config to ease testing against multiple Python versions - Simplified the querystring parse logic - Cleaned up querystring parsing - supports database options - Added tests for CONN_MAX_AGE - Added documentation for conn_max_age - Add in optional support for CONN_MAX_AGE - Support special characters in user, password and name fields - Add oracle support - Added support for percent-encoded postgres paths - Fixed test_cleardb_parsing test - Enable automated testing with Python 3.4 - Add URL schema examples to README - Added support for python mysql-connector ## v0.3.0 (2014-03-10) - Add .gitignore file - Remove .pyc file - Remove travis-ci unsupported python version Per docs http://docs.travis-ci.com/user/languages/python/ "Travis CI support Python versions 2.6, 2.7, 3.2 and 3.3" - Fix cleardb test - Add setup.cfg for wheel support - Add trove classifiers for python versions - Replace Python 3.1 with Python 3.3 - Add MySQL (GIS) support - Ability to set different engine ## v0.2.2 (2013-07-17) - Added spatialite to uses_netloc too - Added spatialite backend - Replacing tab with spaces - Handling special case of sqlite://:memory: - Empty sqlite path will now use a :memory: database - Fixing test to actually use the result of the parse - Adding in tests to ensure sqlite in-memory databases work - Fixed too-short title underline - Added :target: attribute to Travis status image in README - Added docs for default argument to config - Add "pgsql" as a PostgreSQL URL scheme. - Add support for blank fields (Django expects '' not None) - fixed url ## v0.2.1 (2012-06-19) - Add python3 support - Adding travis status and tests - Adding test environment variables - Adding test for cleardb - Remove query strings from name - Adding postgres tests - Adding tests - refactor scheme lookup - RedHat's OpenShift platform uses the 'postgresql' scheme - Registered postgis URL scheme - Added `postgis://` url scheme - Use get() on os.environ instead of an if ## v0.2.0 (2012-05-30) - Fix parse(s) ## v0.1.4 (2012-05-30) - Add defaults for env - Set the DATABASES dict rather than assigning to it ## v0.1.3 (2012-05-01) - Add note to README on supported databases - Add support for SQLite - Clean dependencies ## v0.1.2 (2012-04-30) - Update readme - Refactor config and use new parse function ## v0.1.1 (2012-04-30) First release 🐍 ✨ jazzband-dj-database-url-ab20a3a/CODE_OF_CONDUCT.md000066400000000000000000000045071503117565700215440ustar00rootroot00000000000000# Code of Conduct As contributors and maintainers of the Jazzband projects, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. We are committed to making participation in the Jazzband a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Examples of unacceptable behavior by participants include: - The use of sexualized language or imagery - Personal attacks - Trolling or insulting/derogatory comments - Public or private harassment - Publishing other's private information, such as physical or electronic addresses, without explicit permission - Other unethical or unprofessional conduct The Jazzband roadies have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. By adopting this Code of Conduct, the roadies commit themselves to fairly and consistently applying these principles to every aspect of managing the jazzband projects. Roadies who do not follow or enforce the Code of Conduct may be permanently removed from the Jazzband roadies. This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the roadies at `roadies@jazzband.co`. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Roadies are obligated to maintain confidentiality with regard to the reporter of an incident. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.3.0, available at [https://contributor-covenant.org/version/1/3/0/][version] [homepage]: https://contributor-covenant.org [version]: https://contributor-covenant.org/version/1/3/0/ jazzband-dj-database-url-ab20a3a/CONTRIBUTING.md000066400000000000000000000006761503117565700212010ustar00rootroot00000000000000[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/) This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines). Please see the [full contributing documentation](https://django-debug-toolbar.readthedocs.io/en/stable/contributing.html) for more help. jazzband-dj-database-url-ab20a3a/LICENSE000066400000000000000000000030001503117565700177350ustar00rootroot00000000000000Copyright (c) Kenneth Reitz & individual contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of Django nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. jazzband-dj-database-url-ab20a3a/README.rst000066400000000000000000000301121503117565700204230ustar00rootroot00000000000000DJ-Database-URL ~~~~~~~~~~~~~~~ .. image:: https://jazzband.co/static/img/badge.png :target: https://jazzband.co/ :alt: Jazzband .. image:: https://github.com/jazzband/dj-database-url/actions/workflows/test.yml/badge.svg :target: https://github.com/jazzband/dj-database-url/actions/workflows/test.yml .. image:: https://codecov.io/gh/jazzband/dj-database-url/branch/master/graph/badge.svg?token=7srBUpszOa :target: https://codecov.io/gh/jazzband/dj-database-url This simple Django utility allows you to utilize the `12factor `_ inspired ``DATABASE_URL`` environment variable to configure your Django application. The ``dj_database_url.config`` method returns a Django database connection dictionary, populated with all the data specified in your URL. There is also a `conn_max_age` argument to easily enable Django's connection pool. If you'd rather not use an environment variable, you can pass a URL in directly instead to ``dj_database_url.parse``. Installation ------------ Installation is simple: .. code-block:: console $ pip install dj-database-url Usage ----- 1. If ``DATABASES`` is already defined: - Configure your database in ``settings.py`` from ``DATABASE_URL``: .. code-block:: python import dj_database_url DATABASES['default'] = dj_database_url.config( conn_max_age=600, conn_health_checks=True, ) - Provide a default: .. code-block:: python DATABASES['default'] = dj_database_url.config( default='postgres://...', conn_max_age=600, conn_health_checks=True, ) - Parse an arbitrary Database URL: .. code-block:: python DATABASES['default'] = dj_database_url.parse( 'postgres://...', conn_max_age=600, conn_health_checks=True, ) 2. If ``DATABASES`` is not defined: - Configure your database in ``settings.py`` from ``DATABASE_URL``: .. code-block:: python import dj_database_url DATABASES = { 'default': dj_database_url.config( conn_max_age=600, conn_health_checks=True, ), } - You can provide a default, used if the ``DATABASE_URL`` setting is not defined: .. code-block:: python DATABASES = { 'default': dj_database_url.config( default='postgres://...', conn_max_age=600, conn_health_checks=True, ) } - Parse an arbitrary Database URL: .. code-block:: python DATABASES = { 'default': dj_database_url.parse( 'postgres://...', conn_max_age=600, conn_health_checks=True, ) } ``conn_max_age`` sets the |CONN_MAX_AGE setting|__, which tells Django to persist database connections between requests, up to the given lifetime in seconds. If you do not provide a value, it will follow Django’s default of ``0``. Setting it is recommended for performance. .. |CONN_MAX_AGE setting| replace:: ``CONN_MAX_AGE`` setting __ https://docs.djangoproject.com/en/stable/ref/settings/#conn-max-age ``conn_health_checks`` sets the |CONN_HEALTH_CHECKS setting|__ (new in Django 4.1), which tells Django to check a persisted connection still works at the start of each request. If you do not provide a value, it will follow Django’s default of ``False``. Enabling it is recommended if you set a non-zero ``conn_max_age``. .. |CONN_HEALTH_CHECKS setting| replace:: ``CONN_HEALTH_CHECKS`` setting __ https://docs.djangoproject.com/en/stable/ref/settings/#conn-health-checks Strings passed to `dj_database_url` must be valid URLs; in particular, special characters must be url-encoded. The following url will raise a `ValueError`: .. code-block:: plaintext postgres://user:p#ssword!@localhost/foobar and should instead be passed as: .. code-block:: plaintext postgres://user:p%23ssword!@localhost/foobar `TEST `_ settings can be configured using the ``test_options`` attribute:: DATABASES['default'] = dj_database_url.config(default='postgres://...', test_options={'NAME': 'mytestdatabase'}) Supported Databases ------------------- Support currently exists for PostgreSQL, PostGIS, MySQL, MySQL (GIS), Oracle, Oracle (GIS), Redshift, CockroachDB, Timescale, Timescale (GIS) and SQLite. If you want to use some non-default backends, you need to register them first: .. code-block:: python import dj_database_url # registration should be performed only once dj_database_url.register("mysql-connector", "mysql.connector.django") assert dj_database_url.parse("mysql-connector://user:password@host:port/db-name") == { "ENGINE": "mysql.connector.django", # ...other connection params } Some backends need further config adjustments (e.g. oracle and mssql expect ``PORT`` to be a string). For such cases you can provide a post-processing function to ``register()`` (note that ``register()`` is used as a **decorator(!)** in this case): .. code-block:: python import dj_database_url @dj_database_url.register("mssql", "sql_server.pyodbc") def stringify_port(config): config["PORT"] = str(config["PORT"]) @dj_database_url.register("redshift", "django_redshift_backend") def apply_current_schema(config): options = config["OPTIONS"] schema = options.pop("currentSchema", None) if schema: options["options"] = f"-c search_path={schema}" @dj_database_url.register("snowflake", "django_snowflake") def adjust_snowflake_config(config): config.pop("PORT", None) config["ACCOUNT"] = config.pop("HOST") name, _, schema = config["NAME"].partition("/") if schema: config["SCHEMA"] = schema config["NAME"] = name options = config.get("OPTIONS", {}) warehouse = options.pop("warehouse", None) if warehouse: config["WAREHOUSE"] = warehouse role = options.pop("role", None) if role: config["ROLE"] = role URL schema ---------- +----------------------+-----------------------------------------------+--------------------------------------------------+ | Engine | Django Backend | URL | +======================+===============================================+==================================================+ | PostgreSQL | ``django.db.backends.postgresql`` [1]_ | ``postgres://USER:PASSWORD@HOST:PORT/NAME`` [2]_ | | | | ``postgresql://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | PostGIS | ``django.contrib.gis.db.backends.postgis`` | ``postgis://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | MSSQL | ``sql_server.pyodbc`` | ``mssql://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | MSSQL [5]_ | ``mssql`` | ``mssqlms://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | MySQL | ``django.db.backends.mysql`` | ``mysql://USER:PASSWORD@HOST:PORT/NAME`` [2]_ | +----------------------+-----------------------------------------------+--------------------------------------------------+ | MySQL (GIS) | ``django.contrib.gis.db.backends.mysql`` | ``mysqlgis://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | SQLite | ``django.db.backends.sqlite3`` | ``sqlite:///PATH`` [3]_ | +----------------------+-----------------------------------------------+--------------------------------------------------+ | SpatiaLite | ``django.contrib.gis.db.backends.spatialite`` | ``spatialite:///PATH`` [3]_ | +----------------------+-----------------------------------------------+--------------------------------------------------+ | Oracle | ``django.db.backends.oracle`` | ``oracle://USER:PASSWORD@HOST:PORT/NAME`` [4]_ | +----------------------+-----------------------------------------------+--------------------------------------------------+ | Oracle (GIS) | ``django.contrib.gis.db.backends.oracle`` | ``oraclegis://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | Redshift | ``django_redshift_backend`` | ``redshift://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | CockroachDB | ``django_cockroachdb`` | ``cockroach://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | Timescale [6]_ | ``timescale.db.backends.postgresql`` | ``timescale://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ | Timescale (GIS) [6]_ | ``timescale.db.backend.postgis`` | ``timescalegis://USER:PASSWORD@HOST:PORT/NAME`` | +----------------------+-----------------------------------------------+--------------------------------------------------+ .. [1] The django.db.backends.postgresql backend is named django.db.backends.postgresql_psycopg2 in older releases. For backwards compatibility, the old name still works in newer versions. (The new name does not work in older versions). .. [2] With PostgreSQL or CloudSQL, you can also use unix domain socket paths with `percent encoding `_: ``postgres://%2Fvar%2Flib%2Fpostgresql/dbname`` ``mysql://uf07k1i6d8ia0v@%2fcloudsql%2fproject%3alocation%3ainstance/dbname`` .. [3] SQLite connects to file based databases. The same URL format is used, omitting the hostname, and using the "file" portion as the filename of the database. This has the effect of four slashes being present for an absolute file path: ``sqlite:////full/path/to/your/database/file.sqlite``. .. [4] Note that when connecting to Oracle the URL isn't in the form you may know from using other Oracle tools (like SQLPlus) i.e. user and password are separated by ``:`` not by ``/``. Also you can omit ``HOST`` and ``PORT`` and provide a full DSN string or TNS name in ``NAME`` part. .. [5] Microsoft official `mssql-django `_ adapter. .. [6] Using the django-timescaledb Package which must be installed. Contributing ------------ We welcome contributions to this project. Projects can take two forms: 1. Raising issues or helping others through the github issue tracker. 2. Contributing code. Raising Issues or helping others: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ When submitting an issue or helping other remember you are talking to humans who have feelings, jobs and lives of their own. Be nice, be kind, be polite. Remember english may not be someone first language, if you do not understand or something is not clear be polite and re-ask/ re-word. Contributing code: ^^^^^^^^^^^^^^^^^^ * Before writing code be sure to check existing PR's and issues in the tracker. * Write code to the pylint spec. * Large or wide sweeping changes will take longer, and may face more scrutiny than smaller confined changes. * Code should be pass `black` and `flake8` validation. jazzband-dj-database-url-ab20a3a/dj_database_url/000077500000000000000000000000001503117565700220425ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/dj_database_url/__init__.py000066400000000000000000000171331503117565700241600ustar00rootroot00000000000000import logging import os import urllib.parse as urlparse from typing import Any, Callable, Dict, List, Optional, TypedDict, Union DEFAULT_ENV = "DATABASE_URL" ENGINE_SCHEMES: Dict[str, "Engine"] = {} # From https://docs.djangoproject.com/en/stable/ref/settings/#databases class DBConfig(TypedDict, total=False): ATOMIC_REQUESTS: bool AUTOCOMMIT: bool CONN_MAX_AGE: Optional[int] CONN_HEALTH_CHECKS: bool DISABLE_SERVER_SIDE_CURSORS: bool ENGINE: str HOST: str NAME: str OPTIONS: Dict[str, Any] PASSWORD: str PORT: Union[str, int] TEST: Dict[str, Any] TIME_ZONE: str USER: str PostprocessCallable = Callable[[DBConfig], None] OptionType = Union[int, str, bool] class ParseError(ValueError): def __str__(self) -> str: return ( "This string is not a valid url, possibly because some of its parts" " is not properly urllib.parse.quote()'ed." ) class UnknownSchemeError(ValueError): def __init__(self, scheme: str) -> None: self.scheme = scheme def __str__(self) -> str: schemes = ", ".join(sorted(ENGINE_SCHEMES.keys())) return ( f"Scheme '{self.scheme}://' is unknown." " Did you forget to register custom backend?" f" Following schemes have registered backends: {schemes}." ) def default_postprocess(parsed_config: DBConfig) -> None: pass class Engine: def __init__( self, backend: str, postprocess: PostprocessCallable = default_postprocess, ) -> None: self.backend = backend self.postprocess = postprocess def register( scheme: str, backend: str ) -> Callable[[PostprocessCallable], PostprocessCallable]: engine = Engine(backend) if scheme not in ENGINE_SCHEMES: urlparse.uses_netloc.append(scheme) ENGINE_SCHEMES[scheme] = engine def inner(func: PostprocessCallable) -> PostprocessCallable: engine.postprocess = func return func return inner register("spatialite", "django.contrib.gis.db.backends.spatialite") register("mysql-connector", "mysql.connector.django") register("mysqlgis", "django.contrib.gis.db.backends.mysql") register("oraclegis", "django.contrib.gis.db.backends.oracle") register("cockroach", "django_cockroachdb") @register("sqlite", "django.db.backends.sqlite3") def default_to_in_memory_db(parsed_config: DBConfig) -> None: # mimic sqlalchemy behaviour if not parsed_config.get("NAME"): parsed_config["NAME"] = ":memory:" @register("oracle", "django.db.backends.oracle") @register("mssqlms", "mssql") @register("mssql", "sql_server.pyodbc") def stringify_port(parsed_config: DBConfig) -> None: parsed_config["PORT"] = str(parsed_config.get("PORT", "")) @register("mysql", "django.db.backends.mysql") @register("mysql2", "django.db.backends.mysql") def apply_ssl_ca(parsed_config: DBConfig) -> None: options = parsed_config.get("OPTIONS", {}) ca = options.pop("ssl-ca", None) if ca: options["ssl"] = {"ca": ca} @register("postgres", "django.db.backends.postgresql") @register("postgresql", "django.db.backends.postgresql") @register("pgsql", "django.db.backends.postgresql") @register("postgis", "django.contrib.gis.db.backends.postgis") @register("redshift", "django_redshift_backend") @register("timescale", "timescale.db.backends.postgresql") @register("timescalegis", "timescale.db.backends.postgis") def apply_current_schema(parsed_config: DBConfig) -> None: options = parsed_config.get("OPTIONS", {}) schema = options.pop("currentSchema", None) if schema: options["options"] = f"-c search_path={schema}" def config( env: str = DEFAULT_ENV, default: Optional[str] = None, engine: Optional[str] = None, conn_max_age: int = 0, conn_health_checks: bool = False, disable_server_side_cursors: bool = False, ssl_require: bool = False, test_options: Optional[Dict[str, Any]] = None, ) -> DBConfig: """Returns configured DATABASE dictionary from DATABASE_URL.""" s = os.environ.get(env, default) if s is None: logging.warning( "No %s environment variable set, and so no databases setup", env ) if s: return parse( s, engine, conn_max_age, conn_health_checks, disable_server_side_cursors, ssl_require, test_options, ) return {} def parse( url: str, engine: Optional[str] = None, conn_max_age: int = 0, conn_health_checks: bool = False, disable_server_side_cursors: bool = False, ssl_require: bool = False, test_options: Optional[Dict[str, Any]] = None, ) -> DBConfig: """Parses a database URL and returns configured DATABASE dictionary.""" settings = _convert_to_settings( engine, conn_max_age, conn_health_checks, disable_server_side_cursors, ssl_require, test_options, ) if url == "sqlite://:memory:": # this is a special case, because if we pass this URL into # urlparse, urlparse will choke trying to interpret "memory" # as a port number return {"ENGINE": ENGINE_SCHEMES["sqlite"].backend, "NAME": ":memory:"} # note: no other settings are required for sqlite try: split_result = urlparse.urlsplit(url) engine_obj = ENGINE_SCHEMES.get(split_result.scheme) if engine_obj is None: raise UnknownSchemeError(split_result.scheme) path = split_result.path[1:] query = urlparse.parse_qs(split_result.query) options = {k: _parse_option_values(v) for k, v in query.items()} parsed_config: DBConfig = { "ENGINE": engine_obj.backend, "USER": urlparse.unquote(split_result.username or ""), "PASSWORD": urlparse.unquote(split_result.password or ""), "HOST": urlparse.unquote(split_result.hostname or ""), "PORT": split_result.port or "", "NAME": urlparse.unquote(path), "OPTIONS": options, } except UnknownSchemeError: raise except ValueError: raise ParseError() from None # Guarantee that config has options, possibly empty, when postprocess() is called assert isinstance(parsed_config["OPTIONS"], dict) engine_obj.postprocess(parsed_config) # Update the final config with any settings passed in explicitly. parsed_config["OPTIONS"].update(settings.pop("OPTIONS", {})) parsed_config.update(settings) if not parsed_config["OPTIONS"]: parsed_config.pop("OPTIONS") return parsed_config def _parse_option_values(values: List[str]) -> Union[OptionType, List[OptionType]]: parsed_values = [_parse_value(v) for v in values] return parsed_values[0] if len(parsed_values) == 1 else parsed_values def _parse_value(value: str) -> OptionType: if value.isdigit(): return int(value) if value.lower() in ("true", "false"): return value.lower() == "true" return value def _convert_to_settings( engine: Optional[str], conn_max_age: int, conn_health_checks: bool, disable_server_side_cursors: bool, ssl_require: bool, test_options: Optional[dict[str, Any]], ) -> DBConfig: settings: DBConfig = { "CONN_MAX_AGE": conn_max_age, "CONN_HEALTH_CHECKS": conn_health_checks, "DISABLE_SERVER_SIDE_CURSORS": disable_server_side_cursors, } if engine: settings["ENGINE"] = engine if ssl_require: settings["OPTIONS"] = {} settings["OPTIONS"]["sslmode"] = "require" if test_options: settings["TEST"] = test_options return settings jazzband-dj-database-url-ab20a3a/dj_database_url/py.typed000066400000000000000000000000001503117565700235270ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/pyproject.toml000066400000000000000000000003131503117565700216500ustar00rootroot00000000000000[tool.black] skip-string-normalization = 1 [tool.mypy] show_error_codes=true disallow_untyped_defs=true disallow_untyped_calls=true warn_redundant_casts=true [tool.pyright] typeCheckingMode = "strict" jazzband-dj-database-url-ab20a3a/requirements.txt000066400000000000000000000000261503117565700222210ustar00rootroot00000000000000coverage mypy pyright jazzband-dj-database-url-ab20a3a/setup.py000066400000000000000000000034111503117565700204500ustar00rootroot00000000000000from pathlib import Path from setuptools import setup # pyright: ignore[reportUnknownVariableType] readme = Path("README.rst").read_text() setup( name="dj-database-url", version="3.0.1", url="https://github.com/jazzband/dj-database-url", license="BSD", author="Original Author: Kenneth Reitz, Maintained by: JazzBand Community", description="Use Database URLs in your Django Application.", long_description=readme, long_description_content_type="text/x-rst", packages=["dj_database_url"], install_requires=["Django>=4.2"], include_package_data=True, package_data={ "dj_database_url": ["py.typed"], }, platforms="any", project_urls={ "GitHub": "https://github.com/jazzband/dj-database-url/", "Release log": ( "https://github.com/jazzband/dj-database-url/blob/master/CHANGELOG.md" ), }, classifiers=[ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 4.2", "Framework :: Django :: 5.0", "Framework :: Django :: 5.1", "Framework :: Django :: 5.2", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14", ], ) jazzband-dj-database-url-ab20a3a/tests/000077500000000000000000000000001503117565700201015ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/tests/__init__.py000066400000000000000000000000001503117565700222000ustar00rootroot00000000000000jazzband-dj-database-url-ab20a3a/tests/test_dj_database_url.py000066400000000000000000000712061503117565700246230ustar00rootroot00000000000000# pyright: reportTypedDictNotRequiredAccess=false import os import re import unittest from unittest import mock from urllib.parse import uses_netloc import dj_database_url POSTGIS_URL = "postgis://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" class DatabaseTestSuite(unittest.TestCase): def test_postgres_parsing(self) -> None: url = dj_database_url.parse( "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_postgres_unix_socket_parsing(self) -> None: url = dj_database_url.parse( "postgres://%2Fvar%2Frun%2Fpostgresql/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "/var/run/postgresql" assert url["USER"] == "" assert url["PASSWORD"] == "" assert url["PORT"] == "" url = dj_database_url.parse( "postgres://%2FUsers%2Fpostgres%2FRuN/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["HOST"] == "/Users/postgres/RuN" assert url["USER"] == "" assert url["PASSWORD"] == "" assert url["PORT"] == "" def test_postgres_google_cloud_parsing(self) -> None: url = dj_database_url.parse( "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@%2Fcloudsql%2Fproject_id%3Aregion%3Ainstance_id/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "/cloudsql/project_id:region:instance_id" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == "" def test_ipv6_parsing(self) -> None: url = dj_database_url.parse( "postgres://ieRaekei9wilaim7:wegauwhgeuioweg@[2001:db8:1234::1234:5678:90af]:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "2001:db8:1234::1234:5678:90af" assert url["USER"] == "ieRaekei9wilaim7" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_postgres_search_path_parsing(self) -> None: url = dj_database_url.parse( "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?currentSchema=otherschema" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 assert url["OPTIONS"]["options"] == "-c search_path=otherschema" assert "currentSchema" not in url["OPTIONS"] def test_postgres_parsing_with_special_characters(self) -> None: url = dj_database_url.parse( "postgres://%23user:%23password@ec2-107-21-253-135.compute-1.amazonaws.com:5431/%23database" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "#database" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "#user" assert url["PASSWORD"] == "#password" assert url["PORT"] == 5431 def test_postgres_parsing_with_int_bool_str_query_string(self) -> None: url = dj_database_url.parse( "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?server_side_binding=true&timeout=20&service=my_service&passfile=.my_pgpass" ) assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 assert url["OPTIONS"]["server_side_binding"] is True assert url["OPTIONS"]["timeout"] == 20 assert url["OPTIONS"]["service"] == "my_service" assert url["OPTIONS"]["passfile"] == ".my_pgpass" def test_postgis_parsing(self) -> None: url = dj_database_url.parse( "postgis://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.contrib.gis.db.backends.postgis" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_postgis_search_path_parsing(self) -> None: url = dj_database_url.parse( "postgis://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?currentSchema=otherschema" ) assert url["ENGINE"] == "django.contrib.gis.db.backends.postgis" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 assert url["OPTIONS"]["options"] == "-c search_path=otherschema" assert "currentSchema" not in url["OPTIONS"] def test_mysql_gis_parsing(self) -> None: url = dj_database_url.parse( "mysqlgis://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "django.contrib.gis.db.backends.mysql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_mysql_connector_parsing(self) -> None: url = dj_database_url.parse( "mysql-connector://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "mysql.connector.django" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_config_test_options(self) -> None: with mock.patch.dict( os.environ, { "DATABASE_URL": "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?" }, ): test_db_config = { 'NAME': 'mytestdatabase', } url = dj_database_url.config(test_options=test_db_config) assert url['TEST']['NAME'] == 'mytestdatabase' def test_cleardb_parsing(self) -> None: url = dj_database_url.parse( "mysql://bea6eb025ca0d8:69772142@us-cdbr-east.cleardb.com/heroku_97681db3eff7580?reconnect=true" ) assert url["ENGINE"] == "django.db.backends.mysql" assert url["NAME"] == "heroku_97681db3eff7580" assert url["HOST"] == "us-cdbr-east.cleardb.com" assert url["USER"] == "bea6eb025ca0d8" assert url["PASSWORD"] == "69772142" assert url["PORT"] == "" def test_database_url(self) -> None: with mock.patch.dict(os.environ, clear=True): a = dj_database_url.config() assert not a with mock.patch.dict( os.environ, { "DATABASE_URL": "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" }, ): url = dj_database_url.config() assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_empty_sqlite_url(self) -> None: url = dj_database_url.parse("sqlite://") assert url["ENGINE"] == "django.db.backends.sqlite3" assert url["NAME"] == ":memory:" def test_memory_sqlite_url(self) -> None: url = dj_database_url.parse("sqlite://:memory:") assert url["ENGINE"] == "django.db.backends.sqlite3" assert url["NAME"] == ":memory:" def test_sqlite_relative_url(self) -> None: url = "sqlite:///db.sqlite3" config = dj_database_url.parse(url) assert config["ENGINE"] == "django.db.backends.sqlite3" assert config["NAME"] == "db.sqlite3" def test_sqlite_absolute_url(self) -> None: # 4 slashes are needed: # two are part of scheme # one separates host:port from path # and the fourth goes to "NAME" value url = "sqlite:////db.sqlite3" config = dj_database_url.parse(url) assert config["ENGINE"] == "django.db.backends.sqlite3" assert config["NAME"] == "/db.sqlite3" def test_parse_engine_setting(self) -> None: engine = "django_mysqlpool.backends.mysqlpool" url = dj_database_url.parse( "mysql://bea6eb025ca0d8:69772142@us-cdbr-east.cleardb.com/heroku_97681db3eff7580?reconnect=true", engine, ) assert url["ENGINE"] == engine def test_config_engine_setting(self) -> None: engine = "django_mysqlpool.backends.mysqlpool" with mock.patch.dict( os.environ, { "DATABASE_URL": "mysql://bea6eb025ca0d8:69772142@us-cdbr-east.cleardb.com/heroku_97681db3eff7580?reconnect=true" }, ): url = dj_database_url.config(engine=engine) assert url["ENGINE"] == engine def test_parse_conn_max_age_setting(self) -> None: conn_max_age = 600 url = dj_database_url.parse( "mysql://bea6eb025ca0d8:69772142@us-cdbr-east.cleardb.com/heroku_97681db3eff7580?reconnect=true", conn_max_age=conn_max_age, ) assert url["CONN_MAX_AGE"] == conn_max_age def test_config_conn_max_age_setting(self) -> None: conn_max_age = 600 with mock.patch.dict( os.environ, { "DATABASE_URL": "mysql://bea6eb025ca0d8:69772142@us-cdbr-east.cleardb.com/heroku_97681db3eff7580?reconnect=true" }, ): url = dj_database_url.config(conn_max_age=conn_max_age) assert url["CONN_MAX_AGE"] == conn_max_age def test_database_url_with_options(self) -> None: # Test full options with mock.patch.dict( os.environ, { "DATABASE_URL": "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?sslrootcert=rds-combined-ca-bundle.pem&sslmode=verify-full" }, ): url = dj_database_url.config() assert url["ENGINE"] == "django.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 assert url["OPTIONS"] == { "sslrootcert": "rds-combined-ca-bundle.pem", "sslmode": "verify-full", } # Test empty options with mock.patch.dict( os.environ, { "DATABASE_URL": "postgres://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?" }, ): url = dj_database_url.config() assert "OPTIONS" not in url def test_mysql_database_url_with_sslca_options(self) -> None: with mock.patch.dict( os.environ, { "DATABASE_URL": "mysql://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:3306/d8r82722r2kuvn?ssl-ca=rds-combined-ca-bundle.pem" }, ): url = dj_database_url.config() assert url["ENGINE"] == "django.db.backends.mysql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 3306 assert url["OPTIONS"] == {"ssl": {"ca": "rds-combined-ca-bundle.pem"}} # Test empty options with mock.patch.dict( os.environ, { "DATABASE_URL": "mysql://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:3306/d8r82722r2kuvn?" }, ): url = dj_database_url.config() assert "OPTIONS" not in url def test_oracle_parsing(self) -> None: url = dj_database_url.parse("oracle://scott:tiger@oraclehost:1521/hr") assert url["ENGINE"] == "django.db.backends.oracle" assert url["NAME"] == "hr" assert url["HOST"] == "oraclehost" assert url["USER"] == "scott" assert url["PASSWORD"] == "tiger" assert url["PORT"] == "1521" def test_oracle_gis_parsing(self) -> None: url = dj_database_url.parse("oraclegis://scott:tiger@oraclehost:1521/hr") assert url["ENGINE"] == "django.contrib.gis.db.backends.oracle" assert url["NAME"] == "hr" assert url["HOST"] == "oraclehost" assert url["USER"] == "scott" assert url["PASSWORD"] == "tiger" assert url["PORT"] == 1521 def test_oracle_dsn_parsing(self) -> None: url = dj_database_url.parse( "oracle://scott:tiger@/" "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)" "(HOST=oraclehost)(PORT=1521)))" "(CONNECT_DATA=(SID=hr)))" ) assert url["ENGINE"] == "django.db.backends.oracle" assert url["USER"] == "scott" assert url["PASSWORD"] == "tiger" assert url["HOST"] == "" assert url["PORT"] == "" dsn = ( "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)" "(HOST=oraclehost)(PORT=1521)))" "(CONNECT_DATA=(SID=hr)))" ) assert url["NAME"] == dsn def test_oracle_tns_parsing(self) -> None: url = dj_database_url.parse("oracle://scott:tiger@/tnsname") assert url["ENGINE"] == "django.db.backends.oracle" assert url["USER"] == "scott" assert url["PASSWORD"] == "tiger" assert url["NAME"] == "tnsname" assert url["HOST"] == "" assert url["PORT"] == "" def test_redshift_parsing(self) -> None: url = dj_database_url.parse( "redshift://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5439/d8r82722r2kuvn?currentSchema=otherschema" ) assert url["ENGINE"] == "django_redshift_backend" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5439 assert url["OPTIONS"]["options"] == "-c search_path=otherschema" assert "currentSchema" not in url["OPTIONS"] def test_mssql_parsing(self) -> None: url = dj_database_url.parse( "mssql://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com/d8r82722r2kuvn?driver=ODBC Driver 13 for SQL Server" ) assert url["ENGINE"] == "sql_server.pyodbc" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == "" assert url["OPTIONS"]["driver"] == "ODBC Driver 13 for SQL Server" assert "currentSchema" not in url["OPTIONS"] def test_mssql_instance_port_parsing(self) -> None: url = dj_database_url.parse( "mssql://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com\\insnsnss:12345/d8r82722r2kuvn?driver=ODBC Driver 13 for SQL Server" ) assert url["ENGINE"] == "sql_server.pyodbc" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com\\insnsnss" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == "12345" assert url["OPTIONS"]["driver"] == "ODBC Driver 13 for SQL Server" assert "currentSchema" not in url["OPTIONS"] def test_cockroach(self) -> None: url = dj_database_url.parse( "cockroach://testuser:testpass@testhost:26257/cockroach?sslmode=verify-full&sslrootcert=/certs/ca.crt&sslcert=/certs/client.myprojectuser.crt&sslkey=/certs/client.myprojectuser.key" ) assert url['ENGINE'] == 'django_cockroachdb' assert url['NAME'] == 'cockroach' assert url['HOST'] == 'testhost' assert url['USER'] == 'testuser' assert url['PASSWORD'] == 'testpass' assert url['PORT'] == 26257 assert url['OPTIONS']['sslmode'] == 'verify-full' assert url['OPTIONS']['sslrootcert'] == '/certs/ca.crt' assert url['OPTIONS']['sslcert'] == '/certs/client.myprojectuser.crt' assert url['OPTIONS']['sslkey'] == '/certs/client.myprojectuser.key' def test_mssqlms_parsing(self) -> None: url = dj_database_url.parse( "mssqlms://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com/d8r82722r2kuvn?driver=ODBC Driver 13 for SQL Server" ) assert url["ENGINE"] == "mssql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == "" assert url["OPTIONS"]["driver"] == "ODBC Driver 13 for SQL Server" assert "currentSchema" not in url["OPTIONS"] def test_timescale_parsing(self) -> None: url = dj_database_url.parse( "timescale://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_timescale_unix_socket_parsing(self) -> None: url = dj_database_url.parse( "timescale://%2Fvar%2Frun%2Fpostgresql/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "/var/run/postgresql" assert url["USER"] == "" assert url["PASSWORD"] == "" assert url["PORT"] == "" url = dj_database_url.parse( "timescale://%2FUsers%2Fpostgres%2FRuN/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgresql" assert url["HOST"] == "/Users/postgres/RuN" assert url["USER"] == "" assert url["PASSWORD"] == "" assert url["PORT"] == "" def test_timescale_ipv6_parsing(self) -> None: url = dj_database_url.parse( "timescale://ieRaekei9wilaim7:wegauwhgeuioweg@[2001:db8:1234::1234:5678:90af]:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "2001:db8:1234::1234:5678:90af" assert url["USER"] == "ieRaekei9wilaim7" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_timescale_search_path_parsing(self) -> None: url = dj_database_url.parse( "timescale://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?currentSchema=otherschema" ) assert url["ENGINE"] == "timescale.db.backends.postgresql" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 assert url["OPTIONS"]["options"] == "-c search_path=otherschema" assert "currentSchema" not in url["OPTIONS"] def test_timescale_parsing_with_special_characters(self) -> None: url = dj_database_url.parse( "timescale://%23user:%23password@ec2-107-21-253-135.compute-1.amazonaws.com:5431/%23database" ) assert url["ENGINE"] == "timescale.db.backends.postgresql" assert url["NAME"] == "#database" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "#user" assert url["PASSWORD"] == "#password" assert url["PORT"] == 5431 def test_timescalegis_parsing(self) -> None: url = dj_database_url.parse( "timescalegis://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgis" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_timescalegis_unix_socket_parsing(self) -> None: url = dj_database_url.parse( "timescalegis://%2Fvar%2Frun%2Fpostgresql/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgis" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "/var/run/postgresql" assert url["USER"] == "" assert url["PASSWORD"] == "" assert url["PORT"] == "" url = dj_database_url.parse( "timescalegis://%2FUsers%2Fpostgres%2FRuN/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgis" assert url["HOST"] == "/Users/postgres/RuN" assert url["USER"] == "" assert url["PASSWORD"] == "" assert url["PORT"] == "" def test_timescalegis_ipv6_parsing(self) -> None: url = dj_database_url.parse( "timescalegis://ieRaekei9wilaim7:wegauwhgeuioweg@[2001:db8:1234::1234:5678:90af]:5431/d8r82722r2kuvn" ) assert url["ENGINE"] == "timescale.db.backends.postgis" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "2001:db8:1234::1234:5678:90af" assert url["USER"] == "ieRaekei9wilaim7" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 def test_timescalegis_search_path_parsing(self) -> None: url = dj_database_url.parse( "timescalegis://uf07k1i6d8ia0v:wegauwhgeuioweg@ec2-107-21-253-135.compute-1.amazonaws.com:5431/d8r82722r2kuvn?currentSchema=otherschema" ) assert url["ENGINE"] == "timescale.db.backends.postgis" assert url["NAME"] == "d8r82722r2kuvn" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "uf07k1i6d8ia0v" assert url["PASSWORD"] == "wegauwhgeuioweg" assert url["PORT"] == 5431 assert url["OPTIONS"]["options"] == "-c search_path=otherschema" assert "currentSchema" not in url["OPTIONS"] def test_timescalegis_parsing_with_special_characters(self) -> None: url = dj_database_url.parse( "timescalegis://%23user:%23password@ec2-107-21-253-135.compute-1.amazonaws.com:5431/%23database" ) assert url["ENGINE"] == "timescale.db.backends.postgis" assert url["NAME"] == "#database" assert url["HOST"] == "ec2-107-21-253-135.compute-1.amazonaws.com" assert url["USER"] == "#user" assert url["PASSWORD"] == "#password" assert url["PORT"] == 5431 def test_persistent_connection_variables(self) -> None: url = dj_database_url.parse( "sqlite://myfile.db", conn_max_age=600, conn_health_checks=True ) assert url["CONN_MAX_AGE"] == 600 assert url["CONN_HEALTH_CHECKS"] is True def test_sqlite_memory_persistent_connection_variables(self) -> None: # memory sqlite ignores connection.close(), so persistent connection # variables aren’t required url = dj_database_url.parse( "sqlite://:memory:", conn_max_age=600, conn_health_checks=True ) assert "CONN_MAX_AGE" not in url assert "CONN_HEALTH_CHECKS" not in url @mock.patch.dict( os.environ, {"DATABASE_URL": "postgres://user:password@instance.amazonaws.com:5431/d8r8?"}, ) def test_persistent_connection_variables_config(self) -> None: url = dj_database_url.config(conn_max_age=600, conn_health_checks=True) assert url["CONN_MAX_AGE"] == 600 assert url["CONN_HEALTH_CHECKS"] is True def test_no_env_variable(self) -> None: with self.assertLogs() as cm: with mock.patch.dict(os.environ, clear=True): url = dj_database_url.config() assert url == {}, url assert cm.output == [ 'WARNING:root:No DATABASE_URL environment variable set, and so no databases setup' ], cm.output def test_credentials_unquoted__raise_value_error(self) -> None: expected_message = ( "This string is not a valid url, possibly because some of its parts " r"is not properly urllib.parse.quote()'ed." ) with self.assertRaisesRegex(ValueError, re.escape(expected_message)): dj_database_url.parse("postgres://user:passw#ord!@localhost/foobar") def test_credentials_quoted__ok(self) -> None: url = "postgres://user%40domain:p%23ssword!@localhost/foobar" config = dj_database_url.parse(url) assert config["USER"] == "user@domain" assert config["PASSWORD"] == "p#ssword!" def test_unknown_scheme__raise_value_error(self) -> None: expected_message = ( "Scheme 'unknown-scheme://' is unknown. " "Did you forget to register custom backend? Following schemes have registered backends:" ) with self.assertRaisesRegex(ValueError, re.escape(expected_message)): dj_database_url.parse("unknown-scheme://user:password@localhost/foobar") def test_register_multiple_times__no_duplicates_in_uses_netloc(self) -> None: # make sure that when register() function is misused, # it won't pollute urllib.parse.uses_netloc list with duplicates. # Otherwise, it might cause performance issue if some code assumes that # that list is short and performs linear search on it. dj_database_url.register("django.contrib.db.backends.bag_end", "bag-end") dj_database_url.register("django.contrib.db.backends.bag_end", "bag-end") assert len(uses_netloc) == len(set(uses_netloc)) @mock.patch.dict( os.environ, {"DATABASE_URL": "postgres://user:password@instance.amazonaws.com:5431/d8r8?"}, ) def test_ssl_require(self) -> None: url = dj_database_url.config(ssl_require=True) assert url["OPTIONS"] == {'sslmode': 'require'} def test_options_int_values(self) -> None: """Ensure that options with integer values are parsed correctly.""" url = dj_database_url.parse( "mysql://user:pw@127.0.0.1:15036/db?connect_timout=3" ) assert url["OPTIONS"] == {'connect_timout': 3} @mock.patch.dict( os.environ, {"DATABASE_URL": "postgres://user:password@instance.amazonaws.com:5431/d8r8?"}, ) def test_server_side_cursors__config(self) -> None: url = dj_database_url.config(disable_server_side_cursors=True) assert url["DISABLE_SERVER_SIDE_CURSORS"] is True if __name__ == "__main__": unittest.main()