falcon
falcon copied to clipboard
falconry
Privatize helpers, etc. that really should only be used internally by the framework
Falcon modules import a number of helper functions that do not begin with an underscore, although such functions are not meant to be part of the public API. Remedy this in the next major version of the framework (as it would be a breaking change).
Hi @Vorashil ! Yeah, you are very welcome to! Let us know if you are still interested in working on this though so that we do not duplicate efforts.
Hi @vytas7 . Yes, I am still keen to do it. Please assign it to me. Thanks in advance.
We don't assign in any particular way :slightly_smiling_face: Your confirmation here is enough. Looking forward to your PR!
@vytas7 @kgriffs do the helper functions include those shown here? https://github.com/falconry/falcon/blob/105c56db6a727da7231512c43fd4974a53fc960c/falcon/util/sync.py
If so, I'd like to fix these specifically.
Hi @bradleydamato !
Do you have any specific function from sync.py in mind? Most of these functions are meant to be available as utilites in the public API by design: https://falcon.readthedocs.io/en/latest/api/util.html#async . Furthermore, all this sync-async stuff is not a part of any stable release, as it was introduced only as part of the 3.0.0 release cycle, and we are, at the time of writing, at 3.0.0a2; so we can still make adjustments semi-freely.
As I understand this issue is mostly about functions that are already "public" (i.e., not prefixed with an underscore) in Falcon 2.0, but are not documented, and not meant to be a part of the public API.
I would let @kgriffs confirm, but IMHO falcon.app_helpers.prepare_middleware could serve as an illustration. Despite having a decent docstring, it does look to be too deeply tied to internal interfaces and implementation details (returning a tuple of three tuples of methods :slightly_smiling_face: ).
Hello I can take this up. What exactly needs to be done here? and how should i go about it.
