feat(request): new method get_param_as_dict by StepanUFL · Pull Request #2544 · falconry/falcon

StepanUFL · 2025-10-07T09:45:00Z

Add a new method get_param_as_dict in order to handle OAS "objects"

Closes issue #2542

Summary of Changes

A new method req.get_param_as_dict() has added to the Request class in falcon/util/request.py

Related Issues

Closes #2542.

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. Reading our contribution guide at least once will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

Hope this is worthy enough for you all! If there's improvements to be made, let me know

Add a new method get_param_as_dict in order to handle OAS "objects" Closes issue falconry#2542

codecov · 2025-10-07T11:01:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (002fa6c) to head (bae1d32).

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #2544   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         7911      7945   +34     
  Branches      1086      1096   +10     
=========================================
+ Hits          7911      7945   +34

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

CaselIT

thanks for the contribution, I've left a few suggestions

falcon/request.py

CaselIT · 2025-10-07T20:08:19Z

falcon/request.py

+        deep_object: bool = False,
+        store: StoreArg = None,
+        default: Any | None = None,
+    ) -> Any:


this is likely dict[str, str | None] | None even if we don't want to do the overload like the other ones

CaselIT · 2025-10-07T20:09:14Z

falcon/request.py

+        if deep_object:
+            oc: dict[str, Any] = {}
+            for key, value in self._params.items():
+                if not key.startswith(f'{name}[') and key.endswith(']'):


I guess we could optimize this a bit by caching the format, but it's likely not that important

Another thing to try would be to benchmark this flow vs using a regex, but I doubt a regex would be faster.

CaselIT · 2025-10-07T20:12:11Z

falcon/request.py

+                inner = key[len(name) + 1 : -1]
+
+                if isinstance(value, (list, tuple)):
+                    oc[inner] = value[0] if value else None


not sure if we want to use '' instead of None here. depending on it we may want to update the returned type here https://github.com/falconry/falcon/pull/2544/files#r2411775142

Q: does this case ever happen (empty list)?

probably not in actual requests... left check in to be safe but can take out

from my point of view we could keep this check just to be paranoid, but I would use '' in the else case, so that we can just day that the returned values are strings in all cases

CaselIT · 2025-10-07T20:15:14Z

tests/test_request_params.py

@@ -0,0 +1,118 @@
+from __future__ import annotations


we already have a file for these test, called tests/test_query_params.py. could you move the tests there?

also you can probably check there how those methods are tested

CaselIT · 2025-10-07T20:19:40Z

falcon/request.py

+                output = dict(zip(values_list[::2], values_list[1::2]))
+
+        if store is not None and isinstance(output, dict):
+            store.update(output)


I think we should do like in the other methods

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

CaselIT · 2025-10-07T20:20:30Z

tests/test_request_params.py

+
+
+def test_deep_object_with_list_values():
+    req = DummyRequestParams({'user[name]': ['Bond'], 'user[id]': ['007']})


also test an with a list of multiple objects

and if we decide that an empty list can indeed happen, also an empty list

Co-authored-by: Federico Caselli <cfederico87@gmail.com>

vytas7

Thanks for this PR!
The base structure looks good, although I had a handful of nitpicks wrt the implementation (see inline).

vytas7 · 2025-10-10T19:59:33Z

falcon/request.py

+            HTTPBadRequest: A required param is missing from the request, or
+                the value could not be parsed from the parameter.
+
+        .. versionadded:: 4.1.0


This needs to be the current development version, Falcon 4.2.0, not 4.1.0 (which is already released).

vytas7 · 2025-10-10T20:01:02Z

falcon/request.py

+
+        else:
+            try:
+                values_list = self.get_param_as_list(name)


Could you add a TODO comment here to also support delimiter from #2538?

vytas7 · 2025-10-10T20:02:24Z

falcon/request.py

