pub/django-localized-fields
1
0
Fork 0
mirror of https://github.com/SectorLabs/django-localized-fields.git synced 2025-04-24 19:32:53 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated base classes in documentation

Browse Source
This commit is contained in:
Swen Kooij 2017-02-03 10:40:37 +02:00
parent bb11253207
commit 302a64a02c
2 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.rst
View File

@ -146,14 +146,14 @@ At the moment, it is not possible to select two languages to be marked as requir
.. code-block:: python
class MyModel(models.Model):
class MyModel(LocalizedModel):
title = LocalizedField(required=True)
* Make all languages optional:
.. code-block:: python
class MyModel(models.Model):
class MyModel(LocalizedModel):
title = LocalizedField(null=True)
**Uniqueness**
@ -164,7 +164,7 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e
.. code-block:: python
class MyModel(models.Model):
class MyModel(LocalizedModel):
title = LocalizedField(uniqueness=['en', 'ro'])
* Enforce uniqueness for **all** languages:
@ -173,14 +173,14 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e
from localized_fields import get_language_codes
class MyModel(models.Model):
class MyModel(LocalizedModel):
title = LocalizedField(uniqueness=get_language_codes())
* Enforce uniqueness for one ore more languages **together** (similar to Django's ``unique_together``):
.. code-block:: python
class MyModel(models.Model):
class MyModel(LocalizedModel):
title = LocalizedField(uniqueness=[('en', 'ro')])
* Enforce uniqueness for **all** languages **together**:
@ -189,7 +189,7 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e
from localized_fields import get_language_codes
class MyModel(models.Model):
class MyModel(LocalizedModel):
title = LocalizedField(uniqueness=[(*get_language_codes())])
@ -203,11 +203,12 @@ Besides ``LocalizedField``, there's also:
.. code-block:: python
from localized_fields.models import LocalizedModel
from localized_fields.fields import (LocalizedField,
LocalizedUniqueSlugField)
from localized_fields import (LocalizedModel,
AtomicSlugRetryMixin,
LocalizedField,
LocalizedUniqueSlugField)
class MyModel(LocalizedModel):
class MyModel(AtomicSlugRetryMixin, LocalizedModel):
title = LocalizedField()
slug = LocalizedUniqueSlugField(populate_from='title')
@ -218,9 +219,9 @@ Besides ``LocalizedField``, there's also:
.. code-block:: python
from localized_fields.models import LocalizedModel
from localized_fields.fields import (LocalizedField,
LocalizedAutoSlugField)
from localized_fields import (LocalizedModel,
LocalizedField,
LocalizedUniqueSlugField)
class MyModel(LocalizedModel):
title = LocalizedField()
@ -236,9 +237,9 @@ Besides ``LocalizedField``, there's also:
.. code-block:: python
from localized_fields.models import LocalizedModel
from localized_fields.fields import (LocalizedField,
LocalizedBleachField)
from localized_fields import (LocalizedModel,
LocalizedField,
LocalizedBleachField)
class MyModel(LocalizedModel):
title = LocalizedField()

4
localized_fields/fields/localized_uniqueslug_field.py
View File

@ -29,12 +29,12 @@ class LocalizedUniqueSlugField(LocalizedAutoSlugField):
self.populate_from = kwargs.pop('populate_from')
kwargs['uniqueness'] = kwargs.pop('uniqueness', get_language_codes())
super(LocalizedAutoSlugField, self).__init__(
super(LocalizedUniqueSlugField, self).__init__(
*args,
**kwargs
)
def pre_save(self, instance, add: bool):
def pre_save(self, instance, _add: bool):
"""Ran just before the model is saved, allows us to built
the slug.