utils: refactored types & errors

Author: BitterB0NG0

examples/create_inp.py

@@ -9,10 +9,10 @@
 RADIUS_LEAD: float = 1
 
 # Creating cell geometries.
-geometry_air = pymcnp.utils.types.Geometry('11')
-geometry_shield = pymcnp.utils.types.Geometry('12')
-geometry_lead = pymcnp.utils.types.Geometry('13')
-geometry_world = pymcnp.utils.types.Geometry('14')
+geometry_air = pymcnp.inp.cell.Geometry('11')
+geometry_shield = pymcnp.inp.cell.Geometry('12')
+geometry_lead = pymcnp.inp.cell.Geometry('13')
+geometry_world = pymcnp.inp.cell.Geometry('14')
 
 # Creating cells.
 cell_air = pymcnp.inp.Cell(number=1, material=21, density=0.5, geometry=geometry_air)

scripts/inp_data.py

@@ -141,7 +141,7 @@ def __init__(
                 ),
                 AttributeScheme(
                     name='geometry',
-                    type='types.Geometry',
+                    type='cell.Geometry',
                     description='cell geometry',
                     restriction='# TODO #',
                 ),
@@ -6182,7 +6182,7 @@ def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True
                             attributes=[
                                 AttributeScheme(
                                     name='energy',
-                                    type='types.DistributionNumber',
+                                    type='types.Distribution',
                                     description='Kinetic energy',
                                 ),
                             ],
@@ -6204,7 +6204,7 @@ def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True
                             attributes=[
                                 AttributeScheme(
                                     name='time',
-                                    type='types.EmbeddedDistributionNumber',
+                                    type='types.EmbeddedDistribution',
                                     description='Time in shakes',
                                 ),
                             ],
@@ -6227,7 +6227,7 @@ def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True
                             attributes=[
                                 AttributeScheme(
                                     name='cosine',
-                                    type='types.DistributionNumber',
+                                    type='types.Distribution',
                                     description='Cosine of the angle between VEC and particle',
                                     optional=True,
                                 ),
@@ -6293,7 +6293,7 @@ def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True
                             attributes=[
                                 AttributeScheme(
                                     name='radial_distance',
-                                    type='types.DistributionNumber',
+                                    type='types.Distribution',
                                     description='Radial distance fo the position from POS or AXS',
                                 ),
                             ],
@@ -6551,7 +6551,7 @@ def from_formula(number: int, formulas: dict[str, float], is_weight: bool = True
                         ),
                         AttributeScheme(
                             name='information',
-                            type='types.Tuple[types.DistributionNumber]',
+                            type='types.Tuple[types.Distribution]',
                             description='Particle source information',
                         ),
                     ],
@@ -6977,7 +6977,7 @@ def to_mcnp(self):
                             attributes=[
                                 AttributeScheme(
                                     name='number',
-                                    type='types.DistributionNumber',
+                                    type='types.Distribution',
                                     description='Particle weight',
                                 ),
                             ],
@@ -7022,7 +7022,7 @@ def to_mcnp(self):
                             attributes=[
                                 AttributeScheme(
                                     name='number',
-                                    type='types.DistributionNumber',
+                                    type='types.Distribution',
                                     description='Distribution number for baising sampling',
                                 ),
                             ],

scripts/inp_tests.py

@@ -1,8 +1,8 @@
 import re
 
 from . import inp
-from .utils import types
-from .utils import errors
+from . import types
+from . import errors
 from .utils import _parser
 from .utils import _object
 from .utils import _visualization
@@ -61,14 +61,14 @@ def from_mcnp(source: str):
             ``Inp``.
 
         Raises:
