Skip to content

Commit 41957ca

Browse files
committed
Rename sentinel value
1 parent 2c7b6dd commit 41957ca

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

src/parcels/_core/fieldset.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from parcels._core.utils.string import _assert_str_and_python_varname
2121
from parcels._core.utils.time import get_datetime_type_calendar
2222
from parcels._core.utils.time import is_compatible as datetime_is_compatible
23-
from parcels._python import _MISSING, _MissingType
23+
from parcels._python import NOTSET, NotSetType
2424
from parcels._typing import Mesh
2525
from parcels.interpolators import (
2626
XConstantField,
@@ -212,7 +212,7 @@ def from_ugrid_conventions(
212212
cls,
213213
ds: ux.UxDataset,
214214
mesh: str = "spherical",
215-
vector_fields: TVectorFieldMapping | None | _MissingType = _MISSING,
215+
vector_fields: TVectorFieldMapping | None | NotSetType = NOTSET,
216216
):
217217
"""Create a FieldSet from a Parcels compliant uxarray.UxDataset.
218218
@@ -250,7 +250,7 @@ def from_sgrid_conventions(
250250
cls,
251251
ds: xr.Dataset,
252252
mesh: Mesh | None = None,
253-
vector_fields: TVectorFieldMapping | None | _MissingType = _MISSING,
253+
vector_fields: TVectorFieldMapping | None | NotSetType = NOTSET,
254254
): # TODO: Update mesh to be discovered from the dataset metadata
255255
"""Create a FieldSet from a dataset using SGRID convention metadata.
256256

src/parcels/_core/model.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
assert_all_field_dims_have_axis, # noqa: F401, leave import for now until decision is made # TODO v4: Make decision
2020
)
2121
from parcels._logger import logger
22-
from parcels._python import _MISSING, _MissingType
22+
from parcels._python import NOTSET, NotSetType
2323
from parcels._typing import Mesh
2424
from parcels.convert import _ds_rename_using_standard_names
2525
from parcels.interpolators import (
@@ -133,7 +133,7 @@ def construct_fields(self) -> list[Field | VectorField]:
133133

134134
@classmethod
135135
def from_sgrid_conventions(
136-
cls, ds: xr.Dataset, mesh: Mesh | None, vector_fields: TVectorFieldMapping | None | _MissingType
136+
cls, ds: xr.Dataset, mesh: Mesh | None, vector_fields: TVectorFieldMapping | None | NotSetType
137137
) -> Self:
138138
ds = ds.copy()
139139
if mesh is None:
@@ -173,11 +173,11 @@ def from_sgrid_conventions(
173173

174174

175175
def resolve_vector_fields(
176-
ds: xr.Dataset, vector_fields: TVectorFieldMapping | None | _MissingType
176+
ds: xr.Dataset, vector_fields: TVectorFieldMapping | None | NotSetType
177177
) -> TVectorFieldMapping:
178178
if vector_fields is None:
179179
return {}
180-
if vector_fields is _MISSING: # i.e., the default vectorfield discovery behaviour
180+
if vector_fields is NOTSET: # i.e., the default vectorfield discovery behaviour
181181
return _default_vector_field_components(ds.data_vars)
182182
return vector_fields
183183

@@ -262,7 +262,7 @@ def scalar_field_names(self) -> list[str]:
262262

263263
@classmethod
264264
def from_ugrid_conventions(
265-
cls, ds: ux.UxDataset, mesh: Mesh, vector_fields: TVectorFieldMapping | None | _MissingType
265+
cls, ds: ux.UxDataset, mesh: Mesh, vector_fields: TVectorFieldMapping | None | NotSetType
266266
):
267267
ds_dims = list(ds.dims)
268268
if not all(dim in ds_dims for dim in ["time", "zf", "zc"]):

src/parcels/_python.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
K = TypeVar("K")
88
V = TypeVar("V")
99

10-
_MissingType = enum.Enum("_MissingType", "VALUE")
11-
_MISSING = _MissingType.VALUE
10+
NotSetType = enum.Enum("NotSetType", "VALUE")
11+
NOTSET = NotSetType.VALUE
1212

1313

1414
def isinstance_noimport(obj, class_or_tuple):

0 commit comments

Comments
 (0)