mirror of
https://github.com/SectorLabs/django-localized-fields.git
synced 2025-04-24 19:32:53 +03:00
Ported to use django-postgres-extra
This commit is contained in:
Swen Kooij
parent
b9a4d3be2c
commit
d7bd217a90
@ -1,224 +0,0 @@
|
||||
import importlib
|
||||
|
||||
from django.conf import settings
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
from django.db.backends.postgresql.base import \
|
||||
DatabaseWrapper as Psycopg2DatabaseWrapper
|
||||
|
||||
from ..fields import LocalizedField
|
||||
|
||||
|
||||
def _get_backend_base():
|
||||
"""Gets the base class for the custom database back-end.
|
||||
|
||||
This should be the Django PostgreSQL back-end. However,
|
||||
some people are already using a custom back-end from
|
||||
another package. We are nice people and expose an option
|
||||
that allows them to configure the back-end we base upon.
|
||||
|
||||
As long as the specified base eventually also has
|
||||
the PostgreSQL back-end as a base, then everything should
|
||||
work as intended.
|
||||
"""
|
||||
base_class_name = getattr(
|
||||
settings,
|
||||
'LOCALIZED_FIELDS_DB_BACKEND_BASE',
|
||||
'django.db.backends.postgresql'
|
||||
)
|
||||
|
||||
base_class_module = importlib.import_module(base_class_name + '.base')
|
||||
base_class = getattr(base_class_module, 'DatabaseWrapper', None)
|
||||
|
||||
if not base_class:
|
||||
raise ImproperlyConfigured((
|
||||
'\'%s\' is not a valid database back-end.'
|
||||
' The module does not define a DatabaseWrapper class.'
|
||||
' Check the value of LOCALIZED_FIELDS_DB_BACKEND_BASE.'
|
||||
) % base_class_name)
|
||||
|
||||
if isinstance(base_class, Psycopg2DatabaseWrapper):
|
||||
raise ImproperlyConfigured((
|
||||
'\'%s\' is not a valid database back-end.'
|
||||
' It does inherit from the PostgreSQL back-end.'
|
||||
' Check the value of LOCALIZED_FIELDS_DB_BACKEND_BASE.'
|
||||
) % base_class_name)
|
||||
|
||||
return base_class
|
||||
|
||||
|
||||
def _get_schema_editor_base():
|
||||
"""Gets the base class for the schema editor.
|
||||
|
||||
We have to use the configured base back-end's
|
||||
schema editor for this."""
|
||||
return _get_backend_base().SchemaEditorClass
|
||||
|
||||
|
||||
class SchemaEditor(_get_schema_editor_base()):
|
||||
"""Custom schema editor for hstore indexes.
|
||||
|
||||
This allows us to put UNIQUE constraints for
|
||||
localized fields."""
|
||||
|
||||
sql_hstore_unique_create = "CREATE UNIQUE INDEX {name} ON {table}{using} ({columns}){extra}"
|
||||
sql_hstore_unique_drop = "DROP INDEX IF EXISTS {name}"
|
||||
|
||||
@staticmethod
|
||||
def _hstore_unique_name(model, field, keys):
|
||||
"""Gets the name for a UNIQUE INDEX that applies
|
||||
to one or more keys in a hstore field.
|
||||
|
||||
Arguments:
|
||||
model:
|
||||
The model the field is a part of.
|
||||
|
||||
field:
|
||||
The hstore field to create a
|
||||
UNIQUE INDEX for.
|
||||
|
||||
key:
|
||||
The name of the hstore key
|
||||
to create the name for.
|
||||
|
||||
This can also be a tuple
|
||||
of multiple names.
|
||||
|
||||
Returns:
|
||||
The name for the UNIQUE index.
|
||||
"""
|
||||
postfix = '_'.join(keys)
|
||||
return '{table_name}_{field_name}_unique_{postfix}'.format(
|
||||
table_name=model._meta.db_table,
|
||||
field_name=field.column,
|
||||
postfix=postfix
|
||||
)
|
||||
|
||||
def _drop_hstore_unique(self, model, field, keys):
|
||||
"""Drops a UNIQUE constraint for the specified hstore keys."""
|
||||
|
||||
name = self._hstore_unique_name(model, field, keys)
|
||||
sql = self.sql_hstore_unique_drop.format(name=name)
|
||||
self.execute(sql)
|
||||
|
||||
def _create_hstore_unique(self, model, field, keys):
|
||||
"""Creates a UNIQUE constraint for the specified hstore keys."""
|
||||
|
||||
name = self._hstore_unique_name(model, field, keys)
|
||||
columns = [
|
||||
'(%s->\'%s\')' % (field.column, key)
|
||||
for key in keys
|
||||
]
|
||||
sql = self.sql_hstore_unique_create.format(
|
||||
name=name,
|
||||
table=model._meta.db_table,
|
||||
using='',
|
||||
columns=','.join(columns),
|
||||
extra=''
|
||||
)
|
||||
self.execute(sql)
|
||||
|
||||
def _apply_hstore_constraints(self, method, model, field):
|
||||
"""Creates/drops UNIQUE constraints for a field."""
|
||||
|
||||
def _compose_keys(constraint):
|
||||
if isinstance(constraint, str):
|
||||
return [constraint]
|
||||
|
||||
return constraint
|
||||
|
||||
uniqueness = getattr(field, 'uniqueness', None)
|
||||
if not uniqueness:
|
||||
return
|
||||
|
||||
for keys in uniqueness:
|
||||
method(
|
||||
model,
|
||||
field,
|
||||
_compose_keys(keys)
|
||||
)
|
||||
|
||||
def _update_hstore_constraints(self, model, old_field, new_field):
|
||||
"""Updates the UNIQUE constraints for the specified field."""
|
||||
|
||||
old_uniqueness = getattr(old_field, 'uniqueness', None)
|
||||
new_uniqueness = getattr(new_field, 'uniqueness', None)
|
||||
|
||||
# drop any old uniqueness constraints
|
||||
if old_uniqueness:
|
||||
self._apply_hstore_constraints(
|
||||
self._drop_hstore_unique,
|
||||
model,
|
||||
old_field
|
||||
)
|
||||
|
||||
# (re-)create uniqueness constraints
|
||||
if new_uniqueness:
|
||||
self._apply_hstore_constraints(
|
||||
self._create_hstore_unique,
|
||||
model,
|
||||
new_field
|
||||
)
|
||||
|
||||
def _alter_field(self, model, old_field, new_field, *args, **kwargs):
|
||||
"""Ran when the configuration on a field changed."""
|
||||
|
||||
super()._alter_field(
|
||||
model, old_field, new_field,
|
||||
*args, **kwargs
|
||||
)
|
||||
|
||||
is_old_field_localized = isinstance(old_field, LocalizedField)
|
||||
is_new_field_localized = isinstance(new_field, LocalizedField)
|
||||
|
||||
if is_old_field_localized or is_new_field_localized:
|
||||
self._update_hstore_constraints(model, old_field, new_field)
|
||||
|
||||
def create_model(self, model):
|
||||
"""Ran when a new model is created."""
|
||||
|
||||
super().create_model(model)
|
||||
|
||||
for field in model._meta.local_fields:
|
||||
if not isinstance(field, LocalizedField):
|
||||
continue
|
||||
|
||||
self._apply_hstore_constraints(
|
||||
self._create_hstore_unique,
|
||||
model,
|
||||
field
|
||||
)
|
||||
|
||||
def delete_model(self, model):
|
||||
"""Ran when a model is being deleted."""
|
||||
|
||||
super().delete_model(model)
|
||||
|
||||
for field in model._meta.local_fields:
|
||||
if not isinstance(field, LocalizedField):
|
||||
continue
|
||||
|
||||
self._apply_hstore_constraints(
|
||||
self._drop_hstore_unique,
|
||||
model,
|
||||
field
|
||||
)
|
||||
|
||||
|
||||
class DatabaseWrapper(_get_backend_base()):
|
||||
"""Wraps the standard PostgreSQL database back-end.
|
||||
|
||||
Overrides the schema editor with our custom
|
||||
schema editor and makes sure the `hstore`
|
||||
extension is enabled."""
|
||||
|
||||
SchemaEditorClass = SchemaEditor
|
||||
|
||||
def prepare_database(self):
|
||||
"""Ran to prepare the configured database.
|
||||
|
||||
This is where we enable the `hstore` extension
|
||||
if it wasn't enabled yet."""
|
||||
|
||||
super().prepare_database()
|
||||
with self.cursor() as cursor:
|
||||
cursor.execute('CREATE EXTENSION IF NOT EXISTS hstore')
|
||||
@ -1,8 +1,8 @@
|
||||
from django.conf import settings
|
||||
from django.contrib.postgres.fields import HStoreField
|
||||
from django.db.utils import IntegrityError
|
||||
|
||||
from localized_fields import LocalizedFieldForm
|
||||
from psqlextra.fields import HStoreField
|
||||
|
||||
from ..localized_value import LocalizedValue
|
||||
|
||||
|
||||
@ -14,12 +14,11 @@ class LocalizedField(HStoreField):
|
||||
|
||||
Meta = None
|
||||
|
||||
def __init__(self, *args, uniqueness=None, **kwargs):
|
||||
"""Initializes a new instance of :see:LocalizedValue."""
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""Initializes a new instance of :see:LocalizedField."""
|
||||
|
||||
super(LocalizedField, self).__init__(*args, **kwargs)
|
||||
|
||||
self.uniqueness = uniqueness
|
||||
super(LocalizedField, self).__init__(
|
||||
*args, required=[settings.LANGUAGE_CODE], **kwargs)
|
||||
|
||||
@staticmethod
|
||||
def from_db_value(value, *_):
|
||||
|
||||
1
requirements/base.txt
Normal file
1
requirements/base.txt
Normal file
@ -0,0 +1 @@
|
||||
django-postgres-extra==1.0
|
||||
@ -11,7 +11,7 @@ DATABASES = {
|
||||
'default': dj_database_url.config(default='postgres:///localized_fields')
|
||||
}
|
||||
|
||||
DATABASES['default']['ENGINE'] = 'localized_fields.db_backend'
|
||||
DATABASES['default']['ENGINE'] = 'psqlextra.backend'
|
||||
|
||||
LANGUAGE_CODE = 'en'
|
||||
LANGUAGES = (
|
||||
|
||||
@ -1,87 +0,0 @@
|
||||
from unittest import mock
|
||||
|
||||
from django.db import connection
|
||||
from django.apps import apps
|
||||
from django.conf import settings
|
||||
from django.test import TestCase
|
||||
from django.db.backends.base.schema import BaseDatabaseSchemaEditor
|
||||
|
||||
from localized_fields import LocalizedField, get_language_codes
|
||||
|
||||
from .fake_model import define_fake_model
|
||||
|
||||
|
||||
class DBBackendTestCase(TestCase):
|
||||
"""Tests the custom database back-end."""
|
||||
|
||||
@staticmethod
|
||||
def test_hstore_extension_enabled():
|
||||
"""Tests whether the `hstore` extension was
|
||||
enabled automatically."""
|
||||
|
||||
with connection.cursor() as cursor:
|
||||
cursor.execute((
|
||||
'SELECT count(*) FROM pg_extension '
|
||||
'WHERE extname = \'hstore\''
|
||||
))
|
||||
|
||||
assert cursor.fetchone()[0] == 1
|
||||
|
||||
@classmethod
|
||||
def test_migration_create_drop_model(cls):
|
||||
"""Tests whether models containing a :see:LocalizedField
|
||||
with a `uniqueness` constraint get created properly,
|
||||
with the contraints in the database."""
|
||||
|
||||
model = define_fake_model('NewModel', {
|
||||
'title': LocalizedField(uniqueness=get_language_codes())
|
||||
})
|
||||
|
||||
# create the model in db and verify the indexes are being created
|
||||
with mock.patch.object(BaseDatabaseSchemaEditor, 'execute') as execute:
|
||||
with connection.schema_editor() as schema_editor:
|
||||
schema_editor.create_model(model)
|
||||
|
||||
create_index_calls = [
|
||||
call for call in execute.mock_calls if 'CREATE UNIQUE INDEX' in str(call)
|
||||
]
|
||||
|
||||
assert len(create_index_calls) == len(settings.LANGUAGES)
|
||||
|
||||
# delete the model in the db and verify the indexes are being deleted
|
||||
with mock.patch.object(BaseDatabaseSchemaEditor, 'execute') as execute:
|
||||
with connection.schema_editor() as schema_editor:
|
||||
schema_editor.delete_model(model)
|
||||
|
||||
drop_index_calls = [
|
||||
call for call in execute.mock_calls if 'DROP INDEX' in str(call)
|
||||
]
|
||||
|
||||
assert len(drop_index_calls) == len(settings.LANGUAGES)
|
||||
|
||||
@classmethod
|
||||
def test_migration_alter_field(cls):
|
||||
"""Tests whether the back-end correctly removes and
|
||||
adds `uniqueness` constraints when altering a :see:LocalizedField."""
|
||||
|
||||
define_fake_model('ExistingModel', {
|
||||
'title': LocalizedField(uniqueness=get_language_codes())
|
||||
})
|
||||
|
||||
app_config = apps.get_app_config('tests')
|
||||
|
||||
with mock.patch.object(BaseDatabaseSchemaEditor, 'execute') as execute:
|
||||
with connection.schema_editor() as schema_editor:
|
||||
dynmodel = app_config.get_model('ExistingModel')
|
||||
schema_editor.alter_field(
|
||||
dynmodel,
|
||||
dynmodel._meta.fields[1],
|
||||
dynmodel._meta.fields[1]
|
||||
)
|
||||
|
||||
index_calls = [
|
||||
call for call in execute.mock_calls
|
||||
if 'INDEX' in str(call) and 'title' in str(call)
|
||||
]
|
||||
|
||||
assert len(index_calls) == len(settings.LANGUAGES) * 2
|
||||
Loading…
x
Reference in New Issue
Block a user