arabic-datetime 0.0.0__py3-none-any.whl

arabic_datetime/__init__.py

@@ -0,0 +1,2 @@
+from . arabic_date import Arabic_Date
+from . arabic_time import Arabic_Time

arabic_datetime/arabic_date.py

@@ -0,0 +1,139 @@
+from typing import Union
+import datetime
+
+# Import constants
+from . constants import MONTH_GROUPS, AR_NUMS
+
+
+class Arabic_Date:
+    def __init__(self, date_object: Union[datetime.date, datetime.datetime]) -> None:
+        if not isinstance(date_object, datetime.date) and not isinstance(date_object, datetime.datetime):
+            raise TypeError(
+                "Arabic_Date class error: The parameter provided to the instance is not a datetime.date object nor a datetime.datetime object.")
+
+        self.date_object = date_object
+
+        self.__year = str(self.date_object.year)
+        self.__month = int(self.date_object.month)
+        # convert first to `int` to turn 01 into 1
+        self.__day = str(int(self.date_object.day))
+
+        # string keys in translate table must be of length 1
+        self.num_trans_table = str.maketrans(AR_NUMS)
+
+    # Group Name Methods
+    def syriac_names(self, east_nums: bool = False) -> str:
+        if not isinstance(east_nums, bool):
+            raise TypeError(
+                f"Arabic_Date class error: east_nums must be a boolean. '{east_nums}' is not boolean and was passed to the class method '{self.syriac_names.__name__}'.")
+
+        if east_nums:
+            return self.__day.translate(self.num_trans_table) + " " + MONTH_GROUPS["syriac"]["months"][self.__month-1] + " " + self.__year.translate(self.num_trans_table)
+        else:
+            return self.__day + " " + MONTH_GROUPS["syriac"]["months"][self.__month-1] + " " + self.__year
+
+    def roman1_names(self, east_nums: bool = False) -> str:
+        if not isinstance(east_nums, bool):
+            raise TypeError(
+                f"Arabic_Date class error: east_nums must be a boolean. '{east_nums}' is not boolean and was passed to the class method '{self.roman1_names.__name__}'.")
+
+        if east_nums:
+            return self.__day.translate(self.num_trans_table) + " " + MONTH_GROUPS["roman1"]["months"][self.__month-1] + " " + self.__year.translate(self.num_trans_table)
+        else:
+            return self.__day + " " + MONTH_GROUPS["roman1"]["months"][self.__month-1] + " " + self.__year
+
+    def roman2_names(self, east_nums: bool = False) -> str:
+        if not isinstance(east_nums, bool):
+            raise TypeError(
+                f"Arabic_Date class error: east_nums must be a boolean. '{east_nums}' is not boolean and was passed to the class method '{self.roman2_names.__name__}'.")
+
+        if east_nums:
+            return self.__day.translate(self.num_trans_table) + " " + MONTH_GROUPS["roman2"]["months"][self.__month-1] + " " + self.__year.translate(self.num_trans_table)
+        else:
+            return self.__day + " " + MONTH_GROUPS["roman2"]["months"][self.__month-1] + " " + self.__year
+
+    def french_names(self, east_nums: bool = False) -> str:
+        if not isinstance(east_nums, bool):
+            raise TypeError(
+                f"Arabic_Date class error: east_nums must be a boolean. '{east_nums}' is not boolean and was passed to the class method '{self.french_names.__name__}'.")
+
+        if east_nums:
+            return self.__day.translate(self.num_trans_table) + " " + MONTH_GROUPS["french"]["months"][self.__month-1] + " " + self.__year.translate(self.num_trans_table)
+        else:
+            return self.__day + " " + MONTH_GROUPS["french"]["months"][self.__month-1] + " " + self.__year
+
+    # Dual Name Method
+    def dual_names(self, first: str, second: str, east_nums: bool = False) -> str:
+        if not isinstance(first, str):
+            raise TypeError(
+                f"Arabic_Date class error: Unknown month group name: '{first}' passed as a parameter to the method '{self.dual_names.__name__}'.")
+        elif not isinstance(second, str):
+            raise TypeError(
+                f"Arabic_Date class error: Unknown month group name: '{second}' passed as a parameter to the method '{self.dual_names.__name__}'.")
+        elif not isinstance(east_nums, bool):
+            raise TypeError(
+                f"Arabic_Date class error: east_nums must be a boolean. '{east_nums}' is not boolean and was passed to the method '{self.dual_names.__name__}'.")
+
+        if first.strip().lower() == second.strip().lower():
+            raise ValueError(
+                f"Arabic_Date class error: The first group name and the second group name sould not be identicial: '{first}' was passed as the first and the second parameter to the method {self.dual_names.__name__}. Note that these particular parameters are not case sensitive.")
+        valid_first_group = False
+        valid_second_group = False
+        for group, _ in MONTH_GROUPS.items():
+            if first.lower() in group:
+                valid_first_group = True
+        for group, _ in MONTH_GROUPS.items():
+            if second.lower() in group:
+                valid_second_group = True
+        if not valid_first_group or not valid_second_group:
+            error_submessage = ""
+            if not valid_first_group:
+                error_submessage += f"Unknown first groupe name  '{
+                    first}'"
+            if not valid_second_group:
+                if error_submessage == "":
+                    error_submessage += f"Unknown second groupe name '{
+                        second}'"
+                else:
+                    error_submessage += f" and also unknown second groupe name '{
+                        second}'"
+            raise ValueError(
+                f"Arabic_Date class error: {error_submessage} in the parameters passed to the method '{self.dual_names.__name__}'.")
+
+        if east_nums == True:
+            return self.__day.translate(self.num_trans_table) + " " + MONTH_GROUPS[first]["months"][self.__month-1] + " (" + MONTH_GROUPS[second]["months"][self.__month-1] + ") " + self.__year.translate(self.num_trans_table)
+        else:
+            return self.__day + " " + MONTH_GROUPS[first]["months"][self.__month-1] + " (" + MONTH_GROUPS[second]["months"][self.__month-1] + ") " + self.__year
+
+    # Date By Country Code Method
+    def by_country_code(self, country_code: str, east_nums: bool = None) -> str:
+        if not isinstance(country_code, str):
+            raise TypeError(
+                f"Arabic_Date class error: The 'country_code' parameter passed to the class method '{self.by_country_code.__name__}' is not a string.")
+
+        elif east_nums is not None and not isinstance(east_nums, bool):
+            raise TypeError(
+                f"Arabic_Date class error: east_nums must be a boolean. '{east_nums}' is not boolean and was passed to the class method '{self.french_names.__name__}'.")
+
+        for _, group in MONTH_GROUPS.items():
+            if country_code.upper() in group["countries"]:
+                if east_nums is not None and east_nums:
+                    return self.__day.translate(self.num_trans_table) + " " + group["months"][self.__month-1] + " " + self.__year.translate(self.num_trans_table)
+                elif east_nums is not None and not east_nums:
+                    return self.__day + " " + group["months"][self.__month-1] + " " + self.__year
+                else:
+                    if group["east_nums"]:
+                        return self.__day.translate(self.num_trans_table) + " " + group["months"][self.__month-1] + " " + self.__year.translate(self.num_trans_table)
+                    else:
+                        return self.__day + " " + group["months"][self.__month-1] + " " + self.__year
+
+        else:
+            raise ValueError(
+                f"Arabic_Date class error: Unknown country code '{country_code}' passed to the class method '{self.by_country_code.__name__}'.")
+
+    # Eastern Numeric Date Method
+    def eastern_numeric_date(self, separator: str = "/") -> str:
+        if not isinstance(separator, str):
+            raise TypeError(
+                f"Arabic_Date class error: The 'separator' parameter passed to the class method '{self.eastern_numeric_date.__name__}' is not a string.")
+        return self.__day.translate(self.num_trans_table) + separator + str(self.__month).translate(self.num_trans_table) + separator + self.__year.translate(self.num_trans_table)

