nepali 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

nepali/locations/utils.py

@@ -1,8 +1,7 @@
 import re
 from functools import partial
 
-from ._locations import provinces, districts, municipalities
-
+from ._locations import districts, municipalities, provinces
 
 __all__ = [
     "get_province",

nepali/number/__init__.py

@@ -1,5 +1,5 @@
-from ._number import NepaliNumber
 from ._nepalinumber import nepalinumber
+from ._number import NepaliNumber
 from .utils import (
     add_comma,
     add_comma_english,

nepali/number/_nepalinumber.py

@@ -3,6 +3,7 @@ Contains the class for the nepalinumber feature
 """
 
 from typing import Any, Tuple, Type, Union
+
 from .utils import NP_NUMBERS, NP_NUMBERS_SET, english_to_nepali
 
 
@@ -19,10 +20,23 @@ class nepalinumber:
         """
         self.__value = self.__parse(value)
 
-    def _raise_parse_exception(self, obj, ex_class: Type[Exception] = ValueError):
-        raise ex_class(
+    def get_parse_exception(
+        self, obj: object, ex_class: Type[Exception] = ValueError
+    ) -> Exception:
+        """
+        Returns the exception object to be raised when the parse is failed.
+        The methods also sets a proper message to the exception class.
+
+        :param obj: Object that is failed during the parse
+        :type obj: object
+        :param ex_class: Exception class type to be returned, defaults to ValueError
+        :type ex_class: Type[Exception], optional
+        :return: Exception object to be raised
+        :rtype: Exception
+        """
+        return ex_class(
             f"could not convert {obj.__class__.__name__} to {self.__class__.__name__}: '{obj}'"
-        ) from None
+        )
 
     def __parse(self, value: Any) -> Union[int, float]:
         """
@@ -61,10 +75,10 @@ class nepalinumber:
 
         :raises ValueError: If the value is invalid
         """
-        result = 0
+        result: float = 0
         sign = 1
         decimal_found = False
-        decimal_place = 1
+        decimal_place: float = 1
         i = 0
 
         # for negative sign
@@ -77,7 +91,7 @@ class nepalinumber:
             if value[i] == ".":
                 if decimal_found:
                     # decimal was already found
-                    self._raise_parse_exception(value)
+                    raise self.get_parse_exception(value) from None
                 decimal_found = True
                 i += 1
                 continue
@@ -86,7 +100,7 @@ class nepalinumber:
             if digit < 0 or digit > 9:
                 # checking nepali character
                 if value[i] not in NP_NUMBERS_SET:
-                    self._raise_parse_exception(value)
+                    raise self.get_parse_exception(value) from None
                 digit = NP_NUMBERS.index(value[i])
 
             if decimal_found:
@@ -113,7 +127,7 @@ class nepalinumber:
             return self.__parse_str(str(obj))
         except (ValueError, TypeError):
             # object conversion must raise TypeError if fails
-            self._raise_parse_exception(obj, ex_class=TypeError)
+            raise self.get_parse_exception(obj, ex_class=TypeError) from None
 
     def __convert_or_return(self, obj) -> Union["nepalinumber", object]:
         """
@@ -184,7 +198,7 @@ class nepalinumber:
         Checks if nepalinumber is equal to another object
 
         :param other: The other number/object which is to be checked for
-            equality againt nepalinumber
+            equality against nepalinumber
         :return: True if equal else False
         """
         if isinstance(other, nepalinumber):
@@ -197,7 +211,7 @@ class nepalinumber:
         Checks if nepalinumber is not equal to another object
 
         :param other: The other number/object which is to be checked for
-            equality againt nepalinumber
+            equality against nepalinumber
         :return: True if not equal else False
         """
         if isinstance(other, nepalinumber):
@@ -349,7 +363,7 @@ class nepalinumber:
         the nepalinumber object
 
         :param other: The other number/object that is to get
-            dividied by the value in the nepalinumber object
+            divided by the value in the nepalinumber object
         :raises TypeError: Raised when nepalinumber object is
             used to divide unsupported data types
         :return: Returns the quotient number as a nepalinumber
@@ -388,7 +402,7 @@ class nepalinumber:
         before the nepalinumber object
 
         :param other: The other number/object that is to get
-            dividied by the value in the nepalinumber object
+            divided by the value in the nepalinumber object
         :raises TypeError: Raised when nepalinumber object is
             used to divide unsupported data types
         :return: Returns the quotient number as a nepalinumber

nepali/number/_number.py

@@ -1,11 +1,6 @@
 import warnings
 
-from .utils import (
-    add_comma,
-    add_comma_english,
-    english_to_nepali,
-    nepali_to_english,
-)
+from .utils import add_comma, add_comma_english, english_to_nepali, nepali_to_english
 
 
 # Backward compatibility support for legacy NepaliNumber

nepali/number/utils.py

@@ -1,6 +1,5 @@
 from typing import Any
 
-
 NP_NUMBERS = ["०", "१", "२", "३", "४", "५", "६", "७", "८", "९"]
 NP_NUMBERS_SET = set(NP_NUMBERS)
 
@@ -39,7 +38,7 @@ def add_comma_english(number: Any) -> str:
     Adds comma in english style
     Eg. 123456789 => 123,456,789
     """
-    return "{:,}".format(int(number))
+    return f"{int(number):,}"
 
 
 def add_comma(number: Any, convert=False) -> str:

nepali/phone_number.py

@@ -2,10 +2,9 @@ import re
 from enum import Enum
 from typing import Union
 
-
-_mobile_number_re = re.compile(r"^(?:\+977|977)?(?:-)?(?:98|97|96)[0-9]{8}$")
+_mobile_number_re = re.compile(r"^(?:\+977|977)?(?:-)?(?:98|97|96)\d{8}$")
 _landline_number_re = re.compile(
-    r"^(?:\+977|977)?(?:-)?(?:0)?(?:[01][1-9]|2[13-9]|[3-9][0-9])[0-9]{6,7}$"
+    r"^(?:\+977|977)?(?:-)?(?:0)?(?:[01][1-9]|2[13-9]|[3-9]\d)\d{6,7}$"
 )
 
 

nepali/templatetags/nepalidatetime.py

@@ -1,38 +1,201 @@
+"""
+This module contains django templatetags for nepali date and time.
+"""
+import datetime
+import warnings
+from typing import Optional, Union
+
 from django import template
 from django.utils import timezone
 
+from nepali.datetime import nepalidate as _nepalidate
+from nepali.datetime import nepalidatetime as _nepalidatetime
 from nepali.datetime import nepalihumanize as humanize
+from nepali.exceptions import InvalidNepaliDateTimeObjectException
 from nepali.utils import to_nepalidatetime
 
+_DEFAULT_DATE_FORMAT = "%B %d, %Y, %A"
+DEPRECIATION_WARNING_MESSAGE = (
+    "The templatetag 'nepalidatetime' has been depreciated "
+    "and will be removed in the future release. "
+    "Please use `django-nepali` package."
+)
+_datetime = Union[datetime.date, datetime.datetime, _nepalidate, _nepalidatetime]
 register = template.Library()
 
 
 @register.filter(name="nepalidate")
-def nepalidate(datetime_obj, format="%B %d, %Y, %A"):
-    nepali_datetime_obj = to_nepalidatetime(datetime_obj)
-    if nepali_datetime_obj is None:
-        return None
-    return nepali_datetime_obj.strftime(format)
+def nepalidate(
+    datetime_obj: _datetime, format: str = _DEFAULT_DATE_FORMAT
+) -> Union[str, None]:
+    """
+    Renders the datetime object into nepali datetime format in 'en-US' locale (English).
+
+    Usage:
+    ```
+    {{ datetime_obj|nepalidate }}
+    {{ datetime_obj|nepalidate:"%Y-%m-%d" }}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param format: Output format, defaults to "%B %d, %Y, %A"
+    :returns: Nepali datetime format in 'en-US' locale
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    return nepalidate_en(datetime_obj, format=format)
 
 
 @register.filter(name="nepalidate_en")
-def nepalidate_en(datetime_obj, format="%B %d, %Y, %A"):
-    nepali_datetime_obj = to_nepalidatetime(datetime_obj)
-    if nepali_datetime_obj is None:
+def nepalidate_en(
+    datetime_obj: _datetime, format: str = _DEFAULT_DATE_FORMAT
+) -> Union[str, None]:
+    """
+    Renders the datetime object into nepali datetime format in 'en-US' locale (English).
+
+    Usage:
+    ```
+    {{ datetime_obj|nepalidate_en }}
+    {{ datetime_obj|nepalidate_en:"%Y-%m-%d" }}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param format: Output format, defaults to "%B %d, %Y, %A"
+    :returns: Nepali datetime format in 'en-US' locale
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    try:
+        nepali_datetime_obj = to_nepalidatetime(datetime_obj)
+        return nepali_datetime_obj.strftime_en(format)
+    except InvalidNepaliDateTimeObjectException:
+        return None
+
+
+@register.filter(name="nepalidate_ne")
+def nepalidate_ne(
+    datetime_obj: _datetime, format: str = _DEFAULT_DATE_FORMAT
+) -> Union[str, None]:
+    """
+    Renders the datetime object into nepali datetime format in 'ne' locale (Nepali).
+
+    Usage:
+    ```
+    {{ datetime_obj|nepalidate_ne }}
+    {{ datetime_obj|nepalidate_ne:"%Y-%m-%d" }}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param format: Output format, defaults to "%B %d, %Y, %A"
+    :returns: Nepali datetime format in 'ne' locale
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    try:
+        nepali_datetime_obj = to_nepalidatetime(datetime_obj)
+        return nepali_datetime_obj.strftime_ne(format)
+    except InvalidNepaliDateTimeObjectException:
         return None
-    return nepali_datetime_obj.strftime_en(format)
 
 
 @register.filter(name="nepalihumanize")
-def nepalihumanize(datetime_obj, threshold=None, format=None):
-    """templatetag to humanize nepalidatetime"""
-    nepali_datetime_obj = to_nepalidatetime(datetime_obj)
-    if nepali_datetime_obj is None:
+def nepalihumanize(
+    datetime_obj: _datetime,
+    threshold: Optional[int] = None,
+    format: Optional[str] = None,
+) -> Union[str, None]:
+    """
+    Renders the datetime object to a human readable form for 'ne' locale (Nepali).
+
+    Usage:
+    ```
+    {{ datetime_obj|nepalihumanize }}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param threshold: Threshold in seconds that determines when to render
+        the datetime object in the standard datetime format, optional
+    :param format: Output format if threshold exceeded, optional
+    :returns: Datetime object in human readable form
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    try:
+        nepali_datetime_obj = to_nepalidatetime(datetime_obj)
+        return humanize(nepali_datetime_obj, threshold=threshold, format=format)
+    except InvalidNepaliDateTimeObjectException:
         return None
-    return humanize(nepali_datetime_obj, threshold=threshold, format=format)
 
 
 @register.simple_tag
-def nepalinow(format="%B %d, %Y, %A"):
-    """templatetag to display current datetime in nepali format"""
+def nepalinow(format: str = _DEFAULT_DATE_FORMAT) -> str:
+    """
+    Renders the current nepali datetime in 'en-US' locale (English).
+
+    Usage:
+    ```
+    {% nepalinow %}
+    {% nepalinow '%Y-%m-%d' %}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param format: Output format, defaults to "%B %d, %Y, %A"
+    :returns: Current nepali datetime
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    return nepalinow_en(format)
+
+
+@register.simple_tag
+def nepalinow_en(format: str = _DEFAULT_DATE_FORMAT) -> str:
+    """
+    Renders the current nepali datetime in 'en-US' locale (English).
+
+    Usage:
+    ```
+    {% nepalinow_en %}
+    {% nepalinow_en '%Y-%m-%d' %}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param format: Output format, defaults to "%B %d, %Y, %A"
+    :returns: Current nepali datetime
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
     return to_nepalidatetime(timezone.now()).strftime(format)
+
+
+@register.simple_tag
+def nepalinow_ne(format: str = _DEFAULT_DATE_FORMAT) -> str:
+    """
+    Renders the current nepali datetime in 'ne' locale (Nepali).
+
+    Usage:
+    ```
+    {% nepalinow_ne %}
+    {% nepalinow_ne '%Y-%m-%d' %}
+    ```
+
+    :param datetime_obj: Datetime object
+    :param format: Output format, defaults to "%B %d, %Y, %A"
+    :returns: Current nepali datetime
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    return to_nepalidatetime(timezone.now()).strftime_ne(format)

nepali/templatetags/nepalinumber.py

@@ -1,15 +1,103 @@
+"""
+This module contains django templatetags for nepali number.
+"""
+import warnings
+from typing import Any
+
 from django import template
 
-from nepali.number import nepali_to_english, convert_and_add_comma
+from nepali.number import (
+    add_comma,
+    add_comma_english,
+    convert_and_add_comma,
+    english_to_nepali,
+)
 
 register = template.Library()
 
+DEPRECIATION_WARNING_MESSAGE = (
+    "The templatetag 'nepalinumber' has been depreciated "
+    "and will be removed in the future release. "
+    "Please use `django-nepali` package."
+)
+
 
 @register.filter(name="nepalinumber")
-def nepalinumber(value):
-    return nepali_to_english(value)
+def nepalinumber(value: Any) -> str:
+    """
+    Converts the number into nepali number and renders it.
+
+    Usage:
+    ```
+    {{ number|nepalinumber }}
+    ```
+
+    :param value: Number to be converted
+    :returns: Nepali output of given number
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    return english_to_nepali(value)
 
 
 @register.filter(name="nepalinumber_with_comma")
-def nepalinumber_with_comma(value):
+def nepalinumber_with_comma(value: Any) -> str:
+    """
+    Converts the number into nepali number and renders it.
+
+    Usage:
+    ```
+    {{ number|nepalinumber_with_comma }}
+    ```
+    Basically same as `{{ number|nepalinumber|nepali_comma }}`
+
+    :param value: Number to be converted and commas added
+    :returns: Nepali output of given number with commas
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
     return convert_and_add_comma(value)
+
+
+@register.filter(name="nepali_comma")
+def nepali_comma(value: Any) -> str:
+    """
+    Renders the given value with commas added in Nepali style without converting the number.
+
+    Usage:
+    ```
+    {{ number|nepali_comma }}
+    ```
+
+    :param value: Number to be added with commas
+    :returns: Output of given number with commas
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    return add_comma(value)
+
+
+@register.filter(name="english_comma")
+def english_comma(value: Any) -> str:
+    """
+    Renders the given value with commas added in English style without converting the number.
+
+    Usage:
+    ```
+    {{ number|english_comma }}
+    ```
+
+    :param value: Number to be added with commas
+    :returns: Output of given number with commas
+    """
+    warnings.warn(
+        message=DEPRECIATION_WARNING_MESSAGE,
+        category=DeprecationWarning,
+    )
+    return add_comma_english(value)

nepali/tests/test_datetime.py

@@ -1,8 +1,8 @@
 import datetime
 import unittest
 
-from nepali.datetime import nepalidate, nepalitime, nepalidatetime
-from nepali.datetime.utils import to_nepalidatetime, to_nepalidate
+from nepali.datetime import nepalidate, nepalidatetime, nepalitime
+from nepali.datetime.utils import to_nepalidate, to_nepalidatetime
 from nepali.exceptions import InvalidNepaliDateTimeObjectException
 from nepali.timezone import NepaliTimeZone
 
@@ -250,9 +250,7 @@ class TestNepaliDateTime(unittest.TestCase):
         self.assertEqual(
             nepalidatetime_obj1,
             nepalidatetime_obj2,
-            msg="{} and {} are not equal".format(
-                nepalidatetime_obj1, nepalidatetime_obj2
-            ),
+            msg=f"{nepalidatetime_obj1} and {nepalidatetime_obj2} are not equal",
         )
 
 

nepali/tests/test_humanize.py

@@ -2,11 +2,10 @@ import datetime
 import unittest
 from unittest.mock import patch
 
-from nepali.datetime import nepalihumanize, HumanizeDateTime, nepalidate, nepalidatetime
+from nepali.datetime import HumanizeDateTime, nepalidate, nepalidatetime, nepalihumanize
 from nepali.exceptions import InvalidNepaliDateTimeObjectException
 from nepali.timezone import NepaliTimeZone
 
-
 REF_TIME = datetime.datetime(2015, 1, 1, 10, 15, tzinfo=NepaliTimeZone())
 
 

nepali/tests/test_locations.py

@@ -2,17 +2,17 @@ import unittest
 
 from nepali import locations
 from nepali.locations.models import (
+    District,
     Location,
+    Municipality,
     MunicipalityType,
     Province,
-    District,
-    Municipality,
 )
 from nepali.locations.utils import (
     _filter_location,
-    get_province,
     get_district,
     get_municipality,
+    get_province,
 )