pyhelpers 2.3.4__tar.gz → 2.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/CHANGELOG.md +57 -2
  2. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/PKG-INFO +6 -6
  3. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/README.md +4 -4
  4. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/__init__.py +4 -1
  5. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/_cache.py +446 -217
  6. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/data/.metadata +2 -2
  7. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/data/user-agent-strings.json +13 -1
  8. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/dbms/_base.py +229 -170
  9. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/dbms/mssql.py +255 -166
  10. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/dbms/postgresql.py +93 -40
  11. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/dbms/utils.py +175 -89
  12. pyhelpers-2.5.0/pyhelpers/dirs/__init__.py +32 -0
  13. pyhelpers-2.5.0/pyhelpers/dirs/formatting.py +268 -0
  14. pyhelpers-2.5.0/pyhelpers/dirs/management.py +333 -0
  15. pyhelpers-2.5.0/pyhelpers/dirs/navigation.py +353 -0
  16. pyhelpers-2.5.0/pyhelpers/dirs/validation.py +200 -0
  17. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/geom/distances.py +76 -83
  18. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/geom/shapes.py +37 -29
  19. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/geom/transforms.py +79 -13
  20. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/apis.py +27 -18
  21. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/computation.py +38 -29
  22. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/downloads.py +159 -86
  23. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/general.py +128 -2
  24. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/manipulation.py +222 -41
  25. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/web.py +93 -25
  26. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/store/converters.py +77 -53
  27. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/store/loaders.py +450 -179
  28. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/store/savers.py +372 -189
  29. pyhelpers-2.5.0/pyhelpers/store/utils.py +596 -0
  30. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/text/preprocessing.py +163 -51
  31. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/text/similarity.py +1 -1
  32. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/viz/__init__.py +3 -2
  33. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/viz/color_utils.py +10 -16
  34. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/viz/colormap.py +2 -3
  35. pyhelpers-2.5.0/pyhelpers/viz/maps.py +196 -0
  36. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers.egg-info/SOURCES.txt +3 -1
  37. pyhelpers-2.3.4/pyhelpers/dirs/__init__.py +0 -7
  38. pyhelpers-2.3.4/pyhelpers/dirs/management.py +0 -216
  39. pyhelpers-2.3.4/pyhelpers/dirs/navigation.py +0 -238
  40. pyhelpers-2.3.4/pyhelpers/dirs/validation.py +0 -400
  41. pyhelpers-2.3.4/pyhelpers/store/utils.py +0 -416
  42. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/CITATION.cff +0 -0
  43. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/LICENSE +0 -0
  44. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/MANIFEST.in +0 -0
  45. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/data/ansi-escape-codes.json +0 -0
  46. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/data/english-numerals.json +0 -0
  47. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/data/xlsx2csv.vbs +0 -0
  48. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/dbms/__init__.py +0 -0
  49. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/geom/__init__.py +0 -0
  50. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/ops/__init__.py +0 -0
  51. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/settings/__init__.py +0 -0
  52. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/settings/configurations.py +0 -0
  53. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/settings/preferences.py +0 -0
  54. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/store/__init__.py +0 -0
  55. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyhelpers/text/__init__.py +0 -0
  56. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/pyproject.toml +0 -0
  57. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/setup.cfg +0 -0
  58. {pyhelpers-2.3.4 → pyhelpers-2.5.0}/setup.py +0 -0
@@ -1,11 +1,66 @@
1
1
  # Changelog / Release notes
2
2
 
3
3
 