arabic_datetime/arabic_time.py

@@ -0,0 +1,28 @@
+from typing import Union
+import datetime
+
+# Import constants
+from . constants import AR_NUMS
+
+
+class Arabic_Time:
+    def __init__(self, time_object: Union[datetime.time, datetime.datetime]) -> None:
+        if not isinstance(time_object, datetime.time) and not isinstance(time_object, datetime.datetime):
+            raise TypeError(
+                f"Arabic_Time class error: The parameter passed to the instance is not a datetime.time object nor a datetime.datetime object.")
+
+        self.time_object = time_object
+
+        # string keys in translate table must be of length 1
+        self.num_trans_table = str.maketrans(AR_NUMS)
+
+        # convert first to `int` to turn 01 into 1
+        self.__hour = str(int(self.time_object.hour))
+        self.__minute = str(int(self.time_object.minute))
+        self.__second = str(int(self.time_object.second))
+
+    def time(self, separator: str = ":") -> str:
+        if not isinstance(separator, str):
+            raise TypeError(
+                f"Arabic_Date class error: The 'separator' parameter passed to the class method '{self.time.__name__}' is not a string.")
+        return self.__hour.translate(self.num_trans_table) + separator + self.__minute.translate(self.num_trans_table) + separator + self.__second.translate(self.num_trans_table)

