easydev 0.14.0__tar.gz → 0.15.0__tar.gz

{easydev-0.14.0 → easydev-0.15.0}/PKG-INFO

@@ -1,12 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: easydev
-Version: 0.14.0
+Version: 0.15.0
 Summary: Common utilities to ease development of Python packages
-License: BSD-3-Clause
+License-Expression: BSD-3-Clause
+License-File: COPYING
 Keywords: config,decorators,development
 Author: Thomas Cokelaer
 Author-email: thomas.cokelaer@pasteur.fr
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: End Users/Desktop
@@ -155,12 +156,60 @@ Multiprocessing::
     t.run()
     print(t.results)
 
+Moving away from easydev
+------------------------
+
+easydev dates from a time when Python lacked many small conveniences. Most of
+its tools now have a standard-library or well-maintained third-party
+replacement, and new projects should not depend on easydev. The full
+module-by-module guide is in the
+`documentation <https://easydev.readthedocs.io/en/latest/migration.html>`_
+(``doc/source/migration.rst``). Main replacements:
+
+========================================= ======================================================
+easydev                                   Use instead
+========================================= ======================================================
+``CustomConfig``, ``AppDirs``             ``platformdirs``
+``DynamicConfigParser``                   ``configparser``
+``AttrDict``                              ``types.SimpleNamespace`` / ``dataclasses``
+``Logging``                               ``logging`` (+ ``colorlog``)
+``Progress``                              ``tqdm``
+``MultiProcessing``                       ``concurrent.futures.ProcessPoolExecutor``
+``shellcmd``, ``execute``                 ``subprocess.run``
+``mkdirs``, ``touch``, ``get_home``       ``pathlib`` / ``os.makedirs(exist_ok=True)``
+``cmd_exists``                            ``shutil.which``
+``md5``                                   ``hashlib.file_digest`` (Python 3.11+)
+``browse``                                ``webbrowser.open``
+``get_dependencies``                      ``importlib.metadata.requires``
+``get_share_file``                        ``importlib.resources.files``
+========================================= ======================================================
+
+For example, replacing ``CustomConfig``::
+
+    # before
+    from easydev import CustomConfig
+    config_dir = CustomConfig("myapp").user_config_dir
+
+    # after
+    from pathlib import Path
+    from platformdirs import user_config_dir
+
+    config_dir = Path(user_config_dir("myapp"))
+    config_dir.mkdir(parents=True, exist_ok=True)
+
 Changelog
 ---------
 
 ========= ==========================================================================
 Version   Description
 ========= ==========================================================================
