jupyter-analysis-tools 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

jupyter_analysis_tools/__init__.py

@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 # __init__.py
 
-__version__ = "1.2.0"
+__version__ = "1.2.2"
 
 from .binning import reBin
 from .git import checkRepo, isNBstripoutActivated, isNBstripoutInstalled, isRepo
-from .readdata import readdata, readPDHmeta, readSSF
+from .readdata import readdata
 from .readdata import readdata as readPDH
+from .readdata import readPDHmeta, readSSF
 from .utils import setLocaleUTF8
 from .widgets import PathSelector, showBoolStatus
 

jupyter_analysis_tools/readdata.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 # readdata.py
 
-import json
 import warnings
 import xml.etree.ElementTree as et
 from pathlib import Path
@@ -62,20 +61,28 @@ def convertValue(val):
             pass
     return val
 
+
 def xmlPDHToDict(root):
     result = {}
     stack = [(root, result)]
     while stack:
         elem, parentCont = stack.pop()
         elemCont = {}
-        key = elem.attrib.pop("key", None)
         idx = -1
-        if (not len(list(elem)) and not len(elem.attrib)
-            and not (elem.text and len(elem.text.strip()))):
-            continue # skip empty elements with a key only early
+        key = elem.attrib.pop("key", None)
+        if (  # get a unique key, the key can occur in multiple groups in PDH
+            key is not None and elem.tag == "group" and elem.attrib.get("id", None) is not None
+        ):
+            key = elem.attrib.pop("id")
+        if (  # skip empty elements with a key only early
+            not len(list(elem))
+            and not len(elem.attrib)
+            and not (elem.text and len(elem.text.strip()))
+        ):
+            continue
         if elem.tag == "list":
             elemCont = []
-        else: # add attributes & values to dict
+        else:  # add attributes & values to dict
             # Attach text, if any
             if elem.text and len(elem.text.strip()):
                 if elem.tag in ("value", "reference"):
@@ -84,17 +91,20 @@ def xmlPDHToDict(root):
                     elemCont["#text"] = convertValue(elem.text)
             # Attach attributes, if any
             if elem.attrib:
-                elemCont.update({k: convertValue(v) for k, v in elem.attrib.items() if len(v.strip())})
-            if key == "unit" and "value" in elemCont: # fix some units
+                elemCont.update(
+                    {k: convertValue(v) for k, v in elem.attrib.items() if len(v.strip())}
+                )
+            if key == "unit" and "value" in elemCont:  # fix some units
                 elemCont["value"] = elemCont["value"].replace("_", "")
             if "unit" in elemCont:
                 elemCont["unit"] = elemCont["unit"].replace("_", "")
             # reduce the extracted dict&attributes
-            idx = elemCont.get("index", -1) # insert last/append if no index given
+            idx = elemCont.get("index", -1)  # insert last/append if no index given
             value = elemCont.get("value", None)
-            if value is not None and (len(elemCont) == 1
-                                      or (len(elemCont) == 2 and "index" in elemCont)):
-                elemCont = value # contains value only
+            if value is not None and (
+                len(elemCont) == 1 or (len(elemCont) == 2 and "index" in elemCont)
+            ):
+                elemCont = value  # contains value only
         parentKey = elem.tag
         if key is not None and parentKey in ("list", "value", "group"):
             # skip one level in hierarchy for these generic containers
@@ -103,21 +113,22 @@ def xmlPDHToDict(root):
         try:
             if isinstance(parentCont, list):
                 parentCont.insert(idx, elemCont)
-            elif parentKey not in parentCont: # add as new list
-                if key is None: # make a list
+            elif parentKey not in parentCont:  # add as new list
+                if key is None:  # make a list
                     parentCont[parentKey] = elemCont
-                else: # have a key
+                else:  # have a key
                     parentCont[parentKey] = {key: elemCont}
-            else: # parentKey exists already
-                if (not isinstance(parentCont[parentKey], list) and
-                    not isinstance(parentCont[parentKey], dict)):
+            else:  # parentKey exists already
+                if not isinstance(parentCont[parentKey], list) and not isinstance(
+                    parentCont[parentKey], dict
+                ):
                     # if its a plain value before, make a list out of it and append in next step
                     parentCont[parentKey] = [parentCont[parentKey]]
                 if isinstance(parentCont[parentKey], list):
                     parentCont[parentKey].append(elemCont)
                 elif key is not None:
                     parentCont[parentKey].update({key: elemCont})
-                else: # key is None
+                else:  # key is None
                     parentCont[parentKey].update(elemCont)
         except AttributeError:
             raise
@@ -126,31 +137,34 @@ def xmlPDHToDict(root):
     # fix some entry values, weird Anton Paar PDH format
     try:
         oldts = result["fileinfo"]["parameter"]["DateTime"]["value"]
