fixup: move type definitions to an internal _typing module

yt-project · Oct 11, 2021 · 1a3baf6 · 1a3baf6
1 parent 9029122
commit 1a3baf6
Show file tree

Hide file tree

Showing 23 changed files with 47 additions and 27 deletions.
diff --git a/yt/_typing.py b/yt/_typing.py
@@ -0,0 +1,4 @@
+from typing import List, Optional, Tuple
+
+FieldDescT = Tuple[str, Tuple[str, List[str], Optional[str]]]
+KnownFieldsT = Tuple[FieldDescT, ...]
diff --git a/yt/fields/field_info_container.py b/yt/fields/field_info_container.py
@@ -1,11 +1,12 @@
 from collections import defaultdict
 from numbers import Number as numeric_type
-from typing import List, Optional, Tuple
+from typing import Optional, Tuple
 
 import numpy as np
 from unyt.exceptions import UnitConversionError
 
 from yt._maintenance.deprecation import issue_deprecation_warning
+from yt._typing import KnownFieldsT
 from yt.fields.field_exceptions import NeedsConfiguration
 from yt.funcs import mylog, only_on_root
 from yt.geometry.geometry_handler import is_curvilinear
@@ -40,11 +41,6 @@ def tupleize(inp):
     )
 
 
-# TODO: move to a _typing module
-FieldDescT = Tuple[str, Tuple[str, List[str], Optional[str]]]
-KnownFieldsT = Tuple[FieldDescT, ...]
-
-
 class FieldInfoContainer(dict):
     """
     This is a generic field container.  It contains a list of potential derived

diff --git a/yt/frontends/adaptahop/fields.py b/yt/frontends/adaptahop/fields.py
@@ -5,7 +5,8 @@
 
 
 """
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 m_units = "1e11 * Msun"
 r_units = "Mpc"

diff --git a/yt/frontends/ahf/fields.py b/yt/frontends/ahf/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 m_units = "Msun/h"
 p_units = "kpccm/h"

diff --git a/yt/frontends/art/fields.py b/yt/frontends/art/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 b_units = "code_magnetic"
 ra_units = "code_length / code_time**2"

diff --git a/yt/frontends/artio/fields.py b/yt/frontends/artio/fields.py
@@ -1,6 +1,7 @@
 import numpy as np
 
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.units.yt_array import YTArray
 from yt.utilities.physical_constants import amu_cgs, boltzmann_constant_cgs
 

diff --git a/yt/frontends/athena/fields.py b/yt/frontends/athena/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.utilities.physical_constants import kboltz, mh
 
 b_units = "code_magnetic"

diff --git a/yt/frontends/athena_pp/fields.py b/yt/frontends/athena_pp/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.utilities.physical_constants import kboltz, mh
 
 b_units = "code_magnetic"

diff --git a/yt/frontends/boxlib/fields.py b/yt/frontends/boxlib/fields.py
@@ -3,7 +3,8 @@
 
 import numpy as np
 
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.units import YTQuantity
 from yt.utilities.physical_constants import amu_cgs, boltzmann_constant_cgs, c
 

diff --git a/yt/frontends/chombo/fields.py b/yt/frontends/chombo/fields.py
@@ -1,8 +1,8 @@
 import numpy as np
 
+from yt._typing import KnownFieldsT
 from yt.fields.field_info_container import (
     FieldInfoContainer,
-    KnownFieldsT,
     particle_deposition_functions,
     particle_vector_functions,
     standard_particle_fields,

diff --git a/yt/frontends/enzo/fields.py b/yt/frontends/enzo/fields.py
@@ -1,6 +1,7 @@
 import numpy as np
 
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.utilities.physical_constants import me, mp
 
 b_units = "code_magnetic"

diff --git a/yt/frontends/enzo_e/fields.py b/yt/frontends/enzo_e/fields.py
@@ -1,6 +1,7 @@
 import numpy as np
 
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.fields.magnetic_field import setup_magnetic_field_aliases
 from yt.fields.particle_fields import add_union_field
 from yt.frontends.enzo_e.misc import nested_dict_get

diff --git a/yt/frontends/fits/fields.py b/yt/frontends/fits/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 
 class FITSFieldInfo(FieldInfoContainer):

diff --git a/yt/frontends/flash/fields.py b/yt/frontends/flash/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 # Common fields in FLASH: (Thanks to John ZuHone for this list)
 #

diff --git a/yt/frontends/gadget_fof/fields.py b/yt/frontends/gadget_fof/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 m_units = "code_mass"
 p_units = "code_length"

diff --git a/yt/frontends/gamer/fields.py b/yt/frontends/gamer/fields.py
@@ -1,6 +1,7 @@
 import numpy as np
 
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 b_units = "code_magnetic"
 pre_units = "code_mass / (code_length*code_time**2)"

diff --git a/yt/frontends/gizmo/fields.py b/yt/frontends/gizmo/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.fields.magnetic_field import setup_magnetic_field_aliases
 from yt.fields.species_fields import add_species_field_by_density, setup_species_fields
 from yt.frontends.gadget.fields import GadgetFieldInfo

diff --git a/yt/frontends/halo_catalog/fields.py b/yt/frontends/halo_catalog/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 m_units = "g"
 p_units = "cm"

diff --git a/yt/frontends/owls_subfind/fields.py b/yt/frontends/owls_subfind/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 m_units = "code_mass"
 mdot_units = "code_mass / code_time"

diff --git a/yt/frontends/ramses/fields.py b/yt/frontends/ramses/fields.py
@@ -3,7 +3,8 @@
 import numpy as np
 
 from yt import units
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.frontends.ramses.io import convert_ramses_ages
 from yt.utilities.cython_fortran_utils import FortranFile
 from yt.utilities.linear_interpolators import BilinearFieldInterpolator

diff --git a/yt/frontends/rockstar/fields.py b/yt/frontends/rockstar/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 m_units = "Msun / h"  # Msun / h
 p_units = "Mpccm / h"  # Mpc / h comoving

diff --git a/yt/frontends/sph/fields.py b/yt/frontends/sph/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 from yt.fields.species_fields import setup_species_fields
 
 

diff --git a/yt/frontends/stream/fields.py b/yt/frontends/stream/fields.py
@@ -1,4 +1,5 @@
-from yt.fields.field_info_container import FieldInfoContainer, KnownFieldsT
+from yt._typing import KnownFieldsT
+from yt.fields.field_info_container import FieldInfoContainer
 
 
 class StreamFieldInfo(FieldInfoContainer):