-            InpError: SYNTAX_INP.
+            InpError: SYNTAX_FILE.
         """
 
         source, comments = _parser.preprocess_inp(source)
         tokens = Inp._REGEX.match(source)
 
         if not tokens:
-            raise errors.InpError(errors.InpCode.SYNTAX_INP, source)
+            raise errors.InpError(errors.InpCode.SYNTAX_FILE, source)
 
         message = types.String.from_mcnp(tokens[1]) if tokens[1] else None
         title = types.String.from_mcnp(tokens[2])
@@ -192,7 +192,7 @@ def title(self, title: str | types.String) -> None:
                 title = types.String.from_mcnp(title)
 
         if title is None or not len(title) < 80:
-            raise errors.InpError(errors.InpCode.SEMANTICS_INP, title)
+            raise errors.InpError(errors.InpCode.SEMANTICS_FILE, title)
 
         self._title: types.Integer = title
 
@@ -245,7 +245,7 @@ def cells(self, cells: list[str] | list[inp.Cell | inp.Like | inp.Comment]) -> N
             cells = types.Tuple(array)
 
         if cells is None or None in cells:
-            raise errors.InpError(errors.InpCode.SEMANTICS_INP, cells)
+            raise errors.InpError(errors.InpCode.SEMANTICS_FILE, cells)
 
         self._cells: types.Integer = cells
 
@@ -292,7 +292,7 @@ def surfaces(self, surfaces: list[str] | list[inp.Surface | inp.Comment]) -> Non
             surfaces = types.Tuple(array)
 
         if surfaces is None or None in surfaces:
-            raise errors.InpError(errors.InpCode.SEMANTICS_INP, surfaces)
+            raise errors.InpError(errors.InpCode.SEMANTICS_FILE, surfaces)
 
         self._surfaces: types.Integer = surfaces
 
@@ -340,7 +340,7 @@ def data(self, data: list[str] | list[inp.Data | inp.Comment]) -> None:
             data = types.Tuple(array)
 
         if data is None or None in data:
-            raise errors.InpError(errors.InpCode.SEMANTICS_INP, data)
+            raise errors.InpError(errors.InpCode.SEMANTICS_FILE, data)
 
         self._data: types.Integer = data
 

src/pymcnp/Inp.py

@@ -2,7 +2,7 @@
 import typing
 
 from . import meshtal
-from .utils import errors
+from . import errors
 from .utils import _object
 
 
@@ -29,15 +29,15 @@ def __init__(self, header: meshtal.Header, tallies: typing.Generator[meshtal.Tal
             ``Meshtal``.
 
         Raises:
-            MeshtalError: SEMANTICS_MESHTAL_HEADER.
-            MeshtalError: SEMANTICS_MESHTAL_TALLIES.
+            MeshtalError: SEMANTICS_FILE_HEADER.
+            MeshtalError: SEMANTICS_FILE_TALLIES.
         """
 
         if header is None:
-            raise errors.MeshtalError(errors.MeshtalCode.SEMANTICS_MESHTAL)
+            raise errors.MeshtalError(errors.MeshtalCode.SEMANTICS_FILE)
 
         if tallies is None:
-            raise errors.MeshtalError(errors.MeshtalCode.SEMANTICS_MESHTAL)
+            raise errors.MeshtalError(errors.MeshtalCode.SEMANTICS_FILE)
 
         self.header: typing.Final[meshtal.Header] = header
         self.tallies: typing.Final[typing.Generator[typing.Generator[meshtal.Tally, None, None]]] = tallies
@@ -57,7 +57,7 @@ def from_mcnp(source: str):
         tokens = Meshtal._REGEX.match(source)
 
         if not tokens:
-            raise errors.MeshtalError(errors.MeshtalCode.SYNTAX_MESHTAL, source)
+            raise errors.MeshtalError(errors.MeshtalCode.SYNTAX_FILE, source)
 
         header = meshtal.Header.from_mcnp(tokens[1])
         tallies = (meshtal.Tally.from_mcnp(match[0], header) for match in meshtal.Tally._REGEX.finditer(tokens[12]))

src/pymcnp/Meshtal.py

@@ -3,8 +3,8 @@
 
 
 from . import outp
-from .utils import types
-from .utils import errors
+from . import types
+from . import errors
 from .utils import _object
 
 
