FourCIPP 1.14.0__py3-none-any.whl → 1.16.0__py3-none-any.whl

fourcipp/utils/not_set.py

@@ -21,18 +21,31 @@
 # THE SOFTWARE.
 """Not set utils."""
 
-from typing import Any
 
-
-class _NotSet:
+class NotSet:
     """Not set object."""
 
+    def __init__(self, expected: object = object) -> None:
+        """Not set object.
+
+        Args:
+            expected: Expected object to to display
+        """
+        self.expected = expected
+
+    def __str__(self) -> str:  # pragma: no cover
+        """String method."""
+        return f"NotSet({self.expected})"
+
+    def __repr__(self) -> str:  # pragma: no cover
+        """Representation method."""
+        return f"NotSet({self.expected})"
+
 
-# Not set object
-NotSet = _NotSet()
+NOT_SET = NotSet()
 
 
-def check_if_set(obj: Any) -> bool:
+def check_if_set(obj: object) -> bool:
     """Check if object or is NotSet.
 
     Args:
@@ -42,10 +55,10 @@ def check_if_set(obj: Any) -> bool:
         True if object is set
     """
     # Check if object is not of type _NotSet, i.e. it has a value
-    return not isinstance(obj, _NotSet)
+    return not isinstance(obj, NotSet)
 
 
-def pop_arguments(key: str, default: Any = NotSet) -> tuple:
+def pop_arguments(key: str, default: object = NOT_SET) -> tuple:
     """Create arguments for the pop method.
 
     We need this utility since pop is not implemented using kwargs, instead the default is checked

fourcipp/utils/{typing.py → type_hinting.py}

@@ -25,6 +25,8 @@ import pathlib
 from collections.abc import Callable
 from typing import TypeAlias, TypeVar
 
+from fourcipp.utils.not_set import NotSet
+
 # Generic type variable
 T = TypeVar("T")
 
@@ -37,3 +39,6 @@ Extractor: TypeAlias = Callable[[str], T]
 LineListExtractor: TypeAlias = Callable[[list[str]], T]
 LineCastingDict: TypeAlias = dict[str, LineListExtractor]
 NestedCastingDict: TypeAlias = dict[str, LineCastingDict | LineListExtractor]
+
+# NotSet
+NotSetAlias: TypeAlias = NotSet | T

fourcipp/utils/yaml_io.py

@@ -28,7 +28,7 @@ from typing import Callable
 import regex
 import ryml
 
-from fourcipp.utils.typing import Path
+from fourcipp.utils.type_hinting import Path
 
 
 def load_yaml(path_to_yaml_file: Path) -> dict:

fourcipp/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.14.0'
-__version_tuple__ = version_tuple = (1, 14, 0)
+__version__ = version = '1.16.0'
+__version_tuple__ = version_tuple = (1, 16, 0)
 
 __commit_id__ = commit_id = None

{fourcipp-1.14.0.dist-info → fourcipp-1.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FourCIPP
-Version: 1.14.0
+Version: 1.16.0
 Summary: A streamlined Python Parser for 4C input files
 Author: FourCIPP Authors
 License: The MIT License (MIT)

fourcipp-1.16.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+fourcipp/__init__.py,sha256=4pz7DVXErSbUcLqPTaHnQfdJzKkpfZDivBqbHbTgpRE,1388
+fourcipp/fourc_input.py,sha256=1-EMbwc5tWbWtbZqzRF4_ytrvkcQVgtC5ZX1uz6NFuQ,23954
+fourcipp/version.py,sha256=zmLDnl-HgLXQQxF2Cg2gB2V4TkzsB1YaOFDyXg9xtoY,706
+fourcipp/config/4C_metadata.yaml,sha256=FFffv__3w90fnmfpCDBMP_XEeIYc9HpxjxruA9GvJZM,11871601
+fourcipp/config/4C_schema.json,sha256=mKGQdpMPIsbeXNd5gN2V8wJ6SHWbFhzQ1ljz_t10xg0,16402819
+fourcipp/config/config.yaml,sha256=n2c2a6E4HKfAdNWOQz1kLUuf5p4NLxIddaAi2t5eM38,460
+fourcipp/legacy_io/__init__.py,sha256=L3MWW-WjPbPAJVX8Z0Uheftn0dRPnqNnSBic3uloFhI,5750
+fourcipp/legacy_io/element.py,sha256=rP8F-m-8ZCwCxtV_OASvvLeNYr01zsmgZsDZSJ_G1gY,3977
+fourcipp/legacy_io/inline_dat.py,sha256=t8eMmJ_mAK7kKYAhNNlsES9JbZ760DHR0101Mj9vkSQ,6723
+fourcipp/legacy_io/node.py,sha256=e7m0W7dai_b1XgaqD37k3QS44ySCas3HetmyTLS9_78,3522
+fourcipp/legacy_io/node_topology.py,sha256=hqGGzhyNhFX-BMW8SzztfzM8zoZLLltVScMv-p4hDH0,5394
+fourcipp/legacy_io/particle.py,sha256=8LoRsyKVfhl5Qf_EoO8vLmbH0QSpB_Nho464ifkHAZc,2172
+fourcipp/utils/__init__.py,sha256=ccdlf4taJ0mKLg_ru8ilXEa72PoO9N2UIxHNHDEtQmY,1151
+fourcipp/utils/cli.py,sha256=Tn9jx0KhC421zv-DMpqNU2hpb6fyi4-r4qV17f-ts4Y,5807
+fourcipp/utils/configuration.py,sha256=_9Yo_2Rxw1QDhib9OV_MjLXBhVPfIBA2qmdOG3EuIKU,6467
+fourcipp/utils/converter.py,sha256=D40YQ96WqPEEpB7fwAB5XC2v-jRki4v1sIJ-ngO08nU,5194
+fourcipp/utils/dict_utils.py,sha256=uC0uaBNP3Wh2v3kFy9JHnAYARMukAN4cl40pmiBT13Y,12891
+fourcipp/utils/metadata.py,sha256=wYu07eCrOTNHSnhDxHyQzF6OU8D_2ZuJfytiIpn3sxY,30895
+fourcipp/utils/not_set.py,sha256=NHf0UXDmTuZfvfnIIgkkx4EohxRsN4MVUHUpt7VOnaQ,2433
+fourcipp/utils/type_hinting.py,sha256=izPEhbMdmhrIBamCLqqF_6iDZW-w7a8kplUugbQILyw,1714
+fourcipp/utils/validation.py,sha256=FejHOj1MddaU7gEpMN-f8Mz3rYjflakd1qcsKnctHqA,5292
+fourcipp/utils/yaml_io.py,sha256=jPgVnxE858XTpDC6BVhfbbljQegL58zc3u2VPYCTvGE,5771
+fourcipp-1.16.0.dist-info/licenses/LICENSE,sha256=lkSOHdH9IZ8c3Vnz0fFjqls1cRlmLADBP8QEIwUlH3o,1082
+fourcipp-1.16.0.dist-info/METADATA,sha256=nNKwiSL3_xPdbyizL_6v8oQtWjMgmAi3KafRBMo0O6U,7916
+fourcipp-1.16.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fourcipp-1.16.0.dist-info/entry_points.txt,sha256=44XBG4bwhuq1EwOZ0U055HYP8_qN6_d30ecVsa5Igng,53
+fourcipp-1.16.0.dist-info/top_level.txt,sha256=oZ6jgFFmvi157VwGUEFuKT3D8oS5mOkpOVx8zZURZrQ,9
+fourcipp-1.16.0.dist-info/RECORD,,

fourcipp-1.14.0.dist-info/RECORD

@@ -1,28 +0,0 @@
-fourcipp/__init__.py,sha256=4pz7DVXErSbUcLqPTaHnQfdJzKkpfZDivBqbHbTgpRE,1388
-fourcipp/fourc_input.py,sha256=ocyxXdu8NFIRM94dc4EG_r8XsBkJajvw1YWHmZh-G6Y,23946
-fourcipp/version.py,sha256=B_zXbaY_VjR5QzFDQUWID71ivmfxjMpJLAttgWbEkMU,706
-fourcipp/config/4C_metadata.yaml,sha256=j3DmYTTuKewugGAG6joSzdcuEpefF4B32Ipkk_9TigY,11887345
-fourcipp/config/4C_schema.json,sha256=Ndrzh5G5tdpIpbq4ExSyh4clBQwELEaQt5Ze77ElKsk,16417772
-fourcipp/config/config.yaml,sha256=n2c2a6E4HKfAdNWOQz1kLUuf5p4NLxIddaAi2t5eM38,460
-fourcipp/legacy_io/__init__.py,sha256=y6aTjgUe61OQSl1NMiZ-fQAGTab_xNT1eJTnaTnsIkc,5744
-fourcipp/legacy_io/element.py,sha256=b8--f3IR9nB68R25mk4DHHOBdDLqASewtAdPZAkA2t4,3971
-fourcipp/legacy_io/inline_dat.py,sha256=n9qWrIX33Atv0JruuLWAxy6lrCaeuCZRIvtl3Jr1a1U,6659
-fourcipp/legacy_io/node.py,sha256=e7m0W7dai_b1XgaqD37k3QS44ySCas3HetmyTLS9_78,3522
-fourcipp/legacy_io/node_topology.py,sha256=hqGGzhyNhFX-BMW8SzztfzM8zoZLLltVScMv-p4hDH0,5394
-fourcipp/legacy_io/particle.py,sha256=0rxwdiMnHI1QUGZPqWgsxqyslrxB7aq7qxgNMb_y_rk,2166
-fourcipp/utils/__init__.py,sha256=ccdlf4taJ0mKLg_ru8ilXEa72PoO9N2UIxHNHDEtQmY,1151
-fourcipp/utils/cli.py,sha256=I0N6mcJQGX7seLtXpfrPJA5EWrmhgOph_gHrrxEs6JE,5801
-fourcipp/utils/configuration.py,sha256=HDrvHrH4K5mdienzVsAt_sh9j2Pv81bxWBqqbeNb1KE,6461
-fourcipp/utils/converter.py,sha256=D40YQ96WqPEEpB7fwAB5XC2v-jRki4v1sIJ-ngO08nU,5194
-fourcipp/utils/dict_utils.py,sha256=uC0uaBNP3Wh2v3kFy9JHnAYARMukAN4cl40pmiBT13Y,12891
-fourcipp/utils/metadata.py,sha256=98jz9Gm8qdvZ-b1jwYObNJTaiMQWwbknvS70Nv6Gwhk,1291
-fourcipp/utils/not_set.py,sha256=04C_3axe2cupBYgfpgDAcGs1zHVzG3I58UGO58TH05A,2017
-fourcipp/utils/typing.py,sha256=8iX9PuKe8B1WJ3vEjiM5ZfefvgYnaZDiSdB7Nx9SrVw,1625
-fourcipp/utils/validation.py,sha256=FejHOj1MddaU7gEpMN-f8Mz3rYjflakd1qcsKnctHqA,5292
-fourcipp/utils/yaml_io.py,sha256=GZtgBn-5OB7xAJmgjo66eG3JwkHnfQFp4VIA2-rVVSg,5765
-fourcipp-1.14.0.dist-info/licenses/LICENSE,sha256=lkSOHdH9IZ8c3Vnz0fFjqls1cRlmLADBP8QEIwUlH3o,1082
-fourcipp-1.14.0.dist-info/METADATA,sha256=ABNia81ZL2ubbhDiRoNsm7_Aj_qTgFFDfDlso_XNxLU,7916
-fourcipp-1.14.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fourcipp-1.14.0.dist-info/entry_points.txt,sha256=44XBG4bwhuq1EwOZ0U055HYP8_qN6_d30ecVsa5Igng,53
-fourcipp-1.14.0.dist-info/top_level.txt,sha256=oZ6jgFFmvi157VwGUEFuKT3D8oS5mOkpOVx8zZURZrQ,9
-fourcipp-1.14.0.dist-info/RECORD,,