-        delta = (39*365+10)*24*3600 # timestamp seems to be based on around 2009-01-01 (a day give or take)
+        # timestamp seems to be based on around 2009-01-01 (a day give or take)
+        delta = (39 * 365 + 10) * 24 * 3600
         # make it compatible to datetime.datetime routines
-        result["fileinfo"]["parameter"]["DateTime"]["value"] = oldts+delta
+        result["fileinfo"]["parameter"]["DateTime"]["value"] = oldts + delta
     except KeyError:
         pass
     return result
 
+
 def readPDHmeta(fp):
     fp = Path(fp)
     if fp.suffix.lower() != ".pdh":
         warnings.warn("readPDHmeta() supports .pdh files only!")
-        return # for PDH files
+        return  # for PDH files
     lines = ""
     with open(fp) as fd:
         lines = fd.readlines()
     nrows = int(lines[2].split()[0])
-    xml = "".join(lines[nrows+5:])
+    xml = "".join(lines[nrows + 5 :])
     return xmlPDHToDict(et.fromstring(xml))
 
+
 def readSSF(fp):
     fp = Path(fp)
     if fp.suffix.lower() != ".ssf":
         warnings.warn("readSession() supports .ssf files only!")
         return  # for PDH files
     data = ""
-    with open(fp, encoding='utf-8-sig') as fd:
+    with open(fp, encoding="utf-8-sig") as fd:
         data = fd.read()
     return xmlPDHToDict(et.fromstring(data))

jupyter_analysis_tools/utils.py

@@ -89,7 +89,8 @@ def addEnvScriptsToPATH():
     """Prepends the *Scripts* directory of the current Python environment base directory to systems
     PATH variable.
 
-    It is intended for Conda (Miniforge) environments on Windows that do not have this in their PATH environment variable, causing them to miss many commands provided from this location.
+    It is intended for Conda (Miniforge) environments on Windows that do not have this in their PATH
+    environment variable, causing them to miss many commands provided from this location.
     """
     envPath = [p for p in sys.path if p.endswith("Lib")]
     if not envPath:

