1689355986

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/materialsproject/pymatgen/commit/<a class=hub.com/materialsproject/pymatgen/commit/<a class="double-link" href="https://git"><a class=hub.com/materialsproject/pymatgen/commit/<a class="double-link" href="https://git"><a class=hub.com/materialsproject/pymatgen/commit/<a class="double-link" href="https://git"><a class=hub.com/materialsproject/pymatgen/commit/54dc0bc2e3539e0bcff9d477c5de65e6f1ed386c">54dc0bc2e">&lt;a href=&quot;https://github.com/materialsproject/pymatgen/commit/</a><a class="double-link" href="https://github.com/materialsproject/pymatgen/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/materialsproject/pymatgen/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/materialsproject/pymatgen/commit/54dc0bc2e3539e0bcff9d477c5de65e6f1ed386c">54dc0bc2e</a><a href="https://github.com/materialsproject/pymatgen/commit/54dc0bc2e3539e0bcff9d477c5de65e6f1ed386c">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/materialsproject/pymatgen/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/materialsproject/pymatgen/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/materialsproject/pymatgen/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/materialsproject/pymatgen/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/materialsproject/pymatgen/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/materialsproject/pymatgen/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/materialsproject/pymatgen/commit/54dc0bc2e3539e0bcff9d477c5de65e6f1ed386c&quot;&gt;54dc0bc2e&lt;/a&gt;&lt;a href=&quot;https://github.com/materialsproject/pymatgen/commit/54dc0bc2e3539e0bcff9d477c5de65e6f1ed386c&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/materialsproject/pymatgen/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://githu... (continued)

Pull Request Pull Request #2346: Revert "Use f-string automatic string coercion: f"{str(x)}" -> f"{x}""

Run Details

174 of 174 new or added lines in 62 files covered. (100.0%)

82353 of 98242 relevant lines covered (83.83%)

0.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.57

/pymatgen/util/serialization.py

# Copyright (c) Pymatgen Development Team.
# Distributed under the terms of the MIT License.

"""
Most features of this module has been moved to monty. Please refer to
monty.json and monty.serialization documentation.
"""

import functools
import json
import pickle

from pymatgen.core.periodic_table import Element


def pmg_serialize(method):
    """
    Decorator for methods that add MSON serializations keys
    to the dictionary. See documentation of MSON for more details
    """

    @functools.wraps(method)
    def wrapper(*args, **kwargs):
        self = args[0]
        d = method(*args, **kwargs)
        # Add @module and @class
        d["@module"] = self.__class__.__module__
        d["@class"] = self.__class__.__name__
        return d

    return wrapper


def json_pretty_dump(obj, filename):
    """
    Serialize obj as a JSON formatted stream to the given filename (
    pretty printing version)
    """
    with open(filename, "wt") as fh:
        json.dump(obj, fh, indent=4, sort_keys=4)


class PmgPickler(pickle.Pickler):
    """
    Persistence of External Objects as described in section 12.1.5.1 of
    https://docs.python.org/3/library/pickle.html
    """

    def persistent_id(self, obj):
        """Instead of pickling as a regular class instance, we emit a
        persistent ID."""
        if isinstance(obj, Element):
            # Here, our persistent ID is simply a tuple, containing a tag and
            # a key
            return obj.__class__.__name__, obj.symbol
        # If obj does not have a persistent ID, return None. This means obj
        # needs to be pickled as usual.
        return None


class PmgUnpickler(pickle.Unpickler):
    """
    Persistence of External Objects as described in section 12.1.5.1 of
    https://docs.python.org/3/library/pickle.html
    """

    def persistent_load(self, pid):
        """
        This method is invoked whenever a persistent ID is encountered.
        Here, pid is the tuple returned by PmgPickler.
        """
        try:
            type_tag, key_id = pid
        except Exception:
            # Sometimes we get a string such as ('Element', u'C') instead
            # of a real tuple. Use ast to evalute the expression (much safer
            # than eval).
            import ast

            type_tag, key_id = ast.literal_eval(pid)

        if type_tag == "Element":
            return Element(key_id)
        # Always raises an error if you cannot return the correct object.
        # Otherwise, the unpickler will think None is the object referenced
        # by the persistent ID.
        raise pickle.UnpicklingError("unsupported persistent object with pid %s" % pid)


def pmg_pickle_load(filobj, **kwargs):
    r"""
    Loads a pickle file and deserialize it with PmgUnpickler.

    Args:
        filobj: File-like object
        **kwargs: Any of the keyword arguments supported by PmgUnpickler

    Returns:
        Deserialized object.
    """
    return PmgUnpickler(filobj, **kwargs).load()


def pmg_pickle_dump(obj, filobj, **kwargs):
    r"""
    Dump an object to a pickle file using PmgPickler.

    Args:
        obj : Object to dump.
        fileobj: File-like object
        **kwargs: Any of the keyword arguments supported by PmgPickler
    """
    return PmgPickler(filobj, **kwargs).dump(obj)


