Merge pull request #44 from aj3sh/formatting

Code formatting and updated pre-commit hook

Author: sugat009

.github/workflows/python-package.yml

@@ -35,8 +35,8 @@ jobs:
           # stop the build if there are Python syntax errors or undefined names
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
           # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-
+          flake8 . --count --exit-zero --max-complexity=10 --ignore=E203,W503 --max-line-length=127 --statistics
+          # For the reason behind ignoring E203 and W503, visit https://blackq.readthedocs.io/en/stable/faq.html#why-are-flake8-s-e203-and-w503-violated
       - name: Run tests
         run: |
           coverage run -m unittest discover nepali/tests -v

.pre-commit-config.yaml

@@ -1,10 +1,16 @@
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
     hooks:
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 22.10.0
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/akaihola/darker
+    rev: 1.7.1
     hooks:
-    -   id: black
+      - id: darker
+        args:
+          - --isort
+          - --lint=flake8 --max-line-length=88
+        additional_dependencies:
+          - isort==5.11.5
+          - flake8==5.0.4

nepali/number/_nepalinumber.py

@@ -126,7 +126,7 @@ def __convert_or_return(self, obj) -> Union["nepalinumber", object]:
         """
         try:
             return nepalinumber(obj)
-        except (TypeError, ValueError) as e:
+        except (TypeError, ValueError):
             return obj
 
     def __str__(self) -> str:

nepali/number/_number.py

@@ -13,39 +13,46 @@ class NepaliNumber:
     @classmethod
     def convert_and_add_comma(cls, number):
         warnings.warn(
-            message="NepaliNumber.convert_and_add_comma has been moved to `convert_and_add_comma. This function is depreciated and will be removed in the future release.",
+            message="NepaliNumber.convert_and_add_comma has been moved to "
+            "`convert_and_add_comma. This function is depreciated and will "
+            "be removed in the future release.",
             category=DeprecationWarning,
         )
         return add_comma(english_to_nepali(number))
 
     @staticmethod
     def convert(num):
         warnings.warn(
-            message="NepaliNumber.convert has been moved to `english_to_nepali. This function is depreciated and will be removed in the future release.",
+            message="NepaliNumber.convert has been moved to `english_to_nepali. "
+            "This function is depreciated and will be removed in the future release.",
             category=DeprecationWarning,
         )
         return english_to_nepali(num)
 
     @staticmethod
     def revert(num):
         warnings.warn(
-            message="NepaliNumber.revert has been moved to `nepali_to_english. This function is depreciated and will be removed in the future release.",
+            message="NepaliNumber.revert has been moved to `nepali_to_english. "
+            "This function is depreciated and will be removed in the future release.",
             category=DeprecationWarning,
         )
         return nepali_to_english(num)
 
     @staticmethod
     def add_comma(number):
         warnings.warn(
-            message="NepaliNumber.add_comma has been moved to `add_comma. This function is depreciated and will be removed in the future release.",
+            message="NepaliNumber.add_comma has been moved to `add_comma. "
+            "This function is depreciated and will be removed in the future release.",
             category=DeprecationWarning,
         )
         return add_comma(number)
 
     @staticmethod
     def add_comma_english(number):
         warnings.warn(
-            message="NepaliNumber.add_comma_english has been moved to `add_comma_english. This function is depreciated and will be removed in the future release.",
+            message="NepaliNumber.add_comma_english has been moved to "
+            "`add_comma_english. This function is depreciated and will "
+            "be removed in the future release.",
             category=DeprecationWarning,
         )
         return add_comma_english(number)

nepali/phone_number.py

@@ -33,7 +33,7 @@ def is_mobile_number(number: str) -> bool:
     """
     try:
         return bool(_mobile_number_re.match(number))
-    except:
+    except Exception:
         return False
 
 
@@ -47,7 +47,7 @@ def is_landline_number(number: str) -> bool:
     """
     try:
         return bool(_landline_number_re.match(number))
-    except:
+    except Exception:
         return False
 
 

nepali/tests/test_number.py

@@ -2961,23 +2961,23 @@ def test_nepalinumber_raises_exception_for_chars_english(self):
         )
 
     def test_nepalinumber_raises_exception_for_chars_nepali(self):
-        with self.assertRaises(ValueError) as ex:
+        with self.assertRaises(ValueError):
             nepalinumber("आइतबार")
 
     def test_nepalinumber_raises_exception_for_two_dots(self):
-        with self.assertRaises(ValueError) as ex:
+        with self.assertRaises(ValueError):
             nepalinumber("10..5")
 
     def test_nepalinumber_raises_exception_for_nepali_aplha(self):
-        with self.assertRaises(ValueError) as ex:
+        with self.assertRaises(ValueError):
             nepalinumber("10..5")
 
     def test_nepalinumber_raises_exception_for_special_chars(self):
-        with self.assertRaises(ValueError) as ex:
+        with self.assertRaises(ValueError):
             nepalinumber("!@#$%^&*()-+")
 
     def test_nepalinumber_raise_exception_for_number_with_spaces(self):
-        with self.assertRaises(ValueError) as ex:
+        with self.assertRaises(ValueError):
             nepalinumber("10 20")
 
     def test_nepalinumber_raises_exception_on_complex_number(self):

setup.py

@@ -37,7 +37,9 @@
     version="1.0.0",
     author="opensource-nepal",
     author_email="[email protected], [email protected]",
-    description="nepalidatetime compatible with python's datetime feature. Converting nepali date to english, parsing nepali datetime, nepali timezone, and timedelta support in nepali datetime",
+    description="nepalidatetime compatible with python's datetime feature. "
+    "Converting nepali date to english, parsing nepali datetime, "
+    "nepali timezone, and timedelta support in nepali datetime",
     long_description=long_description,
     long_description_content_type="text/markdown",
     keywords=[