Skip to content

Commit

Permalink
fix: FloatParam marked private as unsupported in CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
CorieW committed Dec 2, 2024
1 parent f516594 commit 955d2aa
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
5 changes: 3 additions & 2 deletions src/firebase_functions/params.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,10 @@ def value(self) -> int:
self.default, Expression) else self.default
return int()


# Marked as private because it is not supported by firebase-tools yet.
# Unmark when it is supported.
@_dataclasses.dataclass(frozen=True)
class FloatParam(Param[float]):
class _FloatParam(Param[float]):
"""A parameter as a float value."""

@property
Expand Down
2 changes: 1 addition & 1 deletion src/firebase_functions/private/manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ def _param_to_spec(
spec_dict["type"] = "boolean"
elif isinstance(param, _params.IntParam):
spec_dict["type"] = "int"
elif isinstance(param, _params.FloatParam):
elif isinstance(param, _params._FloatParam):
spec_dict["type"] = "float"
elif isinstance(param, _params.SecretParam):
spec_dict["type"] = "secret"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
params=[
_params.BoolParam("BOOL_TEST", default=False),
_params.IntParam("INT_TEST", description="int_description"),
_params.FloatParam("FLOAT_TEST", immutable=True),
_params._FloatParam("FLOAT_TEST", immutable=True),
_params.SecretParam("SECRET_TEST"),
_params.StringParam("STRING_TEST"),
_params.ListParam("LIST_TEST", default=["1", "2", "3"]),
Expand Down
10 changes: 5 additions & 5 deletions tests/test_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,26 +58,26 @@ class TestFloatParams:
def test_float_param_value(self):
"""Testing if float params correctly returns a value."""
environ["FLOAT_VALUE_TEST"] = "123.456"
assert params.FloatParam("FLOAT_VALUE_TEST",).value == 123.456, \
assert params._FloatParam("FLOAT_VALUE_TEST",).value == 123.456, \
"Failure, params value != 123.456"

def test_float_param_empty_default(self):
"""Testing if float params defaults to empty float if no value and no default."""
assert params.FloatParam("FLOAT_DEFAULT_TEST1").value == float(), \
assert params._FloatParam("FLOAT_DEFAULT_TEST1").value == float(), \
"Failure, params value is not float"

def test_float_param_default(self):
"""Testing if float param defaults to provided default value."""
assert params.FloatParam("FLOAT_DEFAULT_TEST2",
assert params._FloatParam("FLOAT_DEFAULT_TEST2",
default=float(456.789)).value == 456.789, \
"Failure, params default value != 456.789"

def test_float_param_equality(self):
"""Test float equality."""
assert (params.FloatParam("FLOAT_TEST1",
assert (params._FloatParam("FLOAT_TEST1",
default=123.456).equals(123.456).value
is True), "Failure, equality check returned False"
assert (params.FloatParam("FLOAT_TEST2",
assert (params._FloatParam("FLOAT_TEST2",
default=456.789).equals(123.456).value
is False), "Failure, equality check returned False"

Expand Down

0 comments on commit 955d2aa

Please sign in to comment.