invesytoolbox 0.0.21__tar.gz → 0.0.23__tar.gz

invesytoolbox-0.0.23/HISTORY.md

@@ -0,0 +1,100 @@
+# History
+## 0.0.23 (2024-07-22)
+* **adjust_spaces_on_punctuation**: inserts narrow (or normal spaces) for certain languages
+* **value_2datatype**: 
+  - default fmt changed to None (hopefully it doesn't break somewhere, but this is necessary)
+  - 'pendulum' is now an option for the parameter 
+- default for parameter **fmt** changed to None (this is necessary for the new pendulum conversion in **value_2datatype** to work) for
+	- **dict_2datatypes**
+	- **dictlist_2datatypes**
+
+## 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.21/src/invesytoolbox.egg-info → invesytoolbox-0.0.23}/PKG-INFO

@@ -1,22 +1,35 @@
 Metadata-Version: 2.1
 Name: invesytoolbox
-Version: 0.0.21
+Version: 0.0.23
 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,6 +44,22 @@ 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.23 (2024-07-22)
+* **adjust_spaces_on_punctuation**: inserts narrow (or normal spaces) for certain languages
+* **value_2datatype**: 
+  - default fmt changed to None (hopefully it doesn't break somewhere, but this is necessary)
+  - 'pendulum' is now an option for the parameter 
+- default for parameter **fmt** changed to None (this is necessary for the new pendulum conversion in **value_2datatype** to work) for
+	- **dict_2datatypes**
+	- **dictlist_2datatypes**
+
+## 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.
 
@@ -114,4 +143,3 @@ The documentation can be found [here](https://rastaf.gitlab.io/invesytoolbox/).
 
 ## 0.0.1 (2022-06-09)
 * first version
-

{invesytoolbox-0.0.21 → invesytoolbox-0.0.23}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = invesytoolbox
-version = 0.0.21
+version = 0.0.23
 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.21 → invesytoolbox-0.0.23}/src/invesytoolbox/itb_data.py

@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
 """
-==========
 data_tools
 ==========
 """
 
-from typing import Union
+from typing import Union, List, Dict, Any, Optional
 import DateTime
 import datetime
 import vobject
+import pendulum
 from dateutil.parser import parse
 from itb_date_time import convert_datetime, str_to_date, str_to_DT, get_dateformat
 from itb_email_phone import process_phonenumber
@@ -19,7 +19,7 @@ time_chars = set('1234567890:')
 
 
 def any_2boolean(
-    value
+    value: Any
 ) -> bool:
     """ return a boolean for any value
 
@@ -34,14 +34,12 @@ 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
-
-    .. note:: The annotated return type is not true if a single_value argument is given.
+    """ Create a dictionary from a list of dictionaries
 
     :param dictList: the list of dictionaries to be converted
     :param key: the key of the dictionaries to use as key for the new dictionary.
@@ -68,10 +66,10 @@ def dict_from_dict_list(
 
 
 def create_vcard(
-    data: dict,
+    data: Dict[str, str],
     returning: str = 'vcard'
 ) -> str:
-    """create a vCard from a dictionary
+    """ create a vCard from a dictionary
 
     .. note:: The serialized vcard has Windows line-breaks, which is fine, I guess
     .. note:: colons in notes are escaped in vobject
@@ -132,10 +130,10 @@ 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
+    """ Convert all keys and values in a dictionary from bytes to unicode
 
     All keys and values are changed from bytes to unicode, if applicable.
     Other data types are left unchaged, including other compound data types.
@@ -153,13 +151,31 @@ 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:
-    """ convert all data of a dictionary to specific (json metadata) or guessed types """
+    fmt: str = None
+) -> Dict[Any, Any]:
+    """ Convert all data of a dictionary to specific (json metadata) or guessed types
+
+    :param d: dictionary
+    :param metadata: dictionary containing types for the keys:
+               - boolean
+               - int
+               - float
+               - date
+               - datetime: date and time
+               - time: conversion or not based on dt
+    :param convert_keys: convert keys to unicode
+    :param convert_to_unicode: convert all bytes to unicode in the process
+    :param dt: - datetime or dt
+               - DateTime or DT
+               - ignore or string
+               - pendulum
+               - default: datetime, because it's Python's default
+    :param fmt: format for datetime parsing
+    """
 
     if convert_keys:
         return {
@@ -193,20 +209,40 @@ 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',
-    fmt: str = '%d.%m.%Y'
+    fmt: str = None
 ) -> list:
+    """ Convert all data of a list of dictionaries to specific (json metadata) or guessed types
+
+    :param dictList: list of dictionaries
+    :param metadata: dictionary containing types for the keys:
+                - boolean
+                - int
+                - float
+                - date
+                - datetime: date and time
+                - time: conversion or not based on dt
+    :param convert_keys: convert keys to unicode
+    :param convert_to_unicode: convert all bytes to unicode in the process
+    :param dt: - datetime or dt
+               - DateTime or DT
+               - ignore or string
+               - pendulum
+               - default: datetime, because it's Python's default
+    :param fmt: format for datetime parsing
+    """
     return [
         dict_2datatypes(
             d=dic,
             metadata=metadata,
             convert_keys=convert_keys,
             convert_to_unicode=convert_to_unicode,
-            dt=dt
+            dt=dt,
+            fmt=fmt
         )
         for dic
         in dictlist
@@ -214,8 +250,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
@@ -259,17 +295,18 @@ def value_2datatype(
     convert_to_unicode: bool = False,
     encoding: str = 'utf-8',
     dt: str = 'datetime',
-    fmt: str = '%d.%m.%Y',  # only for datetime
-    UTC: bool = False
+    fmt: str = None,
+    timezone: str = 'local'
 ) -> Union[str, int, float]:
     """ Convert a value to a datatype
 
     this function has two modes:
 
-    1. it is provided a type for the conversion
+    1. a type is provided for the conversion
     2. it makes educated guesses in converting a string
 
     :param value:
+    :param typ: type for the conversion
     :param metadata: dictionary containing types for the keys:
                - boolean
                - int
@@ -282,7 +319,10 @@ def value_2datatype(
     :param encoding: if bytes are present, use this encoding to convert them to unicode
     :param dt: - datetime or dt
                - DateTime or DT
+               - ignore or string
+               - pendulum
                - default: datetime, because it's Python's default
+    :param timezone: default is 'local', other options are 'UTC' or 'Europe/Vienna'
     """
     if typ:
         if typ == 'boolean':
@@ -312,6 +352,17 @@ def value_2datatype(
                     value,
                     datefmt='international'
                 ) + 0.5  # to avoid day-shifting due to timezones, use 12am
+            elif dt == 'pendulum':
+                if fmt:
+                    p_dt = pendulum.from_format(value, fmt)
+                else:
+                    p_dt = pendulum.parse(value)
+
+                if p_dt.tzinfo == 'UTC' and timezone == 'local':
+                    return p_dt.in_tz(pendulum.local_timezone())
+                elif timezone:
+                    return p_dt.in_tz(timezone)
+                return p_dt.date()
             elif dt in ('ignore', 'string'):
                 return value
             else:
@@ -328,6 +379,17 @@ def value_2datatype(
                     )
                 except DateTime.interfaces.SyntaxError:
                     return value
+            elif dt == 'pendulum':
+                if fmt:
+                    p_dt = pendulum.from_format(value, fmt)
+                else:
+                    p_dt = pendulum.parse(value)
+
+                if p_dt.tzinfo == 'UTC' and timezone == 'local':
+                    return p_dt.in_tz(pendulum.local_timezone())
+                elif timezone:
+                    return p_dt.in_tz(timezone)
+                return p_dt
             elif dt in ('ignore', 'string'):
                 return value
             else:
@@ -340,7 +402,6 @@ def value_2datatype(
                 return value  # DT: return the string
 
     else:
-
         if isinstance(value, (bool, int, float)):
             return value
 
@@ -374,12 +435,7 @@ def value_2datatype(
                     datestring=value,
                     checkonly=True
                 ):
-                    if ':' in value:
-                        return convert_datetime(
-                            date=value,
-                            convert_to=dt
-                        )
-                    elif dt in ('datetime', 'dt'):
+                    if dt in ('datetime', 'dt'):
                         return str_to_date(
                             datestring=value
                         )
@@ -387,6 +443,22 @@ def value_2datatype(
                         return str_to_DT(
                             datestring=value
                         )
+                    elif dt == 'pendulum':
+                        if fmt:
+                            p_dt = pendulum.from_format(value, fmt)
+                        else:
+                            p_dt = pendulum.parse(value)
+                
+                        if p_dt.tzinfo == 'UTC' and timezone == 'local':
+                            return p_dt.in_tz(pendulum.local_timezone())
+                        elif timezone:
+                            return p_dt.in_tz(timezone)
+                        return p_dt
+                    else:
+                        return convert_datetime(
+                            date=value,
+                            convert_to=dt
+                        )
 
             except Exception:
                 # in case it's a subset of datetime_chars but not a date or datetime or time