bagofholding 0.1.3__tar.gz → 0.1.5__tar.gz

{bagofholding-0.1.3 → bagofholding-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bagofholding
-Version: 0.1.3
+Version: 0.1.5
 Summary: bagofholding - browsable, partially-reloadable serialization for pickleable python objects.
 Project-URL: Homepage, https://pyiron.org/
 Project-URL: Documentation, https://bagofholding.readthedocs.io
@@ -43,14 +43,14 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: <3.14,>=3.11
+Requires-Python: <3.15,>=3.11
 Requires-Dist: bidict==0.23.1
 Requires-Dist: h5py<3.15.0,>=3.12.1
-Requires-Dist: mpi4py<4.2.0,>=4.0.1
 Requires-Dist: numpy<2.4.0,>=1.26.4
 Requires-Dist: pygtrie<2.6.0,>=2.5.0
-Requires-Dist: pyiron-snippets<=0.2.0,>=0.1.4
+Requires-Dist: pyiron-snippets<2.0.0,>=1.0.0
 Provides-Extra: widget
 Requires-Dist: ipytree==0.2.2; extra == 'widget'
 Requires-Dist: traitlets==5.14.3; extra == 'widget'
@@ -191,7 +191,7 @@ For a more in-depth look at the above features and to explore other aspects of `
 ## Object requirements
 
 Under-the-hood, we follow the same patterns as `pickle` by explicitly invoking many of the same method (`__reduce__`, `__setstate__`, etc).
-_Almost_ and object which can be pickled can be stored using `bagofholding`.
+_Almost_ any object which can be pickled can be stored using `bagofholding`.
 Our requirements are that the object...
 
 - Must be pickleable
@@ -204,4 +204,4 @@ Our requirements are that the object...
   - `extend`
 - Must have a valid boolean response to `hasattr` for `__metadata__`, and this attribute must be castable to a string if present
 
-If your object satisfies these conditions and fails to "bag", please raise a bug report on the issues page!
+If your object satisfies these conditions and fails to "bag", please raise a bug report on the issues page!

{bagofholding-0.1.3 → bagofholding-0.1.5}/bagofholding/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.3'
-__version_tuple__ = version_tuple = (0, 1, 3)
+__version__ = version = '0.1.5'
+__version_tuple__ = version_tuple = (0, 1, 5)
+
+__commit_id__ = commit_id = None

{bagofholding-0.1.3 → bagofholding-0.1.5}/bagofholding/bag.py

@@ -27,7 +27,7 @@ from typing import (
 import bidict
 from pyiron_snippets import import_alarm
 
-from bagofholding.content import BespokeItem, Packer, pack, unpack
+from bagofholding.content import MAX_PICKLE_PROTOCOL, BespokeItem, Packer, pack, unpack
 from bagofholding.exceptions import BagMismatchError, InvalidMetadataError
 from bagofholding.metadata import (
     HasFieldIterator,
@@ -47,7 +47,7 @@ except (ImportError, ModuleNotFoundError):
         "The browsing widget relies on ipytree and traitlets, but this was "
         "unavailable. You can get a text-representation of all available paths with "
         ":meth:`bagofholding.bag.Bag.list_paths`.",
-        _fail_on_warning=True,
+        raise_exception=True,
     )
 
 PATH_DELIMITER = "/"
@@ -87,7 +87,7 @@ class Bag(Packer, Mapping[str, Metadata | None], abc.ABC):
         require_versions: bool = False,
         forbidden_modules: list[str] | tuple[str, ...] = (),
         version_scraping: VersionScrapingMap | None = None,
-        _pickle_protocol: SupportsIndex = pickle.DEFAULT_PROTOCOL,
+        _pickle_protocol: SupportsIndex = MAX_PICKLE_PROTOCOL,
         overwrite_existing: bool = True,
     ) -> None:
         """

{bagofholding-0.1.3 → bagofholding-0.1.5}/bagofholding/content.py

@@ -13,7 +13,6 @@ import abc
 import collections.abc
 import dataclasses
 import operator
-import pickle
 import types
 from collections.abc import Callable, Iterable, Iterator, Sized
 from typing import (
@@ -30,6 +29,7 @@ from typing import (
 
 import bidict
 import h5py
+from pyiron_snippets import retrieve
 
 from bagofholding.exceptions import (
     ModuleForbiddenError,
@@ -46,10 +46,6 @@ from bagofholding.metadata import (
     get_version,
     validate_version,
 )
-from bagofholding.retrieve import (
-    get_importable_string_from_string_reduction,
-    import_from_string,
-)
 
 PackingMemoAlias: TypeAlias = bidict.bidict[int, str]
 ReferencesAlias: TypeAlias = list[object]
@@ -60,6 +56,12 @@ PackingType = TypeVar("PackingType", bound=Any)
 UnpackingType = TypeVar("UnpackingType", bound=Any)
 
 
+MAX_PICKLE_PROTOCOL = 4
+# Although many of the same patterns as `pickle` are exploited to decompose data,
+# `bagofholding` does not actually _execute_ `pickle`.
+# To this end, the highest protocol value exploiting out-of-band data is not supported
+
+
 class HasContents(Sized, Iterable[str], Protocol): ...
 
 
@@ -252,7 +254,7 @@ class Global(Item[GlobalType, Any, Packer]):
     @classmethod
     def unpack(cls, packer: Packer, path: str, unpacking: UnpackingArguments) -> Any:
         import_string = packer.unpack_string(path)
-        return import_from_string(import_string)
+        return retrieve.import_from_string(import_string)
 
 
 class NoneItem(Item[type[None], None, Packer]):
@@ -782,7 +784,7 @@ def pack(
     require_versions: bool,
     forbidden_modules: list[str] | tuple[str, ...],
     version_scraping: VersionScrapingMap | None,
-    _pickle_protocol: SupportsIndex = pickle.DEFAULT_PROTOCOL,
+    _pickle_protocol: SupportsIndex = MAX_PICKLE_PROTOCOL,
 ) -> None:
     if _pickle_protocol not in (4, 3, 2, 1, 0):
         raise PickleProtocolError(
@@ -831,7 +833,7 @@ def pack(
     rv = obj.__reduce_ex__(_pickle_protocol)
     if isinstance(rv, str):
         Global.pack(
-            get_importable_string_from_string_reduction(rv, obj),
+            retrieve.get_importable_string_from_string_reduction(rv, obj),
             packer,
             path,
             packing_args,
@@ -887,7 +889,7 @@ def unpack(
     memo_value = memo.get(path, NotData)
     if memo_value is NotData:
         metadata = packer.unpack_metadata(path)
-        content_class = import_from_string(metadata.content_type)
+        content_class = retrieve.import_from_string(metadata.content_type)
         if metadata is not None:
             validate_version(
                 metadata, validator=version_validator, version_scraping=version_scraping

{bagofholding-0.1.3 → bagofholding-0.1.5}/cached-miniforge/my-env/lib/python3.1/site-packages/bagofholding/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.3'
-__version_tuple__ = version_tuple = (0, 1, 3)
+__version__ = version = '0.1.5'
+__version_tuple__ = version_tuple = (0, 1, 5)
+
+__commit_id__ = commit_id = None

{bagofholding-0.1.3 → bagofholding-0.1.5}/cached-miniforge/my-env/lib/python3.1/site-packages/bagofholding/bag.py

@@ -27,7 +27,7 @@ from typing import (
 import bidict
 from pyiron_snippets import import_alarm
 
-from bagofholding.content import BespokeItem, Packer, pack, unpack
+from bagofholding.content import MAX_PICKLE_PROTOCOL, BespokeItem, Packer, pack, unpack
 from bagofholding.exceptions import BagMismatchError, InvalidMetadataError
 from bagofholding.metadata import (
     HasFieldIterator,
@@ -47,7 +47,7 @@ except (ImportError, ModuleNotFoundError):
         "The browsing widget relies on ipytree and traitlets, but this was "
         "unavailable. You can get a text-representation of all available paths with "
         ":meth:`bagofholding.bag.Bag.list_paths`.",
-        _fail_on_warning=True,
+        raise_exception=True,
     )
 
 PATH_DELIMITER = "/"
@@ -87,7 +87,7 @@ class Bag(Packer, Mapping[str, Metadata | None], abc.ABC):
         require_versions: bool = False,
         forbidden_modules: list[str] | tuple[str, ...] = (),
         version_scraping: VersionScrapingMap | None = None,
-        _pickle_protocol: SupportsIndex = pickle.DEFAULT_PROTOCOL,
+        _pickle_protocol: SupportsIndex = MAX_PICKLE_PROTOCOL,
         overwrite_existing: bool = True,
     ) -> None:
         """

{bagofholding-0.1.3 → bagofholding-0.1.5}/cached-miniforge/my-env/lib/python3.1/site-packages/bagofholding/content.py

@@ -13,7 +13,6 @@ import abc
 import collections.abc
 import dataclasses
 import operator
-import pickle
 import types
 from collections.abc import Callable, Iterable, Iterator, Sized
 from typing import (
@@ -30,6 +29,7 @@ from typing import (
 
 import bidict
 import h5py
+from pyiron_snippets import retrieve
 
 from bagofholding.exceptions import (
     ModuleForbiddenError,
@@ -46,10 +46,6 @@ from bagofholding.metadata import (
     get_version,
     validate_version,
 )
-from bagofholding.retrieve import (
-    get_importable_string_from_string_reduction,
-    import_from_string,
-)
 
 PackingMemoAlias: TypeAlias = bidict.bidict[int, str]
 ReferencesAlias: TypeAlias = list[object]
@@ -60,6 +56,12 @@ PackingType = TypeVar("PackingType", bound=Any)
 UnpackingType = TypeVar("UnpackingType", bound=Any)
 
 
+MAX_PICKLE_PROTOCOL = 4
+# Although many of the same patterns as `pickle` are exploited to decompose data,
+# `bagofholding` does not actually _execute_ `pickle`.
+# To this end, the highest protocol value exploiting out-of-band data is not supported
+
+
 class HasContents(Sized, Iterable[str], Protocol): ...
 
 
@@ -252,7 +254,7 @@ class Global(Item[GlobalType, Any, Packer]):
     @classmethod
     def unpack(cls, packer: Packer, path: str, unpacking: UnpackingArguments) -> Any:
         import_string = packer.unpack_string(path)
-        return import_from_string(import_string)
+        return retrieve.import_from_string(import_string)
 
 
 class NoneItem(Item[type[None], None, Packer]):
@@ -782,7 +784,7 @@ def pack(
     require_versions: bool,
     forbidden_modules: list[str] | tuple[str, ...],
     version_scraping: VersionScrapingMap | None,
-    _pickle_protocol: SupportsIndex = pickle.DEFAULT_PROTOCOL,
+    _pickle_protocol: SupportsIndex = MAX_PICKLE_PROTOCOL,
 ) -> None:
     if _pickle_protocol not in (4, 3, 2, 1, 0):
         raise PickleProtocolError(
@@ -831,7 +833,7 @@ def pack(
     rv = obj.__reduce_ex__(_pickle_protocol)
     if isinstance(rv, str):
         Global.pack(
-            get_importable_string_from_string_reduction(rv, obj),
+            retrieve.get_importable_string_from_string_reduction(rv, obj),
             packer,
             path,
             packing_args,
@@ -887,7 +889,7 @@ def unpack(
     memo_value = memo.get(path, NotData)
     if memo_value is NotData:
         metadata = packer.unpack_metadata(path)
-        content_class = import_from_string(metadata.content_type)
+        content_class = retrieve.import_from_string(metadata.content_type)
         if metadata is not None:
             validate_version(
                 metadata, validator=version_validator, version_scraping=version_scraping

{bagofholding-0.1.3 → bagofholding-0.1.5}/docs/README.md

@@ -133,7 +133,7 @@ For a more in-depth look at the above features and to explore other aspects of `
 ## Object requirements
 
 Under-the-hood, we follow the same patterns as `pickle` by explicitly invoking many of the same method (`__reduce__`, `__setstate__`, etc).
-_Almost_ and object which can be pickled can be stored using `bagofholding`.
+_Almost_ any object which can be pickled can be stored using `bagofholding`.
 Our requirements are that the object...
 
 - Must be pickleable
@@ -146,4 +146,4 @@ Our requirements are that the object...
   - `extend`
 - Must have a valid boolean response to `hasattr` for `__metadata__`, and this attribute must be castable to a string if present
 
-If your object satisfies these conditions and fails to "bag", please raise a bug report on the issues page!
+If your object satisfies these conditions and fails to "bag", please raise a bug report on the issues page!

{bagofholding-0.1.3 → bagofholding-0.1.5}/pyproject.toml

@@ -7,9 +7,9 @@ name = "bagofholding"
 description = "bagofholding - browsable, partially-reloadable serialization for pickleable python objects."
 readme = "docs/README.md"
 keywords = [ "pyiron",]
-requires-python = ">=3.11, <3.14"
-classifiers = [ "Development Status :: 4 - Beta", "Topic :: Scientific/Engineering", "License :: OSI Approved :: BSD License", "Intended Audience :: Science/Research", "Operating System :: OS Independent", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13",]
-dependencies = [ "bidict==0.23.1", "h5py>=3.12.1,<3.15.0", "mpi4py>=4.0.1,<4.2.0", "numpy>=1.26.4,<2.4.0", "pygtrie>=2.5.0,<2.6.0", "pyiron_snippets>=0.1.4,<=0.2.0",]
+requires-python = ">=3.11, <3.15"
+classifiers = [ "Development Status :: 4 - Beta", "Topic :: Scientific/Engineering", "License :: OSI Approved :: BSD License", "Intended Audience :: Science/Research", "Operating System :: OS Independent", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: 3.14",]
+dependencies = [ "bidict==0.23.1", "h5py>=3.12.1,<3.15.0", "numpy>=1.26.4,<2.4.0", "pygtrie>=2.5.0,<2.6.0", "pyiron_snippets>=1.0.0,<2.0.0",]
 dynamic = [ "version",]
 [[project.authors]]
 name = "Liam Huber"

bagofholding-0.1.3/bagofholding/retrieve.py

@@ -1,52 +0,0 @@
-"""
-Helper functions for managing the relationship between strings and imports.
-"""
-
-from __future__ import annotations
-
-from importlib import import_module
-from typing import Any
-
-from bagofholding.exceptions import StringNotImportableError
-
-
-def import_from_string(library_path: str) -> Any:
-    split_path = library_path.split(".", 1)
-    if len(split_path) == 1:
-        module_name, path = split_path[0], ""
-    else:
-        module_name, path = split_path
-    obj = import_module(module_name)
-    for k in path.split("."):
-        obj = getattr(obj, k)
-    return obj
-
-
-def get_importable_string_from_string_reduction(
-    string_reduction: str, reduced_object: object
-) -> str:
-    """
-    Per the pickle docs:
-
-    > If a string is returned, the string should be interpreted as the name of a global
-      variable. It should be the object’s local name relative to its module; the pickle
-      module searches the module namespace to determine the object’s module. This
-      behaviour is typically useful for singletons.
-
-    To then import such an object from a non-local caller, we try scoping the string
-    with the module of the object which returned it.
-    """
-    try:
-        import_from_string(string_reduction)
-        importable = string_reduction
-    except ModuleNotFoundError:
-        importable = reduced_object.__module__ + "." + string_reduction
-        try:
-            import_from_string(importable)
-        except (ModuleNotFoundError, AttributeError) as e:
-            raise StringNotImportableError(
-                f"Couldn't import {string_reduction} after scoping it as {importable}. "
-                f"Please contact the developers so we can figure out how to handle "
-                f"this edge case."
-            ) from e
-    return importable

bagofholding-0.1.3/cached-miniforge/my-env/lib/python3.1/site-packages/bagofholding/retrieve.py

@@ -1,52 +0,0 @@
-"""
-Helper functions for managing the relationship between strings and imports.
-"""
-
-from __future__ import annotations
-
-from importlib import import_module
-from typing import Any
-
-from bagofholding.exceptions import StringNotImportableError
-
-
-def import_from_string(library_path: str) -> Any:
-    split_path = library_path.split(".", 1)
-    if len(split_path) == 1:
-        module_name, path = split_path[0], ""
-    else:
-        module_name, path = split_path
-    obj = import_module(module_name)
-    for k in path.split("."):
-        obj = getattr(obj, k)
-    return obj
-
-
-def get_importable_string_from_string_reduction(
-    string_reduction: str, reduced_object: object
-) -> str:
-    """
-    Per the pickle docs:
-
-    > If a string is returned, the string should be interpreted as the name of a global
-      variable. It should be the object’s local name relative to its module; the pickle
-      module searches the module namespace to determine the object’s module. This
-      behaviour is typically useful for singletons.
-
-    To then import such an object from a non-local caller, we try scoping the string
-    with the module of the object which returned it.
-    """
-    try:
-        import_from_string(string_reduction)
-        importable = string_reduction
-    except ModuleNotFoundError:
-        importable = reduced_object.__module__ + "." + string_reduction
-        try:
-            import_from_string(importable)
-        except (ModuleNotFoundError, AttributeError) as e:
-            raise StringNotImportableError(
-                f"Couldn't import {string_reduction} after scoping it as {importable}. "
-                f"Please contact the developers so we can figure out how to handle "
-                f"this edge case."
-            ) from e
-    return importable