+                values_list = self.get_param_as_list(name)
+            except errors.HTTPBadRequest:
+                msg = 'It could not parse the query parameter'
+                raise errors.HTTPInvalidParam(msg, name) from None


Does raising from None have any special purpose here?
Add a code comment explaining the reasoning if there is any clever trick behind this.

vytas7 · 2025-10-10T20:03:07Z

falcon/request.py

+            try:
+                values_list = self.get_param_as_list(name)
+            except errors.HTTPBadRequest:
+                msg = 'It could not parse the query parameter'


This "It" here sounds slightly odd, could we try to make it more similar to other error messages?

vytas7 · 2025-10-10T20:04:43Z

falcon/request.py

+            if values_list is None:
+                if required:
+                    msg = 'Missing query parameter'
+                    raise errors.HTTPMissingParam(msg)


HTTPMissingParam takes the name of the missing parameter as its first argument, not an error message.

vytas7 · 2025-10-10T20:06:06Z

falcon/request.py

+
+            else:
+                if len(values_list) % 2 != 0:
+                    msg = 'Invalid parameter format, list elements must be even'


To be precise list elements cannot be even per se unless they are integer numbers. Suggested rewording: "...the number of list elements must be even".

vytas7 · 2025-10-10T20:09:04Z

tests/test_request_params.py

+
+
+# NOTE(StepanUFL): If a better way to make this play well with mypy exists...
+DummyRequestParams.get_param_as_dict = Request.get_param_as_dict  # type: ignore[method-assign, assignment]


Defining a new fake DummyRequestParams is a somewhat unorthodox way to approach this 🤔.

Maybe we could simulate request, or simply construct a normal req object via create_req() (and create_asgi_req())?

To that end, we also have a util fixture (see tests/conftest.py), which can already construct both WSGI and ASGI requests, see util.create_req(asgi, ...).

vytas7 · 2026-03-08T09:53:48Z

Hi again @StepanUFL, just checking if you are still considering to finish this PR?

StepanUFL and others added 2 commits October 7, 2025 05:35

feat(request): new method get_param_as_dict

f945b51

Add a new method get_param_as_dict in order to handle OAS "objects" Closes issue falconry#2542

Merge branch 'master' into feature/request-git-param-as-dict

b3c4129

CaselIT requested changes Oct 7, 2025

View reviewed changes

StepanUFL and others added 3 commits October 7, 2025 16:41

Update falcon/request.py

48677fc

Co-authored-by: Federico Caselli <cfederico87@gmail.com>

Update falcon/request.py

28a57cc

Co-authored-by: Federico Caselli <cfederico87@gmail.com>

Merge branch 'master' into feature/request-git-param-as-dict

1f85fb3

vytas7 requested changes Oct 10, 2025

View reviewed changes

vytas7 added the hacktoberfest-accepted label Oct 29, 2025

vytas7 added blocked-by-release and removed blocked-by-release labels Nov 8, 2025

vytas7 removed the hacktoberfest-accepted label Jan 2, 2026

Merge branch 'master' into feature/request-git-param-as-dict

5782d5c

Merge branch 'master' into feature/request-git-param-as-dict

bae1d32



		def test_deep_object_with_list_values():
		req = DummyRequestParams({'user[name]': ['Bond'], 'user[id]': ['007']})



		# NOTE(StepanUFL): If a better way to make this play well with mypy exists...
		DummyRequestParams.get_param_as_dict = Request.get_param_as_dict # type: ignore[method-assign, assignment]

Uh oh!

Conversation

StepanUFL commented Oct 7, 2025 • edited by vytas7 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

Related Issues

Pull Request Checklist

Uh oh!

codecov bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

CaselIT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

StepanUFL Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vytas7 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vytas7 commented Mar 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

StepanUFL commented Oct 7, 2025 •

edited by vytas7

Loading

codecov bot commented Oct 7, 2025 •

edited

Loading

StepanUFL Oct 7, 2025 •

edited

Loading