@@ -38,10 +38,10 @@ def __init__(
         """
 
         if header is None:
-            raise errors.OutpError(errors.OutpCode.SEMANTICS_TABLE, header)
+            raise errors.OutpError(errors.OutpCode.SEMANTICS_FILE, header)
 
         if blocks is None or None in blocks:
-            raise errors.OutpError(errors.OutpCode.SEMANTICS_TABLE, blocks)
+            raise errors.OutpError(errors.OutpCode.SEMANTICS_FILE, blocks)
 
         self.header: typing.Final[outp.Header] = header
         self.blocks: typing.Final[types.Tuple[outp.Block]] = blocks
@@ -107,6 +107,6 @@ def to_dataframe(self):
 
         for block in self.blocks:
             if hasattr(block, 'to_dataframe'):
-                tallies[block.number.strip()] = block.to_dataframe()
+                tallies[block.number.value.strip()] = block.to_dataframe()
 
         return tallies

src/pymcnp/Outp.py

@@ -2,8 +2,8 @@
 import typing
 
 from . import ptrac
-from .utils import types
-from .utils import errors
+from . import types
+from . import errors
 from .utils import _object
 
 
@@ -30,14 +30,14 @@ def __init__(self, header: ptrac.Header, histories: typing.Generator[ptrac.Histo
             ``Ptrac``.
 
         Raises:
-            PtracError: SEMANTICS_PTRAC.
+            PtracError: SEMANTICS_FILE.
         """
 
         if header is None:
-            raise errors.PtracError(errors.PtracCode.SEMANTICS_PTRAC, header)
+            raise errors.PtracError(errors.PtracCode.SEMANTICS_FILE, header)
 
         if histories is None:
-            raise errors.PtracError(errors.PtracCode.SEMANTICS_PTRAC, histories)
+            raise errors.PtracError(errors.PtracCode.SEMANTICS_FILE, histories)
 
         self.header: typing.Final[ptrac.Header] = header
         self.histories: typing.Final[typing.Generator[ptrac.History, None, None]] = histories
@@ -54,13 +54,13 @@ def from_mcnp(source: str):
             ``Ptrac``.
 
         Raises:
-            PtracError: SYNTAX_PTRAC.
+            PtracError: SYNTAX_FILE.
         """
 
         tokens = Ptrac._REGEX.match(source)
 
         if not tokens:
-            raise errors.PtracError(errors.PtracCode.SYNTAX_PTRAC, source)
+            raise errors.PtracError(errors.PtracCode.SYNTAX_FILE, source)
 
         header = ptrac.Header.from_mcnp(tokens[1])
         histories = types.Tuple(ptrac.History.from_mcnp(match[0], header) for match in re.finditer(ptrac.History._REGEX.pattern[2:-2], tokens[10]))

src/pymcnp/Ptrac.py

@@ -1,45 +1,33 @@
-# UTILS
-from .utils import types
-from .utils import errors
-
-from .cli.run import Run
+from . import cli
+from . import errors
 from . import inp
-from .Inp import Inp
+from . import meshtal
+from . import outp
 from . import ptrac
+from . import types
+from .Inp import Inp
+from .Meshtal import Meshtal
+from .Outp import Outp
 from .Ptrac import Ptrac
 from .PtracFiltered import PtracFiltered
 from .PtracProcessed import PtracProcessed
-from . import meshtal
-from .Meshtal import Meshtal
 from .MeshtalFiltered import MeshtalFiltered
 from .MeshtalProcessed import MeshtalProcessed
 
-from . import outp
-from .Outp import Outp
-
-read_input = Inp.from_file
-read_ptrac = Ptrac.from_file
-read_meshtal = Meshtal.from_file
-read_output = Outp.from_file
-
 __all__ = [
-    'types',
+    'cli',
     'errors',
-    'Run',
     'inp',
-    'Inp',
+    'meshtal',
+    'outp',
     'ptrac',
+    'types',
+    'Inp',
+    'Meshtal',
+    'Outp',
     'Ptrac',
     'PtracFiltered',
     'PtracProcessed',
-    'meshtal',
-    'Meshtal',
     'MeshtalFiltered',
     'MeshtalProcessed',
-    'outp',
-    'Outp',
-    'read_input',
-    'read_ptrac',
-    'read_meshtal',
-    'read_output',
 ]

src/pymcnp/__init__.py

@@ -1,7 +1,12 @@
-from .run import Run
-from .check import Check
-from .convert import Convert
-from .plot import Plot
-from .visualize import Visualize
+from . import Run as run
+from . import Check as check
+from . import Convert as convert
+from . import Plot as plot
+from . import Visualize as visualize
+from .Run import Run
+from .Check import Check
+from .Convert import Convert
+from .Plot import Plot
+from .Visualize import Visualize
 
-__all__ = ['Run', 'Check', 'Convert', 'Plot', 'Visualize']
+__all__ = ['run', 'check', 'convert', 'plot', 'visualize', 'Run', 'Check', 'Convert', 'Plot', 'Visualize']

src/pymcnp/cli/__init__.py

@@ -0,0 +1,6 @@
+class Doer:
+    """
+    Represents cli backend classes.
+    """
+
+    pass