Added deprecated marker to docstrings.

django · Aug 12, 2017 · 067ed1c · 067ed1c
1 parent b0fe8da
commit 067ed1c
Show file tree

Hide file tree

Showing 33 changed files with 234 additions and 38 deletions.
diff --git a/localflavor/au/forms.py b/localflavor/au/forms.py
@@ -40,6 +40,11 @@ class AUPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumber
     A form field that validates input as an Australian phone number.
 
     Valid numbers have ten digits.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/au/models.py b/localflavor/au/models.py
@@ -48,7 +48,14 @@ def formfield(self, **kwargs):
 
 
 class AUPhoneNumberField(CharField, DeprecatedPhoneNumberField):
-    """A model field that checks that the value is a valid Australian phone number (ten digits)."""
+    """
+    A model field that checks that the value is a valid Australian phone number (ten digits).
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
+    """
 
     description = _("Australian Phone number")
 

diff --git a/localflavor/be/forms.py b/localflavor/be/forms.py
@@ -44,6 +44,11 @@ class BEPhoneNumberField(RegexField, DeprecatedPhoneNumberFormFieldMixin):
     0dddddddd - dialling a smaller city
     04dd ddd dd dd, 04dd/ddd.dd.dd,
     04dd.ddd.dd.dd, 04ddddddddd - dialling a mobile number
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/br/forms.py b/localflavor/br/forms.py
@@ -44,6 +44,11 @@ class BRPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
     A form field that validates input as a Brazilian phone number.
 
     The phone number must be in either of the following formats: XX-XXXX-XXXX or XX-XXXXX-XXXX.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {
@@ -101,6 +106,10 @@ def dv_maker(v):
 
 
 def DV_maker(v):  # noqa
+    """
+    .. deprecated:: 1.6
+        Use `dv_maker` instead.
+    """
     warnings.warn('DV_maker is deprecated. Please use dv_maker instead.', RemovedInLocalflavor20Warning)
     return dv_maker(v)
 

diff --git a/localflavor/ca/forms.py b/localflavor/ca/forms.py
@@ -47,7 +47,14 @@ def clean(self, value):
 
 
 class CAPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
-    """Canadian phone number form field."""
+    """
+    Canadian phone number form field.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
+    """
 
     default_error_messages = {
         'invalid': _('Phone numbers must be in XXX-XXX-XXXX format.'),

diff --git a/localflavor/ch/forms.py b/localflavor/ch/forms.py
@@ -47,6 +47,11 @@ class CHPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
     The correct format is '0XX XXX XX XX'.
     '0XX.XXX.XX.XX' and '0XXXXXXXXX' validate but are corrected to
     '0XX XXX XX XX'.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/cn/forms.py b/localflavor/cn/forms.py
@@ -176,6 +176,11 @@ class CNPhoneNumberField(RegexField, DeprecatedPhoneNumberFormFieldMixin):
 
     A valid phone number could be like: 010-12345678.
     Considering there might be extension numbers, this could also be: 010-12345678-35.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {
@@ -197,9 +202,12 @@ class CNCellNumberField(RegexField, DeprecatedPhoneNumberFormFieldMixin):
     The total length of a cellphone number should be 11.
 
     .. versionchanged:: 1.1
-
        Added 7 as a valid second digit for Chinese virtual mobile ISPs.
 
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/dk/forms.py b/localflavor/dk/forms.py
@@ -40,6 +40,11 @@ class DKPhoneNumberField(fields.RegexField, DeprecatedPhoneNumberFormFieldMixin)
     Field with phone number validation.
 
     Requires a phone number with 8 digits and optional country code.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/es/forms.py b/localflavor/es/forms.py
@@ -46,6 +46,11 @@ class ESPhoneNumberField(RegexField, DeprecatedPhoneNumberFormFieldMixin):
     phones)
 
     TODO: accept and strip characters like dot, hyphen... in phone number
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/fr/forms.py b/localflavor/fr/forms.py
@@ -49,6 +49,11 @@ class FRPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumber
     The correct format is '0X XX XX XX XX'.
     '0X.XX.XX.XX.XX' and '0XXXXXXXXX' validate but are corrected to
     '0X XX XX XX XX'.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     phone_digits_re = re.compile(r'^0\d(\s|\.)?(\d{2}(\s|\.)?){3}\d{2}$')

diff --git a/localflavor/gr/forms.py b/localflavor/gr/forms.py
@@ -72,6 +72,11 @@ class GRPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
     Greek general phone field.
 
     10 digits (can also start with +30 which is the country-code for greece)
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {
@@ -99,6 +104,11 @@ class GRMobilePhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
     Greek mobile phone field.
 
     10 digits starting with 69 (could also start with +30 which is the country-code for greece)
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/hk/forms.py b/localflavor/hk/forms.py
@@ -30,6 +30,11 @@ class HKPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumber
           And, it should start with either 2, 3, 5, 6, 8, or 9.
 
     http://en.wikipedia.org/wiki/Telephone_numbers_in_Hong_Kong
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/hr/forms.py b/localflavor/hr/forms.py
@@ -214,6 +214,11 @@ class HRPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
     digit number.
     Validates fixed, mobile and FGSM numbers. Normalizes to a full number with
     country code (+385 prefix).
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/id_/forms.py b/localflavor/id_/forms.py
@@ -64,6 +64,11 @@ class IDPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
     An Indonesian telephone number field.
 
     http://id.wikipedia.org/wiki/Daftar_kode_telepon_di_Indonesia
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/il/forms.py b/localflavor/il/forms.py
@@ -74,7 +74,14 @@ def clean(self, value):
 
 
 class ILMobilePhoneNumberField(RegexField, DeprecatedPhoneNumberFormFieldMixin):
-    """A form field that validates its input as an Israeli Mobile phone number."""
+    """
+    A form field that validates its input as an Israeli Mobile phone number.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
+    """
 
     default_error_messages = {
         'invalid': _('Enter a valid Mobile Number.'),

diff --git a/localflavor/in_/forms.py b/localflavor/in_/forms.py
@@ -160,6 +160,11 @@ class INPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumber
     digits if the STD code is 4 digits and 6 digits if the STD code is 5
     digits. The second string will start with numbers between 1 and 6. The
     separator is either a space or a hyphen.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/is_/forms.py b/localflavor/is_/forms.py
@@ -65,6 +65,11 @@ class ISPhoneNumberField(EmptyValueCompatMixin, RegexField, DeprecatedPhoneNumbe
     Icelandic phone number.
 
     Seven digits with an optional hyphen or space after the first three digits.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     def __init__(self, max_length=8, min_length=7, *args, **kwargs):

diff --git a/localflavor/it/forms.py b/localflavor/it/forms.py
@@ -124,6 +124,11 @@ class ITPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumber
     Will strip any +39 country prefix from the number.
 
     .. versionadded:: 1.1
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/lt/forms.py b/localflavor/lt/forms.py
@@ -140,6 +140,11 @@ class LTPhoneField(Field, DeprecatedPhoneNumberFormFieldMixin):
     not converted.
 
     .. versionadded:: 1.1
+
+    .. deprecated:: 1.6
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     # Order dependent (shorter codes cannot go before longer ones)

diff --git a/localflavor/nl/forms.py b/localflavor/nl/forms.py
@@ -35,7 +35,14 @@ def __init__(self, attrs=None):
 
 
 class NLPhoneNumberField(forms.CharField, DeprecatedPhoneNumberFormFieldMixin):
-    """A Dutch telephone number field."""
+    """
+    A Dutch telephone number field.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
+    """
 
     default_validators = [NLPhoneNumberFieldValidator()]
 

diff --git a/localflavor/nl/models.py b/localflavor/nl/models.py
@@ -94,6 +94,10 @@ class NLPhoneNumberField(models.CharField, DeprecatedPhoneNumberField):
     This model field uses :class:`validators.NLPhoneNumberFieldValidator` for validation.
 
     .. versionadded:: 1.3
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     description = _('Dutch phone number')

diff --git a/localflavor/no/forms.py b/localflavor/no/forms.py
@@ -170,6 +170,11 @@ class NOPhoneNumberField(RegexField, DeprecatedPhoneNumberFormFieldMixin):
     Field with phonenumber validation.
 
     Requires a phone number with 8 digits and optional country code
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/nz/forms.py b/localflavor/nz/forms.py
@@ -64,7 +64,14 @@ def __init__(self, *args, **kwargs):
 
 
 class NZPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
-    """A form field that validates its input as New Zealand phone number."""
+    """
+    A form field that validates its input as New Zealand phone number.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
+    """
 
     default_error_messages = {'invalid': _('Invalid phone number.')}
 

diff --git a/localflavor/pk/forms.py b/localflavor/pk/forms.py
@@ -38,6 +38,11 @@ class PKPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumber
     A form field that validates input as an Pakistani phone number.
 
     Valid numbers have nine to eleven digits.
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/pk/models.py b/localflavor/pk/models.py
@@ -47,7 +47,14 @@ def formfield(self, **kwargs):
 
 
 class PKPhoneNumberField(CharField, DeprecatedPhoneNumberField):
-    """A model field that checks that the value is a valid Pakistani phone number (nine to eleven digits)."""
+    """
+    A model field that checks that the value is a valid Pakistani phone number (nine to eleven digits).
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
+    """
 
     description = _("Pakistani Phone number")
 

diff --git a/localflavor/pt/forms.py b/localflavor/pt/forms.py
@@ -86,6 +86,11 @@ class PTPhoneNumberField(Field, DeprecatedPhoneNumberFormFieldMixin):
 
     - Phone numbers have at least 3 and at most 9 digits and may optionally be prefixed with '00351' or '+351'.
     - The input string is allowed to contain spaces (though they will be stripped).
+
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {

diff --git a/localflavor/ro/forms.py b/localflavor/ro/forms.py
@@ -210,6 +210,10 @@ class ROPhoneNumberField(EmptyValueCompatMixin, RegexField, DeprecatedPhoneNumbe
         | Official documentation (in English): http://www.ancom.org.ro/en/pnn_1300
         | Official documentation (in Romanian): http://www.ancom.org.ro/pnn_1300
 
+    .. deprecated:: 1.4
+        Use the django-phonenumber-field_ library instead.
+
+    .. _django-phonenumber-field: https://github.com/stefanfoulis/django-phonenumber-field
     """
 
     default_error_messages = {