4
+ ## [2.5.0](https://github.com/mikeqfu/pyhelpers/releases/tag/2.5.0)
5
+
6
+ (*7 July 2026*)
7
+
8
+ ### Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/2.4.0...2.5.0) since [2.4.0](https://pypi.org/project/pyhelpers/2.4.0/):
9
+
10
+ - **Path normalization & API standardization:**
11
+ * Migrated path navigation and validation utilities across the package to `pathlib.Path` architectures, establishing standard validation signatures and structural consistency (#139).
12
+ * Added a new `standardize_path()` utility within the `dirs` subpackage to secure and unify filesystem interactions (#139).
13
+ * Introduced `standardize_name()` and `standardize_column_names()` utilities to enforce clean, uniform character structures in text processing and operation pipelines (#139).
14
+ * Extended `find_executable()` with an optional `as_str` parameter toggle for flexible, string-based return schemas (#139).
15
+ - **Bug fixes & execution stability:**
16
+ * Fixed execution bottlenecks and edge cases in the data download functions, supplementing the fixes with expanded test assertions (#137).
17
+ * Resolved a critical numeric downcasting edge case within `downcast_numeric_columns` to support standalone Series inputs across both pandas and polars engines (#139).
18
+ - **Subpackage layout & documentation structure:**
19
+ * Reorganized the internal layout of the `dirs` subpackage, deprecating redundant pathways and updating downstream imports globally (#139).
20
+ * Updated `dirs.rst` and aligned external reference endpoints in docstrings to match the new API topology (#139).
21
+ - **Release configuration & maintenance:**
22
+ * Synchronized core dependencies in the root-level `requirements.txt` along with the Sphinx build dependencies in `docs/source/requirements.txt` (#140).
23
+ * Refreshed the distributed `user-agent-strings.json` asset (#140).
24
+ - **Testing suite expansion:**
25
+ * Expanded unit test modules to ensure comprehensive coverage for all new standardization utilities and cache helpers (#137, #139).
26
+
27
+ **For more information and detailed specifications, check out the [PyHelpers 2.5.0 documentation](https://pyhelpers.readthedocs.io/en/2.5.0/).**
28
+
29
+
30
+ ## [2.4.0](https://github.com/mikeqfu/pyhelpers/releases/tag/2.4.0)
31
+
32
+ (*13 April 2026*)
33
+
34
+ ### Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/2.3.4...2.4.0) since [2.3.4](https://pypi.org/project/pyhelpers/2.3.4/):
35
+
36
+ - **Geospatial enhancements:**
37
+ * Introduced a new `viz.maps` submodule for generating interactive maps using Folium. Features include `create_base_folium_map()` for automated map initialization and `get_base_map_center()` for dynamic centering logic (#129).
38
+ * Added native **GeoPackage (.gpkg)** support in the `store` module with dedicated `load_geopackage()` and `save_geopackage()` functions, integrated directly into the `load_data()` dispatcher (#128).
39
+ * Improved coordinate extraction and decimal manipulation utilities in the `geom` module.
40
+ - **File handling & API refactoring:**
41
+ * Fixed file extension detection to support **multi-suffix files** (e.g. `.pkl.xz`, `.gold.parquet`) by transitioning from exact set-matching to `pathlib`-based suffix analysis (#124).
42
+ * Standardized parameter naming across the library (e.g. `path_to_file` → `path`, `col_type` → `dtype`) for a cleaner, more intuitive API (#130).
43
+ * Refactored `cd()` to skip `None` values, preventing the creation of malformed directory paths (#126).
44
+ - **System performance & utilities:**
45
+ * Added `benchmark_functions()` to the `ops` module, allowing for high-fidelity performance comparisons of callables using `timeit` (#127).
46
+ * Optimized directory resolution logic and implemented a `NullHandler` for the root logger to ensure silent operation when used as a downstream dependency.
47
+ * Enhanced console UX with semantic string wrapping for long file paths and standardized exception formatting (#128).
48
+ - **Documentation & infrastructure update:**
49
+ * Upgraded CI/CD pipelines to **Python 3.12** to maintain compatibility with Sphinx 9.1+ requirements (#132).
50
+ * Refined documentation structure by migrating from "modules" to a more accurate "subpackages" hierarchy.
51
+ * Polished LaTeX/PDF output by suppressing redundant chapter numbering for meta-pages (License and Contributors).
52
+ - **Testing & stability:**
53
+ * Comprehensive expansion of test suites to cover interactive maps, GeoPackage I/O, and compound file extensions.
54
+ * Migrated directory testing to `tmp_path` fixtures for better cross-platform reliability.
55
+
56
+ **For more information and detailed specifications, check out the [PyHelpers 2.4.0 documentation](https://pyhelpers.readthedocs.io/en/2.4.0/).**
57
+
58
+
4
59
  ## [2.3.4](https://github.com/mikeqfu/pyhelpers/releases/tag/2.3.4)
5
60
 
6
61
  (*11 February 2026*)
7
62
 
8
- ### Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/2.3.3...2.3.4) since [2.3.3](https://www.google.com/search?q=https://pypi.org/project/pyhelpers/2.3.3/):
63
+ ### Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/2.3.3...2.3.4) since [2.3.3](https://pypi.org/project/pyhelpers/2.3.3/):
9
64
 
10
65
  - **Lazy loading & dependency resolution:**
11
66
  * Fixed a submodule resolution bug within `_LazyModule`. Submodules are now resolved dynamically, preventing `AttributeError` when accessing nested package components (#119). This resolves issues reported in #118.
@@ -21,7 +76,7 @@
21
76
  - **Testing & infrastructure:**
22
77
  * Modernized test suites for the `downloads`, `management` and `savers` modules to validate adaptive indentation logic and lazy loading stability.
23
78
 
24
- **For more information and detailed specifications, check out the [PyHelpers 2.3.4 documentation](https://www.google.com/search?q=https://pyhelpers.readthedocs.io/en/2.3.4/).**
79
+ **For more information and detailed specifications, check out the [PyHelpers 2.3.4 documentation](https://pyhelpers.readthedocs.io/en/2.3.4/).**
25
80
 
26
81
 
27
82
  ## [2.3.3](https://github.com/mikeqfu/pyhelpers/releases/tag/2.3.3)
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pyhelpers
3
- Version: 2.3.4
3
+ Version: 2.5.0
4
4
  Summary: An open-source toolkit for facilitating Python users' data manipulation tasks
5
5
  Home-page: https://github.com/mikeqfu/pyhelpers
6
6
  Author: Qian Fu
7
7
  Author-email: q.fu@bham.ac.uk
8
8
  License: MIT
9
- Project-URL: Documentation, https://pyhelpers.readthedocs.io/en/2.3.4/
9
+ Project-URL: Documentation, https://pyhelpers.readthedocs.io/en/2.5.0/
10
10
  Project-URL: Source, https://github.com/mikeqfu/pyhelpers
11
11
  Project-URL: Bug Tracker, https://github.com/mikeqfu/pyhelpers/issues
12
12
  Keywords: Python,Utilities,Data preprocessing,Data manipulation,Python utilities,Python utils,Python utility
@@ -63,9 +63,9 @@ $ pip install --upgrade pyhelpers
63
63
 
64
64
  For more information, see the [Installation](https://pyhelpers.readthedocs.io/en/latest/installation.html).
65
65
 
66
- ## Quick Start
66
+ ## Quick start
67
67
 
68
- For a concise guide on how to use PyHelpers, check out the [Quick Start](https://pyhelpers.readthedocs.io/en/latest/quick-start.html) tutorial, which includes illustrative examples for each of the [Modules](https://pyhelpers.readthedocs.io/en/latest/modules.html).
68
+ For a concise guide on how to use PyHelpers, check out the [Quick Start](https://pyhelpers.readthedocs.io/en/latest/quick-start.html) tutorial, which includes illustrative examples for each of the [Modules](https://pyhelpers.readthedocs.io/en/latest/subpackages.html).
69
69
 
70
70
  These examples briefly demonstrate the capabilities of PyHelpers in facilitating data manipulation tasks and streamlining work processes.
71
71
 
@@ -83,11 +83,11 @@ Fu, Q. (2020). PyHelpers: An open-source toolkit for facilitating Python users'
83
83
  @software{Fu_PyHelpers_2020,
84
84
  author = {Fu, Qian},
85
85
  title = {{PyHelpers: An open-source toolkit for facilitating Python users' data manipulation tasks}},
86
- year = 2020,
86
+ year = {2020},
87
87
  publisher = {Zenodo},
88
88
  doi = {10.5281/zenodo.4017438},
89
89
  license = {MIT},
90
- url = {https://github.com/mikeqfu/pyhelpers}
90
+ url = {https://doi.org/10.5281/zenodo.4017438},
91
91
  }
92
92
  ```
93
93
 
@@ -23,9 +23,9 @@ $ pip install --upgrade pyhelpers
23
23
 
24
24
  For more information, see the [Installation](https://pyhelpers.readthedocs.io/en/latest/installation.html).
25
25
 
26
- ## Quick Start
26
+ ## Quick start
27
27
 
28
- For a concise guide on how to use PyHelpers, check out the [Quick Start](https://pyhelpers.readthedocs.io/en/latest/quick-start.html) tutorial, which includes illustrative examples for each of the [Modules](https://pyhelpers.readthedocs.io/en/latest/modules.html).
28
+ For a concise guide on how to use PyHelpers, check out the [Quick Start](https://pyhelpers.readthedocs.io/en/latest/quick-start.html) tutorial, which includes illustrative examples for each of the [Modules](https://pyhelpers.readthedocs.io/en/latest/subpackages.html).
29
29
 
30
30
  These examples briefly demonstrate the capabilities of PyHelpers in facilitating data manipulation tasks and streamlining work processes.
31
31
 
@@ -43,11 +43,11 @@ Fu, Q. (2020). PyHelpers: An open-source toolkit for facilitating Python users'
43
43
  @software{Fu_PyHelpers_2020,
44
44
  author = {Fu, Qian},
45
45
  title = {{PyHelpers: An open-source toolkit for facilitating Python users' data manipulation tasks}},
46
- year = 2020,
46
+ year = {2020},
47
47
  publisher = {Zenodo},
48
48
  doi = {10.5281/zenodo.4017438},
49
49
  license = {MIT},
50
- url = {https://github.com/mikeqfu/pyhelpers}
50
+ url = {https://doi.org/10.5281/zenodo.4017438},
51
51
  }
52
52
  ```
53
53
 
@@ -5,9 +5,12 @@ Package initialisation.
5
5
  import datetime
6
6
  import importlib.resources
7
7
  import json
8
+ import logging
8
9
 
9
10
  from . import dbms, dirs, geom, ops, settings, store, text, viz
10
11
 
12
+ logging.getLogger(__name__).addHandler(logging.NullHandler())
13
+
11
14
  metadata = json.loads(
12
15
  importlib.resources.files(__name__).joinpath("data/.metadata").read_text(encoding="utf-8"))
13
16
 
@@ -21,7 +24,7 @@ __email__ = metadata['Email']
21
24
 
22
25
  __version__ = metadata['Version']
23
26
  __license__ = metadata['License']
24
- __copyright__ = f'2019-{datetime.datetime.now().year}, {__author__}'
27
+ __copyright__ = f'2019-{datetime.datetime.now().year} {__author__}'
25
28
 
26
29
  __first_release__ = metadata['First release']
27
30