{jupyter_analysis_tools-1.2.0.dist-info → jupyter_analysis_tools-1.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.2.0
+Version: 1.2.2
 Summary: Yet another Python library with helpers and utilities for data analysis and processing.
 Author-email: Ingo Breßler <dev@ingobressler.net>
 License: MIT license
@@ -53,8 +53,8 @@ Yet another Python library with helpers and utilities for data analysis and proc
     :target: https://pypi.org/project/jupyter-analysis-tools
     :alt: PyPI Package latest release
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.0.svg
-    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.0...main
+.. |commits-since| image:: https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.2.2.svg
+    :target: https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.2.2...main
     :alt: Commits since latest release
 
 .. |license| image:: https://img.shields.io/pypi/l/jupyter-analysis-tools.svg
@@ -104,9 +104,9 @@ https://BAMresearch.github.io/jupyter-analysis-tools
 Development
 ===========
 
-To run all the tests run::
+Run all tests with::
 
-    tox
+    tox -e py
 
 Note, to combine the coverage data from all the tox environments run:
 
@@ -127,6 +127,42 @@ Note, to combine the coverage data from all the tox environments run:
 
 # CHANGELOG
 
+## v1.2.2 (2025-07-15)
+
+### Bug fixes
+
+* readPDHmeta: use unique dict keys, the xmk *key* can occur in multiple groups in PDH ([`ef41c81`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/ef41c81d40d801b5baf86f56cf9012ca35d2ccde))
+
+### Documentation
+
+* pyproject: revert specify readme+changelog document types ([`1baa762`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/1baa762d441fe0a1b7b663b9d0589de857277426))
+
+* pyproject: specify readme+changelog document types to render overview on pypi correctly ([`6e4d1e5`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/6e4d1e56640b604f971ddca8dabd8d1aff5c9bf1))
+
+* ghpages: make sure .nojekyll exists after purging old html docs ([`4847845`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/4847845cc06884b6e589b26897e83411d649ef4d))
+
+## v1.2.1 (2025-07-11)
+
+### Bug fixes
+
+* readme: trigger new version after style changes ([`8b2b5e9`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/8b2b5e93c0f24ae59afaa764abdc508e994946b4))
+
+### Code style
+
+* __init__: imports format ([`6f07790`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/6f07790a04e43736b1c0fbce0eac54d0b661a7cf))
+
+* utils: satisfy flake8 ([`9657474`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/9657474e94a4d9887c4a6b653e0ffa403e666d02))
+
+* readdata: satisfy flake8 ([`36bf6e8`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/36bf6e8be67a2ebd345c5557c2352710bcebed82))
+
+### Continuous integration
+
+* workflow: publish only if the docs are good ([`a663ed3`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/a663ed3d1fd87079a4fd7cf419132a129280a562))
+
+### Testing
+
+* utils: fix imports ([`ddd5369`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/ddd5369b8037f583c6900aea25522a56126c9d32))
+
 ## v1.2.0 (2025-07-11)
 
 ### Features

{jupyter_analysis_tools-1.2.0.dist-info → jupyter_analysis_tools-1.2.2.dist-info}/RECORD

@@ -1,16 +1,16 @@
-jupyter_analysis_tools/__init__.py,sha256=qwt3D2fugc238WYSAYOpSmy9EqAxHIq45WkHLCgqjGQ,365
+jupyter_analysis_tools/__init__.py,sha256=97TJ2mR74urGEdLA3G-jQqcSh_w-HKzX3XYzBZfez6A,386
 jupyter_analysis_tools/analysis.py,sha256=AiAvUO648f0PYXqLfal1kDH926neasE5c1RYFu9wtYg,1768
 jupyter_analysis_tools/binning.py,sha256=d6eXRC3IOnnJIF25OfEASyWedT71EX2nF7jAgGJ9suQ,14536
 jupyter_analysis_tools/datalocations.py,sha256=BakfiZOMcBwp-_DAn7l57lGWZmZGNnk0j73V75nLBUA,4322
 jupyter_analysis_tools/distrib.py,sha256=uyh2jXDdXR6dfd36CAoE5_psoFF0bfA6l1wletPD7Xo,16515
 jupyter_analysis_tools/git.py,sha256=mqSk5nnAFrmk1_2KFuKVrDWOkRbGbAQOq2N1DfxhNpg,2216
 jupyter_analysis_tools/plotting.py,sha256=L2gwSjlBVK8OneAfSuna3vCJIg2rSEdvd9TfEbM2Als,1183
-jupyter_analysis_tools/readdata.py,sha256=zqFYK21ckmogVgsEYNVeqvNvkGVzcHzdCT-I_n0n_uw,5702
-jupyter_analysis_tools/utils.py,sha256=cwbviD1YP06rVhtItdORHEbp8fQ7JfhcrYDONRM336Y,5315
+jupyter_analysis_tools/readdata.py,sha256=6Tncwo3NSYAnyLQzAhDtiUyp1Xpw3CahqQ_5NeGhJqI,6030
+jupyter_analysis_tools/utils.py,sha256=dFE34fYQS7ivCfNy0nwwNPyBdZhIzW9QrxwjvvIHlIQ,5319
 jupyter_analysis_tools/widgets.py,sha256=rA8qPvY9nS1OtykZwXtCTG29K-N_MYFVb5Aj8yK40_s,2996
-jupyter_analysis_tools-1.2.0.dist-info/licenses/AUTHORS.rst,sha256=SUxxgElDBm6WdCbBBFfcr0ZE3SolWL0T0aS5Fym1198,100
-jupyter_analysis_tools-1.2.0.dist-info/licenses/LICENSE,sha256=SrbIwXA1ZLTO6uwZneJMpvdgiC-3fhNl0vwb3ALoY4g,1107
-jupyter_analysis_tools-1.2.0.dist-info/METADATA,sha256=gBi2EdNB6XZP1RC5bls8EepnVGiVMf0HVoXD5D3svZ0,36100
-jupyter_analysis_tools-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-jupyter_analysis_tools-1.2.0.dist-info/top_level.txt,sha256=ei_0x-BF85FLoJ_h67ySwDFowtqus_gI4_0GR466PEU,23
-jupyter_analysis_tools-1.2.0.dist-info/RECORD,,
+jupyter_analysis_tools-1.2.2.dist-info/licenses/AUTHORS.rst,sha256=SUxxgElDBm6WdCbBBFfcr0ZE3SolWL0T0aS5Fym1198,100
+jupyter_analysis_tools-1.2.2.dist-info/licenses/LICENSE,sha256=SrbIwXA1ZLTO6uwZneJMpvdgiC-3fhNl0vwb3ALoY4g,1107
+jupyter_analysis_tools-1.2.2.dist-info/METADATA,sha256=xNHzAqCaV-gPgp8HB96pEeekWAWWJDeIhmJHDk0vgOA,37932
+jupyter_analysis_tools-1.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jupyter_analysis_tools-1.2.2.dist-info/top_level.txt,sha256=ei_0x-BF85FLoJ_h67ySwDFowtqus_gI4_0GR466PEU,23
+jupyter_analysis_tools-1.2.2.dist-info/RECORD,,