arabic_datetime/constants.py

@@ -0,0 +1,183 @@
+# Constants
+AR_NUMS = {
+    "0": "٠",
+    "1": "١",
+    "2": "٢",
+    "3": "٣",
+    "4": "٤",
+    "5": "٥",
+    "6": "٦",
+    "7": "٧",
+    "8": "٨",
+    "9": "٩"
+}
+
+ALL_COUNTRY_CODES = [
+    "DZ",
+    "BH",
+    "KM",
+    "DJ",
+    "EG",
+    "IQ",
+    "JO",
+    "KW",
+    "LB",
+    "LY",
+    "MR",
+    "MA",
+    "OM",
+    "PS",
+    "QA",
+    "SA",
+    "SO",
+    "SD",
+    "SY",
+    "TN",
+    "AE",
+    "YE"
+]
+
+MONTH_GROUPS = {
+    "syriac": {
+        "east_nums": True,
+        "months": [
+            "كانون الثاني",
+            "شباط",
+            "آذار",
+            "نيسان",
+            "أيار",
+            "حزيران",
+            "تموز",
+            "آب",
+            "أيلول",
+            "تشرين الأول",
+            "تشرين الثاني",
+            "كانون الأول"
+        ],
+        "countries": [
+            "IQ",
+            "JO",
+            "LB",
+            "PS",
+            "SO",
+            "SY",
+        ],
+    },
+
+    "roman1": {
+        "east_nums": True,
+        "months": [
+            "يناير",
+            "فبراير",
+            "مارس",
+            "أبريل",
+            "مايو",
+            "يونيو",
+            "يوليو",
+            "أغسطس",
+            "سبتمبر",
+            "أكتوبر",
+            "نوفمبر",
+            "ديسمبر",
+        ],
+        "countries": [
+            "BH",
+            "KM",
+            "DJ",
+            "EG",
+            "KW",
+            "LY",
+            "OM",
+            "QA",
+            "SA",
+            "SO",
+            "SD",
+            "AE",
+            "YE",
+        ],
+    },
+    "roman2": {
+        "east_nums": False,
+        "months": [
+            "يناير",
+            "فبراير",
+            "مارس",
+            "أبريل",
+            "ماي",
+            "يونيو",
+            "يوليوز",
+            "غشت",
+            "شتنبر",
+            "أكتوبر",
+            "نونبر",
+            "دجنبر",
+        ],
+        "countries": [
+            "MA",
+            "MR",
+        ]
+    },
+
+    "french": {
+        "east_nums": False,
+        "months": [
+            "جانفي",
+            "فيفري",
+            "مارس",
+            "أفريل",
+            "ماي",
+            "جوان",
+            "جويلية",
+            "أوت",
+            "سبتمبر",
+            "أكتوبر",
+            "نوفمبر",
+            "ديسمبر",
+        ],
+        "countries": [
+            "DZ",
+            "TN",
+        ]
+    },
+}
+
+
+COUNTRY_CODES_DICT = {
+    "DZ": "Algeria",
+    "BH": "Bahrain",
+    "KM": "Comoros",
+    "DJ": "Djibouti",
+    "EG": "Egypt",
+    "IQ": "Iraq",
+    "JO": "Jordan",
+    "KW": "Kuwait",
+    "LB": "Lebanon",
+    "LY": "Libya",
+    "MR": "Mauritania",
+    "MA": "Morocco",
+    "OM": "Oman",
+    "PS": "Palestine",
+    "QA": "Qatar",
+    "SA": "Saudi Arabia",
+    "SO": "Somalia",
+    "SD": "Sudan",
+    "SY": "Syria",
+    "TN": "Tunisia",
+    "AE": "United Arab Emirates",
+    "YE": "Yemen"
+}
+
+DUAL_MONTHS = {
+    "1": "كانون الثاني (يناير)",
+    "2": "شباط (فبراير)",
+    "3": "آذار (مارس)",
+    "4": "نيسان (أبريل)",
+    "5": "أيار (مايو)",
+    "6": "حزيران (يونيو)",
+    "7": "تموز (يوليو)",
+    "8": "آب (أغسطس)",
+    "9": "أيلول (سبتمبر)",
+    "10": "تشرين الأول (أكتوبر)",
+    "11": "تشرين الثاني (نوفمبر)",
+    "12": "كانون الأول (ديسمبر)"
+}