class SlotPickleMixin:
    """
    This mixin makes it possible to pickle/unpickle objects with __slots__
    defined.
    """

    def __getstate__(self):
        return {slot: getattr(self, slot) for slot in self.__slots__ if hasattr(self, slot)}

    def __setstate__(self, state):
        for slot, value in state.items():
            setattr(self, slot, value)

1	# Copyright (c) Pymatgen Development Team.
2	# Distributed under the terms of the MIT License.
3
4	"""	1✔
5	Most features of this module has been moved to monty. Please refer to
6	monty.json and monty.serialization documentation.
7	"""
8
9	import functools	1✔
10	import json	1✔
11	import pickle	1✔
12
13	from pymatgen.core.periodic_table import Element	1✔
14
15
16	def pmg_serialize(method):	1✔
17	"""
18	Decorator for methods that add MSON serializations keys
19	to the dictionary. See documentation of MSON for more details
20	"""
21
22	@functools.wraps(method)	1✔
23	def wrapper(args, *kwargs):	1✔
24	self = args[0]	1✔
25	d = method(args, *kwargs)	1✔
26	# Add @module and @class
27	d["@module"] = self.__class__.__module__	1✔
28	d["@class"] = self.__class__.__name__	1✔
29	return d	1✔
30
31	return wrapper	1✔
32
33
34	def json_pretty_dump(obj, filename):	1✔
35	"""
36	Serialize obj as a JSON formatted stream to the given filename (
37	pretty printing version)
38	"""
39	with open(filename, "wt") as fh:	×
40	json.dump(obj, fh, indent=4, sort_keys=4)	×
41
42
43	class PmgPickler(pickle.Pickler):	1✔
44	"""
45	Persistence of External Objects as described in section 12.1.5.1 of
46	https://docs.python.org/3/library/pickle.html
47	"""
48
49	def persistent_id(self, obj):	1✔
50	"""Instead of pickling as a regular class instance, we emit a
51	persistent ID."""
52	if isinstance(obj, Element):	1✔
53	# Here, our persistent ID is simply a tuple, containing a tag and
54	# a key
55	return obj.__class__.__name__, obj.symbol	1✔
56	# If obj does not have a persistent ID, return None. This means obj
57	# needs to be pickled as usual.
58	return None	1✔
59
60
61	class PmgUnpickler(pickle.Unpickler):	1✔
62	"""
63	Persistence of External Objects as described in section 12.1.5.1 of
64	https://docs.python.org/3/library/pickle.html
65	"""
66
67	def persistent_load(self, pid):	1✔
68	"""
69	This method is invoked whenever a persistent ID is encountered.
70	Here, pid is the tuple returned by PmgPickler.
71	"""
72	try:	1✔
73	type_tag, key_id = pid	1✔
74	except Exception:	×
75	# Sometimes we get a string such as ('Element', u'C') instead
76	# of a real tuple. Use ast to evalute the expression (much safer
77	# than eval).
78	import ast	×
79
80	type_tag, key_id = ast.literal_eval(pid)	×
81
82	if type_tag == "Element":	1✔
83	return Element(key_id)	1✔
84	# Always raises an error if you cannot return the correct object.
85	# Otherwise, the unpickler will think None is the object referenced
86	# by the persistent ID.
87	raise pickle.UnpicklingError("unsupported persistent object with pid %s" % pid)	×
88
89
90	def pmg_pickle_load(filobj, **kwargs):	1✔
91	r"""
92	Loads a pickle file and deserialize it with PmgUnpickler.
93
94	Args:
95	filobj: File-like object
96	**kwargs: Any of the keyword arguments supported by PmgUnpickler
97
98	Returns:
99	Deserialized object.
100	"""
101	return PmgUnpickler(filobj, **kwargs).load()	1✔
102
103
104	def pmg_pickle_dump(obj, filobj, **kwargs):	1✔
105	r"""
106	Dump an object to a pickle file using PmgPickler.
107
108	Args:
109	obj : Object to dump.
110	fileobj: File-like object
111	**kwargs: Any of the keyword arguments supported by PmgPickler
112	"""
113	return PmgPickler(filobj, **kwargs).dump(obj)	1✔
114
115
116	class SlotPickleMixin:	1✔
117	"""
118	This mixin makes it possible to pickle/unpickle objects with __slots__
119	defined.
120	"""
121
122	def __getstate__(self):	1✔
123	return {slot: getattr(self, slot) for slot in self.__slots__ if hasattr(self, slot)}	×
124
125	def __setstate__(self, state):	1✔
126	for slot, value in state.items():	×
127	setattr(self, slot, value)	×

materialsproject / pymatgen / 1689355986

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous