Skip to content

Commit

Permalink
refactor getting params
Browse files Browse the repository at this point in the history
  • Loading branch information
@copalco
copalco committed Aug 24, 2024
1 parent b374d50 commit 7101e13
Showing 1 changed file with 33 additions and 92 deletions.
125 changes: 33 additions & 92 deletions falcon/request.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

from datetime import datetime
from io import BytesIO
from typing import TypeVar
from uuid import UUID

from falcon import errors
Expand Down Expand Up @@ -47,6 +48,9 @@
now = datetime.now


ParamType = TypeVar('ParamType')


class Request:
"""Represents a client's HTTP request.
Expand Down Expand Up @@ -1340,27 +1344,23 @@ def get_param(self, name, required=False, store=None, default=None):
"""

params = self._params
param = self._param(name, required, default)
if param and store is not None:
store[name] = param
return param

def _param(self, name: str, required: bool, default: ParamType) -> str:
# PERF: Use if..in since it is a good all-around performer; we don't
# know how likely params are to be specified by clients.
if name in params:
# NOTE(warsaw): If the key appeared multiple times, it will be
# stored internally as a list. We do not define which one
# actually gets returned, but let's pick the last one for grins.
param = params[name]
if isinstance(param, list):
param = param[-1]

if store is not None:
store[name] = param

return param

if not required:
return default

raise errors.HTTPMissingParam(name)
if name in self._params:
val = self._params[name]
if isinstance(val, list):
return val[-1]
else:
return val
if required:
raise errors.HTTPMissingParam(name)
return default

def get_param_as_int(
self,
Expand Down Expand Up @@ -1407,16 +1407,8 @@ def get_param_as_int(
triggering an error.
"""

params = self._params

# PERF: Use if..in since it is a good all-around performer; we don't
# know how likely params are to be specified by clients.
if name in params:
val = params[name]
if isinstance(val, list):
val = val[-1]

val = self._param(name, required, default)
if val:
try:
val = int(val)
except ValueError:
Expand All @@ -1433,13 +1425,7 @@ def get_param_as_int(

if store is not None:
store[name] = val

return val

if not required:
return default

raise errors.HTTPMissingParam(name)
return val

def get_param_as_float(
self,
Expand Down Expand Up @@ -1486,16 +1472,8 @@ def get_param_as_float(
triggering an error.
"""

params = self._params

# PERF: Use if..in since it is a good all-around performer; we don't
# know how likely params are to be specified by clients.
if name in params:
val = params[name]
if isinstance(val, list):
val = val[-1]

val = self._param(name, required, default)
if val:
try:
val = float(val)
except ValueError:
Expand All @@ -1513,12 +1491,7 @@ def get_param_as_float(
if store is not None:
store[name] = val

return val

if not required:
return default

raise errors.HTTPMissingParam(name)
return val

def get_param_as_uuid(self, name, required=False, store=None, default=None):
"""Return the value of a query string parameter as an UUID.
Expand Down Expand Up @@ -1560,16 +1533,8 @@ def get_param_as_uuid(self, name, required=False, store=None, default=None):
it was required to be there, or it was found but could not
be converted to a ``UUID``.
"""

params = self._params

# PERF: Use if..in since it is a good all-around performer; we don't
# know how likely params are to be specified by clients.
if name in params:
val = params[name]
if isinstance(val, list):
val = val[-1]

val = self._param(name, required, default)
if val:
try:
val = UUID(val)
except ValueError:
Expand All @@ -1579,12 +1544,7 @@ def get_param_as_uuid(self, name, required=False, store=None, default=None):
if store is not None:
store[name] = val

return val

if not required:
return default

raise errors.HTTPMissingParam(name)
return val

def get_param_as_bool(
self, name, required=False, store=None, blank_as_true=True, default=None
Expand Down Expand Up @@ -1632,16 +1592,8 @@ def get_param_as_bool(
can not be converted to a ``bool``.
"""

params = self._params

# PERF: Use if..in since it is a good all-around performer; we don't
# know how likely params are to be specified by clients.
if name in params:
val = params[name]
if isinstance(val, list):
val = val[-1]

val = self._param(name, required, default)
if val:
if val in TRUE_STRINGS:
val = True
elif val in FALSE_STRINGS:
Expand All @@ -1655,12 +1607,7 @@ def get_param_as_bool(
if store is not None:
store[name] = val

return val

if not required:
return default

raise errors.HTTPMissingParam(name)
return val

def get_param_as_list(
self, name, transform=None, required=False, store=None, default=None
Expand Down Expand Up @@ -1788,10 +1735,7 @@ def get_param_as_datetime(
the value could not be converted to a ``datetime``.
"""

param_value = self.get_param(name, required=required)

if param_value is None:
return default
param_value = self._param(name, required, default)

try:
date_time = strptime(param_value, format_string)
Expand Down Expand Up @@ -1839,7 +1783,7 @@ def get_param_as_date(
if date_time:
date = date_time.date()
else:
return default
date = datetime

if store is not None:
store[name] = date
Expand Down Expand Up @@ -1881,10 +1825,7 @@ def get_param_as_json(self, name, required=False, store=None, default=None):
the value could not be parsed as JSON.
"""

param_value = self.get_param(name, required=required)

if param_value is None:
return default
param_value = self._param(name, required, default)

handler, _, _ = self.options.media_handlers._resolve(
MEDIA_JSON, MEDIA_JSON, raise_not_found=False
Expand Down

0 comments on commit 7101e13

Please sign in to comment.