arabic_datetime-0.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT Lincense
+
+Copyright (c) 2024 Khaled Auwad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

arabic_datetime-0.0.0.dist-info/METADATA

@@ -0,0 +1,6 @@
+Metadata-Version: 2.1
+Name: arabic_datetime
+Version: 0.0.0
+Requires-Python: >=3.7
+License-File: LICENSE
+

arabic_datetime-0.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+arabic_datetime/__init__.py,sha256=K5kZDLNbWdcQMrljULGfeoOnrRJH-L6xPF4sv6J145o,78
+arabic_datetime/arabic_date.py,sha256=2auoWCcwkrBX5K1jNYuJjcJ7Kv6SloE7u5Gq8OxV8d4,8269
+arabic_datetime/arabic_time.py,sha256=SjsYZx341zBqJ1EMQac4sDhNjcC9Z_ni9XwO9i-L-Vo,1324
+arabic_datetime/constants.py,sha256=JxkRZV64NOTTR8CcJ5A6NLXbQhXhjiw_EYTpNw3MGJ8,3768
+arabic_datetime-0.0.0.dist-info/LICENSE,sha256=6r7YXD-p9ftfmk3RtVngQYVpvzd1XEGih3OqAsFNphk,1091
+arabic_datetime-0.0.0.dist-info/METADATA,sha256=T8oLzILAPLN_r3Dwf60qsmQxPa66NrA2mjPRb-POVC4,111
+arabic_datetime-0.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+arabic_datetime-0.0.0.dist-info/top_level.txt,sha256=Zcet212wBPkc8e_qXsA-a0zd3hYM7s0ReY71BH_1dvg,16
+arabic_datetime-0.0.0.dist-info/RECORD,,

arabic_datetime-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

arabic_datetime-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+arabic_datetime