matrix-utils 0.6__tar.gz → 0.6.2__tar.gz

{matrix_utils-0.6 → matrix_utils-0.6.2}/CHANGELOG.md

@@ -1,10 +1,19 @@
 # Changelog
 
-### [0.6] - 2024-11-01
+### [0.6.2] - 2025-08-06
+
+* Fix [#27](https://github.com/brightway-lca/matrix_utils/issues/27): Release `0.6.1` broke Python `3.9` compatibility
+
+### [0.6.1] - 2025-08-06
+
+* Fix [#26](https://github.com/brightway-lca/matrix_utils/issues/26): `AllArraysEmpty` error is incomprehensible
+* Switch to absolute internal imports
+
+## [0.6] - 2024-11-01
 
 * New array mapping implementation using sparse matrices which is ~100x faster and allows for very large input values
 
-### [0.5] - 2024-08-20
+## [0.5] - 2024-08-20
 
 * Default is now 64 bit integers for indexing; compatible with `bw_processing` 1.0
 

{matrix_utils-0.6 → matrix_utils-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: matrix_utils
-Version: 0.6
+Version: 0.6.2
 Summary: Tools to create matrices from data packages
 Author-email: Chris Mutel <cmutel@gmail.com>
 Maintainer-email: Chris Mutel <cmutel@gmail.com>
@@ -43,6 +43,7 @@ Requires-Dist: pylint; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: setuptools; extra == "dev"
+Dynamic: license-file
 
 # matrix_utils
 

matrix_utils-0.6.2/matrix_utils/__init__.py

@@ -0,0 +1,20 @@
+__all__ = (
+    "__version__",
+    "ArrayMapper",
+    "CombinatorialIndexer",
+    "MappedMatrix",
+    "MappedMatrixDict",
+    "Proxy",
+    "RandomIndexer",
+    "ResourceGroup",
+    "SequentialIndexer",
+    "SparseMatrixDict",
+)
+
+__version__ = "0.6.2"
+
+from matrix_utils.array_mapper import ArrayMapper
+from matrix_utils.indexers import CombinatorialIndexer, Proxy, RandomIndexer, SequentialIndexer
+from matrix_utils.mapped_matrix import MappedMatrix
+from matrix_utils.mapped_matrix_dict import MappedMatrixDict, SparseMatrixDict
+from matrix_utils.resource_group import ResourceGroup

{matrix_utils-0.6 → matrix_utils-0.6.2}/matrix_utils/array_mapper.py

@@ -1,7 +1,7 @@
 import numpy as np
 from scipy import sparse
 
-from .errors import EmptyArray
+from matrix_utils.errors import EmptyArray
 
 
 class ArrayMapper:

{matrix_utils-0.6 → matrix_utils-0.6.2}/matrix_utils/mapped_matrix.py

@@ -4,11 +4,15 @@ import numpy as np
 from bw_processing import INDICES_DTYPE, UNCERTAINTY_DTYPE, Datapackage
 from scipy import sparse
 
-from .array_mapper import ArrayMapper
-from .errors import EmptyInterface
-from .indexers import CombinatorialIndexer, RandomIndexer, SequentialIndexer
-from .resource_group import ResourceGroup
-from .utils import filter_groups_for_packages, safe_concatenate_indices
+from matrix_utils.array_mapper import ArrayMapper
+from matrix_utils.errors import AllArraysEmpty, EmptyInterface
+from matrix_utils.indexers import CombinatorialIndexer, RandomIndexer, SequentialIndexer
+from matrix_utils.resource_group import ResourceGroup
+from matrix_utils.utils import (
+    filter_groups_for_packages,
+    handle_all_arrays_empty,
+    safe_concatenate_indices,
+)
 
 
 class MappedMatrix:
@@ -17,6 +21,7 @@ class MappedMatrix:
         *,
         packages: Sequence[Datapackage],
         matrix: str,
+        identifier: Optional[str] = None,
         use_vectors: bool = True,
         use_arrays: bool = True,
         use_distributions: bool = False,
@@ -109,20 +114,25 @@ class MappedMatrix:
         self.groups = tuple([obj for lst in self.packages.values() for obj in lst])
         self.add_indexers(indexer_override, seed_override)
 
-        self.row_mapper = row_mapper or ArrayMapper(
-            array=safe_concatenate_indices(
-                [obj.unique_row_indices_for_mapping() for obj in self.groups], empty_ok
-            ),
-            empty_ok=empty_ok,
-        )
-        if not diagonal:
-            self.col_mapper = col_mapper or ArrayMapper(
+        try:
+            self.row_mapper = row_mapper or ArrayMapper(
                 array=safe_concatenate_indices(
-                    [obj.unique_col_indices_for_mapping() for obj in self.groups],
-                    empty_ok,
+                    [obj.unique_row_indices_for_mapping() for obj in self.groups], empty_ok
                 ),
                 empty_ok=empty_ok,
             )
+            if not diagonal:
+                self.col_mapper = col_mapper or ArrayMapper(
+                    array=safe_concatenate_indices(
+                        [obj.unique_col_indices_for_mapping() for obj in self.groups],
+                        empty_ok,
+                    ),
+                    empty_ok=empty_ok,
+                )
+        except AllArraysEmpty:
+            handle_all_arrays_empty(
+                packages=self.packages, matrix_label=self.matrix_label, identifier=identifier
+            )
 
         self.add_mappers(
             axis=0,
@@ -133,8 +143,17 @@ class MappedMatrix:
             self.add_mappers(axis=1, mapper=self.col_mapper)
         self.map_indices()
 
-        row_indices = safe_concatenate_indices([obj.row_matrix for obj in self.groups], empty_ok)
-        col_indices = safe_concatenate_indices([obj.col_matrix for obj in self.groups], empty_ok)
+        try:
+            row_indices = safe_concatenate_indices(
+                [obj.row_matrix for obj in self.groups], empty_ok
+            )
+            col_indices = safe_concatenate_indices(
+                [obj.col_matrix for obj in self.groups], empty_ok
+            )
+        except AllArraysEmpty:
+            handle_all_arrays_empty(
+                packages=self.packages, matrix_label=self.matrix_label, identifier=identifier
+            )
 
         if diagonal:
             x = 0 if self.row_mapper.empty_input else self.row_mapper.max_index + 1

{matrix_utils-0.6 → matrix_utils-0.6.2}/matrix_utils/mapped_matrix_dict.py

@@ -4,10 +4,10 @@ from typing import Any, Callable, Optional, Sequence, Type, Union
 from bw_processing import Datapackage
 from scipy import sparse
 
-from .array_mapper import ArrayMapper
-from .indexers import Indexer, RandomIndexer, SequentialIndexer
-from .mapped_matrix import MappedMatrix
-from .utils import unroll
+from matrix_utils.array_mapper import ArrayMapper
+from matrix_utils.indexers import Indexer, RandomIndexer, SequentialIndexer
+from matrix_utils.mapped_matrix import MappedMatrix
+from matrix_utils.utils import unroll
 
 
 class SparseMatrixDict(dict):
@@ -133,6 +133,7 @@ class MappedMatrixDict(Mapping):
             key: matrix_class(
                 packages=packages,
                 matrix=matrix,
+                identifier=str(key),
                 use_vectors=use_vectors,
                 use_arrays=use_arrays,
                 use_distributions=use_distributions,

{matrix_utils-0.6 → matrix_utils-0.6.2}/matrix_utils/resource_group.py

@@ -1,12 +1,12 @@
-from typing import Any, Callable, Union
+from typing import Any, Callable, Optional, Union
 
 import numpy as np
 from bw_processing import DatapackageBase
 from stats_arrays import MCRandomNumberGenerator
 
-from .aggregation import aggregate_with_sparse
-from .array_mapper import ArrayMapper
-from .indexers import Indexer, Proxy
+from matrix_utils.aggregation import aggregate_with_sparse
+from matrix_utils.array_mapper import ArrayMapper
+from matrix_utils.indexers import Indexer, Proxy
 
 
 class FakeRNG:
@@ -96,6 +96,19 @@ class ResourceGroup:
             bool(self.custom_filter),
         )
 
+    @property
+    def identifier(self) -> Optional[str]:
+        """Shortcut to get a single `identifier` attribute for the group resources"""
+        ids = {
+            group["identifier"]
+            for group in self.package.metadata["resources"]
+            if group.get("identifier")
+        }
+        if not ids or len(ids) > 1:
+            return None
+        else:
+            return ids.pop()
+
     @property
     def has_distributions(self):
         try:

{matrix_utils-0.6 → matrix_utils-0.6.2}/matrix_utils/utils.py

@@ -1,6 +1,8 @@
+from typing import Optional
+
 import numpy as np
 
-from .errors import AllArraysEmpty
+from matrix_utils.errors import AllArraysEmpty
 
 
 def filter_groups_for_packages(
@@ -62,3 +64,51 @@ def unroll(a: tuple, b: tuple) -> tuple:
         return (a, *b)
     else:
         return (a, b)
+
+
+def handle_all_arrays_empty(
+    packages: dict, matrix_label: str, identifier: Optional[str] = None
+) -> None:
+    """Format the error messages for `AllArraysEmpty` to make them understandable"""
+    if not packages and not identifier:
+        ERROR = """
+No data found to build {} matrix.
+
+No datapackages found which could provide data to build this matrix.
+""".format(
+            matrix_label
+        )
+        raise AllArraysEmpty(ERROR)
+    elif not packages:
+        ERROR = """
+No data found to build {} matrix for {}.
+
+No datapackages found which could provide data to build this matrix.
+""".format(
+            matrix_label, identifier
+        )
+        raise AllArraysEmpty(ERROR)
+    else:
+        ERROR_START = """
+No data found to build {} matrix.
+
+This error commonly occurs when using impact assessment methods for the wrong version of the
+background database, because each background database version has its own set of elementary flows.
+
+Found {} resource groups in {} datapackages but none of them had data for the requested method:
+""".format(
+            matrix_label, len(packages), sum(len(group) for group in packages.values())
+        )
+        ERROR_DETAIL_TEMPLATE = """
+Datapackage name: {}
+Resource group: {}
+Data array length: {} (none of this data could be used)
+"""
+        ERROR_DETAILS = [
+            ERROR_DETAIL_TEMPLATE.format(
+                package.metadata["name"], group.identifier or group.label, len(group.data_original)
+            )
+            for package, groups in packages.items()
+            for group in groups
+        ]
+        raise AllArraysEmpty(ERROR_START + "".join(ERROR_DETAILS))

{matrix_utils-0.6 → matrix_utils-0.6.2}/matrix_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: matrix_utils
-Version: 0.6
+Version: 0.6.2
 Summary: Tools to create matrices from data packages
 Author-email: Chris Mutel <cmutel@gmail.com>
 Maintainer-email: Chris Mutel <cmutel@gmail.com>
@@ -43,6 +43,7 @@ Requires-Dist: pylint; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: setuptools; extra == "dev"
+Dynamic: license-file
 
 # matrix_utils
 

{matrix_utils-0.6 → matrix_utils-0.6.2}/tests/mapped_matrix.py

@@ -142,11 +142,19 @@ def test_indexer_override():
 
 
 def test_no_packages_error():
-    with pytest.raises(AllArraysEmpty):
+    with pytest.raises(AllArraysEmpty) as exc_info:
         MappedMatrix(
             packages=[],
             matrix="foo",
         )
+    assert (
+        exc_info.value.args[0]
+        == """
+No data found to build foo matrix.
+
+No datapackages found which could provide data to build this matrix.
+"""
+    )
 
 
 def test_no_packages_empty_ok():

{matrix_utils-0.6 → matrix_utils-0.6.2}/tests/utils.py

@@ -3,7 +3,13 @@ import numpy as np
 import pytest
 
 from matrix_utils.errors import AllArraysEmpty
-from matrix_utils.utils import has_relevant_data, safe_concatenate_indices, unroll
+from matrix_utils.resource_group import ResourceGroup
+from matrix_utils.utils import (
+    handle_all_arrays_empty,
+    has_relevant_data,
+    safe_concatenate_indices,
+    unroll,
+)
 
 
 def test_safe_concatenate_indices():
@@ -103,3 +109,49 @@ def test_tuple_unrolling():
         "wild",
         "wacky",
     )
+
+
+def test_handle_all_arrays_empty_multiple():
+    a = bwp.create_datapackage(name="abcd")
+    a.add_persistent_vector(
+        matrix="foo-matrix",
+        name="first-one",
+        indices_array=np.array([(10, 10), (12, 9), (14, 8), (18, 7)], dtype=bwp.INDICES_DTYPE),
+        data_array=np.array([11, 12.3, 14, 125]),
+    )
+    a = a.filter_by_attribute("matrix", "foo-matrix")
+
+    b = bwp.create_datapackage(name="efgh")
+    b.add_persistent_vector(
+        matrix="foo-matrix",
+        name="second-one",
+        indices_array=np.array([(10, 10), (12, 9), (14, 8)], dtype=bwp.INDICES_DTYPE),
+        data_array=np.array([11, 12.3, 14]),
+    )
+    b = b.filter_by_attribute("matrix", "foo-matrix")
+
+    packages = {
+        a: [ResourceGroup(package=a, group_label="first-one")],
+        b: [ResourceGroup(package=b, group_label="second-one")],
+    }
+
+    with pytest.raises(AllArraysEmpty) as exc_info:
+        handle_all_arrays_empty(packages, "foo-matrix")
+
+    expected = """
+No data found to build foo-matrix matrix.
+
+This error commonly occurs when using impact assessment methods for the wrong version of the
+background database, because each background database version has its own set of elementary flows.
+
+Found 2 resource groups in 2 datapackages but none of them had data for the requested method:
+
+Datapackage name: abcd
+Resource group: first-one
+Data array length: 4 (none of this data could be used)
+
+Datapackage name: efgh
+Resource group: second-one
+Data array length: 3 (none of this data could be used)
+"""
+    assert exc_info.value.args[0] == expected

matrix_utils-0.6/matrix_utils/__init__.py

@@ -1,20 +0,0 @@
-__all__ = (
-    "__version__",
-    "ArrayMapper",
-    "CombinatorialIndexer",
-    "MappedMatrix",
-    "MappedMatrixDict",
-    "Proxy",
-    "RandomIndexer",
-    "ResourceGroup",
-    "SequentialIndexer",
-    "SparseMatrixDict",
-)
-
-__version__ = "0.6"
-
-from .array_mapper import ArrayMapper
-from .indexers import CombinatorialIndexer, Proxy, RandomIndexer, SequentialIndexer
-from .mapped_matrix import MappedMatrix
-from .mapped_matrix_dict import MappedMatrixDict, SparseMatrixDict
-from .resource_group import ResourceGroup