+0.15.0    * fix ``is_mac`` (always returned False)
+          * ``assert_list_almost_equal`` now warns (FutureWarning) when called without
+            ``places``/``deltas`` (nothing is compared); raises ``ListMismatchError``
+            (both ValueError and AssertionError)
+          * add a migration guide (README and documentation) explaining how to
+            replace easydev tools with the standard library, platformdirs, etc.
+          * require Python >= 3.9
 0.13.3    * update pyproject with contribs from @s-t-e-v-e-n-k see PR37
 0.13.2    * replace mock with unittest.mock (fixes
             https://github.com/cokelaer/easydev/issues/20)

{easydev-0.14.0 → easydev-0.15.0}/README.rst

@@ -119,12 +119,60 @@ Multiprocessing::
     t.run()
     print(t.results)
 
+Moving away from easydev
+------------------------
+
+easydev dates from a time when Python lacked many small conveniences. Most of
+its tools now have a standard-library or well-maintained third-party
+replacement, and new projects should not depend on easydev. The full
+module-by-module guide is in the
+`documentation <https://easydev.readthedocs.io/en/latest/migration.html>`_
+(``doc/source/migration.rst``). Main replacements:
+
+========================================= ======================================================
+easydev                                   Use instead
+========================================= ======================================================
+``CustomConfig``, ``AppDirs``             ``platformdirs``
+``DynamicConfigParser``                   ``configparser``
+``AttrDict``                              ``types.SimpleNamespace`` / ``dataclasses``
+``Logging``                               ``logging`` (+ ``colorlog``)
+``Progress``                              ``tqdm``
+``MultiProcessing``                       ``concurrent.futures.ProcessPoolExecutor``
+``shellcmd``, ``execute``                 ``subprocess.run``
+``mkdirs``, ``touch``, ``get_home``       ``pathlib`` / ``os.makedirs(exist_ok=True)``
+``cmd_exists``                            ``shutil.which``
+``md5``                                   ``hashlib.file_digest`` (Python 3.11+)
+``browse``                                ``webbrowser.open``
+``get_dependencies``                      ``importlib.metadata.requires``
+``get_share_file``                        ``importlib.resources.files``
+========================================= ======================================================
+
+For example, replacing ``CustomConfig``::
+
+    # before
+    from easydev import CustomConfig
+    config_dir = CustomConfig("myapp").user_config_dir
+
+    # after
+    from pathlib import Path
+    from platformdirs import user_config_dir
+
+    config_dir = Path(user_config_dir("myapp"))
+    config_dir.mkdir(parents=True, exist_ok=True)
+
 Changelog
 ---------
 
 ========= ==========================================================================
 Version   Description
 ========= ==========================================================================
+0.15.0    * fix ``is_mac`` (always returned False)
+          * ``assert_list_almost_equal`` now warns (FutureWarning) when called without
+            ``places``/``deltas`` (nothing is compared); raises ``ListMismatchError``
+            (both ValueError and AssertionError)
+          * add a migration guide (README and documentation) explaining how to
+            replace easydev tools with the standard library, platformdirs, etc.
+          * require Python >= 3.9
 0.13.3    * update pyproject with contribs from @s-t-e-v-e-n-k see PR37
 0.13.2    * replace mock with unittest.mock (fixes
             https://github.com/cokelaer/easydev/issues/20)

{easydev-0.14.0 → easydev-0.15.0}/easydev/easytest.py

@@ -16,14 +16,22 @@
 # $:Id $
 
 import tempfile
+import warnings
 
 __all__ = ["assert_list_almost_equal", "trysetattr", "TempFile"]
 
 
+class ListMismatchError(ValueError, AssertionError):
+    """Raised by :func:`assert_list_almost_equal` (ValueError kept for backward compatibility)"""
+
+
 def assert_list_almost_equal(first, second, places=None, deltas=None):
     """Combined version nose.tools.assert_almost_equal and assert_list_equal
 
     This function checks that 2 lists contain identical items.
+    Without *places* or *deltas* nothing is compared and a FutureWarning is
+    issued. On mismatch, :class:`ListMismatchError` is raised (it derives from
+    both ValueError, for backward compatibility, and AssertionError).
     The equality between pair of items is checked with assert_almost_equal
     function, which means you can check for the places argument
 
@@ -44,7 +52,14 @@ def assert_list_almost_equal(first, second, places=None, deltas=None):
     if deltas:
         for x, y in zip(first, second):
             if abs(x - y) > deltas:
-                raise ValueError
+                raise ListMismatchError("{} != {} within tolerance {}".format(x, y, deltas))
+    else:
+        warnings.warn(
+            "assert_list_almost_equal called without places or deltas: nothing is compared. "
+            "This will become a strict comparison in a future release.",
+            FutureWarning,
+            stacklevel=2,
+        )
 
 
 def trysetattr(this, attrname, value, possible):

{easydev-0.14.0 → easydev-0.15.0}/easydev/platform.py

@@ -64,7 +64,7 @@ def is_linux():
 
 
 def is_mac():
-    if get_platform() == "Mac":
+    if get_platform() in ("Darwin", "Mac"):
         return True
     else:
         return False

{easydev-0.14.0 → easydev-0.15.0}/easydev/tools.py

@@ -33,7 +33,7 @@ __all__ = [
 
 
 def precision(data, digit=2):
-    """Round values in a list keeping only N digits precision
+    """Truncate a value (not round) keeping only N digits precision
 
     ::
 
@@ -116,24 +116,26 @@ def shellcmd(cmd, show=False, verbose=False, ignore_errors=False):
     :param str cmd: the command to call
     :param bool show: print the command
     :param bool verbose: print the output
+    :param bool ignore_errors: do not raise when the command writes to stderr
 
-    :return: the output as a string
+    :return: the output as bytes (stripped)
     """
     if show:
         print(cmd)
     try:
         ret = subprocess.Popen([cmd], stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
 
-        output = ret.stdout.read().strip()
-        error = ret.stderr.read().strip()
-        ret.wait()
+        output, error = ret.communicate()
+        output = output.strip()
+        error = error.strip()
 
+        # Legacy behaviour kept on purpose (many packages rely on it): any
+        # output on stderr is an error, the exit status is not checked.
         if len(error) > 0:
             if ignore_errors is False:
                 raise Exception(error)
-            else:
-                if verbose is True:
-                    print("Errors/Warning" + str(error))
+            elif verbose is True:
+                print("Errors/Warning" + str(error))
 
         if verbose is True:
             print(output)

{easydev-0.14.0 → easydev-0.15.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "easydev"
-version = "0.14.0"
+version = "0.15.0"
 description = "Common utilities to ease development of Python packages"
 authors = [
     { "name" = "Thomas Cokelaer", "email" = "thomas.cokelaer@pasteur.fr" },
@@ -48,7 +48,7 @@ Documentation =  "https://easydev.readthedocs.io"
 
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 colorama = "^0.4.6"
 colorlog = "^6.8.2"
 pexpect = "^4.9.0"