invesytoolbox 0.0.20__tar.gz → 0.0.22__tar.gz

invesytoolbox-0.0.22/HISTORY.md

@@ -0,0 +1,91 @@
+# History
+## 0.0.22 (2023-10-14)
+* **normalize_name** and **could_be_a_name** now have the boolean parameter *lastname* that indicates that a single-word name is to be treated as a last name, not a first name.
+* **get_locale**: locale can be only the language, without the country.
+* if get_locale fails to get the locale from the system (because invesytoolbox may be imported from a program called from an applicatio rather than the termial), it defaults to `language: 'de'` and `country: 'AT'`.
+* added support for pendulum DateTime
+* **create_email_message**: fixed MIMEMultipart settings
+
+## 0.0.21 (2023-05-21)
+* New function **unravel_duration**: turns a duration string (for ex. '5T23:05:20') into a list or dictionary.
+
+## 0.0.20 (2023-05-06)
+* New function **add_time**: adds (or subtracts) time to (or from) datetime and DateTime
+
+## 0.0.19 (2023-04-07)
+* Corrected bug in **fetch_holidays** (argument *length* resulted in an error)
+
+## 0.0.18 (2023-04-07)
+* new function **change_h_tags** (in new module **itb_html**)
+
+## 0.0.17 (2023-03-01)
+* new function *compare_phonenumbers*: compares two phone numbers after normalizing them (*process_phonenumber*).
+
+## 0.0.16
+* *map_special_chars*: works now.
+
+## 0.0.15
+* *could_be_a_name*: can now handle names with multiple parts like "Robert De La Mancha". Per word, 2 capitals are allowed (i.e. "MacArthur" or "DeLa Cruz)
+
+## 0.0.14
+* *could_be_a_name* and *sort_names*: now working also with prename-only and prenames including a hyphen.
+
+## 0.0.13
+* *get_dateformat* now also processes time
+* *str_to_dt* now checks for valid string
+* *is_valid_datetime_string*: wrapper for checking with *str_to_dt*
+* *remove_time* from datetime or DateTime
+
+## 0.0.12
+* removed documentation from the README file, instead a link to the gitlab pages
+* *map_specialChars* now recognizes Unicode character U+0308 (UTF-8 cc 88 = "COMBINING DIAERESIS").
+* *any_2boolean*
+* *get_dateformat*: argument *checkonly*
+* data functions: argument *json_data* changed to *metadata* (it's a dictionary)
+
+## 0.0.11
+* BeautifulSoup and nameparser added to requirements.txt
+* Removed "Date" conversions (modified DateTime) because it's a bad idea
+* *normalize_name* (using nameparser) added to *itb_text_name*
+* *capitalize_name* rewritten (now quasi a wrapper for normalize_name)
+* *could_be_a_name* rewritten using *normalize_name* (nameparser)
+
+## 0.0.10
+* *check_spam* for web forms
+* *dictlist_2datatypes*: iterates through a list of dictionaries and applies *dict_2datatypes*
+* *prettify_html*: provides *prettify* from BeautifulSoup, because it can't be used directly from restricted Python.
+* *could_be_a_name*: checks if a string could be a name
+
+## 0.0.9
+* *change\_query\_string* respects Zope parameter converters (like `paramname:int`)
+
+## 0.0.8
+* New submodule www
+   * *change\_query\_string*
+
+## 0.0.7
+* shorter submodule names (no _tools suffix)
+* *is_holiday* works without argument
+* *create\_email\_message*: new argument **encoding**
+* *process_phonenumbers*: cleaned up arguments
+* *DT_date*: strip a DateTime of its time (get a "naked" date)
+* *could\_be\_a\_name*: check if a string could possibly be a name
+
+## 0.0.6
+* renamed *capitalize\_text* to *capitalize_name* and removed name argument
+* added Sphinx documentation
+
+## 0.0.5 (2022-06-11)
+* removed **terminal_tools** (will be included in a separate package)
+
+## 0.0.4 (2022-06-09)
+* better formatted README
+
+## 0.0.3 (2022-06-09)
+* updated README (list of functions and a short description)
+
+## 0.0.2 (2022-06-09)
+* removed VERSION file
+
+## 0.0.1 (2022-06-09)
+* first version

{invesytoolbox-0.0.20/src/invesytoolbox.egg-info → invesytoolbox-0.0.22}/PKG-INFO

@@ -1,22 +1,35 @@
 Metadata-Version: 2.1
 Name: invesytoolbox
-Version: 0.0.20
+Version: 0.0.22
 Summary: Tools for Python scripts or terminal
 Home-page: https://gitlab.com/Rastaf/invesytoolbox
 Author: Georg Pfolz
 Author-email: georg.pfolz@invesy.at
 License: MIT License
 Project-URL: Bug Tracker, https://gitlab.com/Rastaf/invesytoolbox/-/issues
-Platform: UNKNOWN
+Project-URL: Documentation, https://rastaf.gitlab.io/invesytoolbox/
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: bs4
+Requires-Dist: babel
+Requires-Dist: colorama
+Requires-Dist: DateTime
+Requires-Dist: gender_guesser
+Requires-Dist: holidays>0.13
+Requires-Dist: nameparser
+Requires-Dist: phonenumbers
+Requires-Dist: pycountry
+Requires-Dist: unidecode
+Requires-Dist: vobject
 
 # invesytoolbox
 
@@ -31,8 +44,18 @@ That's also why all date and time functions also take into account the old DateT
 The documentation can be found [here](https://rastaf.gitlab.io/invesytoolbox/).
 
 # History
+## 0.0.22 (2023-10-14)
+* **normalize_name** and **could_be_a_name** now have the boolean parameter *lastname* that indicates that a single-word name is to be treated as a last name, not a first name.
+* **get_locale**: locale can be only the language, without the country.
+* if get_locale fails to get the locale from the system (because invesytoolbox may be imported from a program called from an applicatio rather than the termial), it defaults to `language: 'de'` and `country: 'AT'`.
+* added support for pendulum DateTime
+* **create_email_message**: fixed MIMEMultipart settings
+
+## 0.0.21 (2023-05-21)
+* New function **unravel_duration**: turns a duration string (for ex. '5T23:05:20') into a list or dictionary.
+
 ## 0.0.20 (2023-05-06)
-* **add_time**: adds time to datetime and DateTime
+* New function **add_time**: adds (or subtracts) time to (or from) datetime and DateTime
 
 ## 0.0.19 (2023-04-07)
 * Corrected bug in **fetch_holidays** (argument *length* resulted in an error)
@@ -111,4 +134,3 @@ The documentation can be found [here](https://rastaf.gitlab.io/invesytoolbox/).
 
 ## 0.0.1 (2022-06-09)
 * first version
-

{invesytoolbox-0.0.20 → invesytoolbox-0.0.22}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = invesytoolbox
-version = 0.0.20
+version = 0.0.22
 author = Georg Pfolz
 author_email = georg.pfolz@invesy.at
 description = Tools for Python scripts or terminal
@@ -11,11 +11,14 @@ license_files = LICENSE.txt
 url = https://gitlab.com/Rastaf/invesytoolbox
 project_urls = 
 	Bug Tracker = https://gitlab.com/Rastaf/invesytoolbox/-/issues
+	Documentation = https://rastaf.gitlab.io/invesytoolbox/
 classifiers = 
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3.7
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
 	License :: OSI Approved :: MIT License
 	Operating System :: OS Independent
 

{invesytoolbox-0.0.20 → invesytoolbox-0.0.22}/src/invesytoolbox/itb_data.py

@@ -1,11 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-==========
 data_tools
 ==========
 """
 
-from typing import Union
+from typing import Union, List, Dict, Any, Optional
 import DateTime
 import datetime
 import vobject
@@ -19,7 +18,7 @@ time_chars = set('1234567890:')
 
 
 def any_2boolean(
-    value
+    value: Any
 ) -> bool:
     """ return a boolean for any value
 
@@ -34,10 +33,10 @@ def any_2boolean(
 
 
 def dict_from_dict_list(
-    dict_list: list,
-    key,
-    single_value: bool = None,
-    include_key: str = False
+    dict_list: List[dict],
+    key: str,
+    single_value: Optional[bool] = None,
+    include_key: Optional[bool] = False
 ) -> dict:
     """Create a dictionary from a list of dictionaries
 
@@ -68,7 +67,7 @@ def dict_from_dict_list(
 
 
 def create_vcard(
-    data: dict,
+    data: Dict[str, str],
     returning: str = 'vcard'
 ) -> str:
     """create a vCard from a dictionary
@@ -132,7 +131,7 @@ def create_vcard(
 
 
 def dict_2unicode(
-    d: dict,
+    d: Dict[Union[str, bytes], Any],
     encoding: str = 'utf-8'
 ) -> dict:
     """ Converts all keys and values in a dictionary from bytes to unicode
@@ -153,12 +152,12 @@ def dict_2unicode(
 
 def dict_2datatypes(
     d: dict,
-    metadata: dict = {},
+    metadata: Dict[str, str] = {},
     convert_keys: bool = False,
     convert_to_unicode: bool = False,
     dt: str = 'datetime',
     fmt: str = '%d.%m.%Y'
-) -> dict:
+) -> Dict[Any, Any]:
     """ convert all data of a dictionary to specific (json metadata) or guessed types """
 
     if convert_keys:
@@ -193,8 +192,8 @@ def dict_2datatypes(
 
 
 def dictlist_2datatypes(
-    dictlist: str,
-    metadata: dict = {},
+    dictlist: List[Dict[Any, Any]],
+    metadata: Dict[Any, Any] = {},
     convert_keys: bool = False,
     convert_to_unicode: bool = False,
     dt: str = 'datetime',
@@ -214,8 +213,8 @@ def dictlist_2datatypes(
 
 
 def sort_dictlist(
-    dictlist: list,
-    keys: (str, list),
+    dictlist: List[dict],
+    keys: Union[str, List[str]],
     reverse: bool = False
 ) -> list:
     """ Sorts a list of dictionaries

{invesytoolbox-0.0.20 → invesytoolbox-0.0.22}/src/invesytoolbox/itb_date_time.py

@@ -1,12 +1,12 @@
 # coding=utf-8
 """
-===============
 date_time_tools
 ===============
 """
-
+from typing import Union
 import datetime
 import DateTime
+import pendulum
 from dateutil.parser import parse
 from dateutil.parser._parser import ParserError
 
@@ -123,7 +123,7 @@ def get_dateformat(
 
 def str_to_dt(
     datestring: str,
-    fmt: (str, None) = None,
+    fmt: str = None,
     checkonly: bool = False,
     returning: str = None
 ) -> datetime.datetime:
@@ -191,7 +191,7 @@ def str_to_dt(
 
 def str_to_DT(
     datestring: str,
-    fmt: (str, None) = None
+    fmt: str = None
 ) -> DateTime.DateTime:
     """ Convert a string to Datetime.Datetime
 
@@ -213,9 +213,24 @@ def str_to_DT(
         )
 
 
+def str_to_pendulum(
+    datestring: str,
+    fmt: str = None
+) -> pendulum.DateTime:
+    """ Convert a string to pendulum.DateTime
+
+    :param fmt: default: %d.%m.%Y (if not specified, the datestring is assumed to be valid ISO8601)
+    """
+
+    if not fmt:
+        return pendulum.parse(datestring)
+    else:
+        return pendulum.datetime.strptime(datestring, fmt)
+
+
 def str_to_date(
     datestring: str,
-    fmt: (str, None) = None
+    fmt: str = None
 ) -> datetime.date:
     """ Convert a string to datetime.date
 
@@ -256,6 +271,38 @@ def DT_to_date(
     )
 
 
+def DT_to_pendulum(
+    DT: DateTime.DateTime
+) -> pendulum.DateTime:
+    """ Convert DateTime.DateTime to pendulum.DateTime """
+
+    tz = DT.timezone()
+
+    offset = None
+
+    if '+' in tz:
+        offset = int(tz.split('+')[-1])
+    elif '-' in tz:
+        offset = - int(tz.split('-')[-1])
+    
+    if offset is not None:
+        if not offset:
+            tz = 'UTC'
+        else:
+            tz = pendulum.FixedTimezone(offset * 3600)
+    else:
+        tz = pendulum.timezone(tz)
+
+    return pendulum.datetime(
+        DT.year(),
+        DT.month(),
+        DT.day(),
+        DT.hour(),
+        DT.minute(),
+        tz = tz
+    )
+
+
 def date_to_dt(
     date: datetime.date,
     H=None, M=None
@@ -290,16 +337,46 @@ def date_to_DT(
     return DateTime.DateTime(date_to_dt(date))
 
 
+def dt_to_pendulum(
+    dt: datetime.datetime
+) -> pendulum.DateTime:
+    """ Convert datetime.datetime to pendulum.DateTime """
+
+    return pendulum.datetime(
+        dt.year,
+        dt.month,
+        dt.day,
+        dt.hour,
+        dt.minute
+    
+    )
+
+
+def pendulum_to_DT(
+    pendulum_dt: pendulum.DateTime
+) -> DateTime.DateTime:
+    """ Convert pendulum.DateTime to DateTime.DateTime """
+
+    return DateTime.DateTime(
+        pendulum_dt.year,
+        pendulum_dt.month,
+        pendulum_dt.day,
+        pendulum_dt.hour,
+        pendulum_dt.minute
+    ).toZone(pendulum_dt.timezone.name)
+
+
 def convert_datetime(
-    date: (
+    date: Union[
         str,
         datetime.datetime,
         datetime.date,
-        DateTime.DateTime
-    ),
+        DateTime.DateTime,
+        pendulum.DateTime
+    ],
     convert_to: str,
     fmt: str = None
-) -> (datetime.datetime, datetime.date, DateTime.DateTime, str):
+) -> Union[datetime.datetime, datetime.date, DateTime.DateTime, str]:
     """ Conversion of date and time formats
 
     :param convertTo:
@@ -321,6 +398,17 @@ def convert_datetime(
             return DT_to_dt(date)
         elif convert_to in ('str', 'string'):
             return date.strftime(fmt)
+        elif convert_to == 'pendulum':
+            return DT_to_pendulum(date)
+    elif isinstance(date, pendulum.DateTime):
+        if convert_to == 'datetime':
+            return date
+        elif convert_to == 'date':
+            return date.date()
+        elif convert_to == 'DateTime':
+            return pendulum_to_DT(date)
+        elif convert_to in ('str', 'string'):
+            return date.strftime(fmt)
     elif isinstance(date, str):
         if convert_to in ('str', 'string'):
             if str_to_date(date, checkonly=True, fmt=fmt):
@@ -333,6 +421,8 @@ def convert_datetime(
             return str_to_dt(date, fmt=fmt)
         elif convert_to == 'DateTime':
             return str_to_DT(date, fmt=fmt)
+        elif convert_to == 'pendulum':
+            return pendulum.parse(date)
     elif isinstance(date, datetime.datetime):
         # datetime.datetime has to be checked BEFORE
         # datetime.date (isinstance(datetime.datetime, datetime.date) == True !)
@@ -344,6 +434,8 @@ def convert_datetime(
             return DateTime.DateTime(date)
         elif convert_to in ('str', 'string'):
             return date.strftime(fmt)
+        elif convert_to == 'pendulum':
+            return dt_to_pendulum(date)
     elif type(date) is datetime.date:  # isinstance does not work
         if convert_to == 'date':
             return date
@@ -353,15 +445,21 @@ def convert_datetime(
             return date_to_DT(date)
         elif convert_to in ('str', 'string'):
             return date.strftime(fmt)
+        elif convert_to == 'pendulum':
+            return pendulum.datetime(
+                date.year,
+                date.month,
+                date.day
+            )
 
 
 def get_calendar_week(
-    date: (
+    date: Union[
         str,
         datetime.datetime,
         datetime.date,
         DateTime.DateTime
-    )
+    ]
 ) -> int:
     """ Get calendard week (week nb of year) from a date
 
@@ -374,12 +472,12 @@ def get_calendar_week(
 
 
 def get_dow_number(
-    date: (
+    date: Union[
         str,
         datetime.datetime,
         datetime.date,
         DateTime.DateTime
-    )
+    ]
 ) -> int:
     """ Get day of week number from a date
 
@@ -392,12 +490,12 @@ def get_dow_number(
 
 
 def get_isocalendar(
-    date: (
+    date: Union[
         str,
         datetime.datetime,
         datetime.date,
         DateTime.DateTime
-    )
+    ]
 ) -> datetime.date:
     """ Returns the isocalendar tuple: (year, woy, downb)
 
@@ -451,6 +549,7 @@ def daterange_from_week(
            - DateTime
            - datetime (default)
            - date
+           - pendulum
     :param fmt: default: '%d.%m.%Y'
 
     .. note:: Author: Andreas Bruhn, https://groups.google.com/forum/#!topic/de.comp.lang.python/p8LfbNMIJ5c
@@ -488,6 +587,7 @@ def dates_from_week(
         - DateTime (default)
         - datetime
         - date
+        - pendulum
 
     :param fmt: default: '%d.%m.%Y'
     :param endofweek: 1 to 7 (monday to sunday)
@@ -525,7 +625,7 @@ def day_from_week(
     weekday: int = 1,
     returning: str = 'date',
     fmt: str = '%d.%m.%Y'
-) -> (datetime.datetime, datetime.date, DateTime.DateTime):
+) -> Union[datetime.datetime, datetime.date, DateTime.DateTime, pendulum.DateTime]:
     """Get day from a week
 
     :param weekday: begins with 1 = monday
@@ -534,6 +634,7 @@ def day_from_week(
        - DateTime
        - datetime (default)
        - date
+       - pendulum
 
     :param fmt: default: '%d.%m.%Y'
     """
@@ -551,7 +652,7 @@ def monday_from_week(
     week: int,
     returning: str = 'date',
     fmt='%d.%m.%Y'
-) -> (datetime.datetime, datetime.date, DateTime.DateTime):
+) -> Union[datetime.datetime, datetime.date, DateTime.DateTime, pendulum.DateTime]:
     """Get monday from a week
 
     :param: weekday begins with 1 = monday
@@ -582,7 +683,7 @@ def last_week_of_year(
 
 
 def remove_time(
-    date_time: (datetime.datetime, DateTime.DateTime),
+    date_time: Union[datetime.datetime, DateTime.DateTime, pendulum.DateTime],
     returning: str = None
 ):
     """Remove time from a datetime or DateTime object
@@ -627,6 +728,19 @@ def remove_time(
                 date_time.month(),
                 date_time.day()
             )
+    elif isinstance(date_time, pendulum.DateTime):
+        if not returning or returning == 'pendulum':
+            return date_time.start_of('day')
+        elif returning == 'date':
+            return date_time.date()
+        elif returning == 'datetime':
+            return date_time.datetime()
+        elif returning == 'DateTime':
+            return DateTime.DateTime(
+                date_time.year,
+                date_time.month,
+                date_time.day
+            )
 
 
 def create_timedelta(
@@ -636,7 +750,7 @@ def create_timedelta(
     """create a timedelta or a number from a time string
 
     :param timestr: format or H:M or H:M:S or H:M:S:ms, possibly with day: 4T03:12:31
-    :param returningdt: dt or DT
+    :param returningdt: dt, DT or pendulum
     """
     days_time = timestr.split('T')
     timestr = days_time[-1]
@@ -665,13 +779,22 @@ def create_timedelta(
         t_delta = days
         for el in TIME_ELS:
             t_delta += time_elements[el] * time_dividers[el]
+    elif dt == 'pendulum':
+        t_delta = pendulum.duration(
+            days=days,
+            hours=time_elements['h'],
+            minutes=time_elements['m'],
+            seconds=time_elements['s'],
+            milliseconds=time_elements['ms'],
+        )
 
     return t_delta
 
 
 def add_time(
-    date_time: (datetime.datetime, DateTime.DateTime),
+    date_time: Union[datetime.datetime, DateTime.DateTime, pendulum.DateTime],
     timestr: str,
+    subtract: bool = False,
     returning: str = None
 ):
     """add or remove time from a datetime or DateTime object
@@ -685,8 +808,7 @@ def add_time(
     or
     dTH:M etc... (ex.: 4T03:12:31)
     """
-    subtract = False
-    if timestr.startswith('-'):
+    if subtract or timestr.startswith('-'):
         subtract = True
         timestr = timestr[1:]
 
@@ -697,6 +819,8 @@ def add_time(
         dt = 'datetime'
     elif isinstance(date_time, DateTime.DateTime):
         dt = 'DateTime'
+    elif isinstance(date_time, pendulum.DateTime):
+        dt = 'pendulum'
     else:
         raise Exception('date_time has to be datetime.datetime, datetime.date or DateTime.DateTime!')
 
@@ -709,3 +833,52 @@ def add_time(
         return date_time - t_delta
     else:
         return date_time + t_delta
+
+
+def unravel_duration(
+    duration: str,
+    returning: str = 'list'
+):
+    """split a duration string into components
+
+    duration comes in the format nTH:M:S:ms
+    (days, hours, minutes, seconds, milliseconds)
+
+    @param returning: list, tuple oder dictionary
+    """
+    if 'T' in duration:
+        days, rest = duration.split('T')
+        days = int(days)
+    else:
+        days = 0
+        rest = duration
+
+    elements = rest.split(':')
+
+    hours = minutes = seconds = milliseconds = 0
+    time_elements = [hours, minutes, seconds, milliseconds]
+
+    for i, (element, time_measure) in enumerate(zip(elements, time_elements.copy())):
+        time_elements[i] = int(element)
+
+    time_elements.insert(0, days)
+
+    for i, divider in zip(
+        range(4, -1, -1),
+        (1000, 60, 60, 24)
+    ):
+        time_element = int(time_elements[i] / divider)
+        time_elements[i] -= time_element * divider
+        time_elements[i - 1] += time_element
+
+    if returning == 'list':
+        return time_elements
+    elif returning in ('dict', 'dictionary'):
+        d = {}
+        for name, val in zip(('days', 'hours', 'minutes', 'seconds', 'milliseconds'), time_elements):
+            d[name] = val
+        return d
+    elif returning == 'tuple':
+        tuple(time_elements)
+    else:
+        raise Exception('argument returning must be list, dictionary or tuple.')