Falcon 3.0 Roadmap

falcon-3.0-roadmap.md

Falcon 3.0 Roadmap

3.0.0a1

• Review/Merge the ASGI implementation - PR #1573
• Review/Merge native form parsing (WSGI only) - PR #1549
• Fix doc formatting issue (see also comment on PR #1566)
• Get tests to pass on Windows
• Add windows gate to Travis CI

3.0.0a2

• Tweak ASGI and form interfaces (if needed) based on alpha tester feedback
• Finish ASGI Docs (including Changelog snippets)
• Finish multipart form parsing docs
• Add async support for multipart form parsing
• Review/Merge PR backlog

3.0.0a3

• ASGI WebSocket impl. + docs - PR #1741
• Tweak ASGI and form interfaces (if needed) based on alpha tester feedback
• Review/Merge PR backlog

3.0.0b1

• ASGI tutorial
• Implement and merge remaining items from the 3.0 milestone in the issue tracker (delay low-priority items to 3.1/4.0 as needed)
• Semi-final performance testing and optimization
• Semi-final changelog updates
• Render changelog news fragments (so far)

3.0.0bx

• Bug fixes
• Final performance testing and optimization
• Final changelog updates
• Review/Merge PR backlog (or delay community PRs to 3.x/4.x as needed)

3.0.0rc1

• Critical bug fixes and non-invasive documentation improvements ONLY
• Render changelog news fragments to changelog and remove fragment files
• Finalize "Contributors to this Release" section in the changelog
• Add release summary to changelog

3.0.0

• Stable release!
• Update sponsors on falconframework.org - #1838
• Update benchmarks on falconframework.org - #1822
• Update colors and/or layout on falconframework.org so people know something has changed (i.e., 3.0) - #1028

New: Second beta now available for testing. First release candidate will arrive soon, so please test this beta ASAP. Thanks! https://github.com/falconry/falcon/releases/tag/3.0.0b2

https://github.com/falconry/falcon/releases/tag/3.0.0rc1

rc2 is now available - https://github.com/falconry/falcon/releases/tag/3.0.0rc2

Silly question, but are you still supporting Cython in v3.0? I ask because I wasn't sure if you were going to ship Cythonized versions of the package or if you want us to do a command like pip3 install -v --no-binary :all: falcon==3.0.0rc2 every time we install.

I've also been using Poetry for the past year or so and it has been great: https://python-poetry.org/

Hi @btegs,
And sorry for the confusion, we'll check the docs.

But the answer is that we are shipping wheels for all popular platforms and architectures, so normally you shouldn't need to cythonize manually that way.

Hi @btegs,
And sorry for the confusion, we'll check the docs.

But the answer is that we are shipping wheels for all popular platforms and architectures, so normally you shouldn't need to cythonize manually that way.

Sounds good. Btw have you tried Poetry before? I find it handy when I mix it with pyenv, install the Python version I want, then use either a local or global .python-version and run poetry new project1 to keep everything organized and manage my packages in the .toml file.

I've tried Poetry briefly, but haven't looked more in depth. It is listed as one of the alternatives if/when we decide to proceed with PEP 517. Poetry looks to be the most solid option for managing dependencies by a country mile, but, OTOH, Falcon has no hard dependencies on any third party library.

Resorting to pip install --no-binary :all: ... is still needed in case the wheel is unavailable, which might happen in the following scenarios:

• No wheel is available for the interpreter in question, e.g., Python 3.10 is released and our stable release won't have a wheel for that.
• No wheel is available for the architecture in question, like i386 etc.
• It is desirable to deploy a version other than a release on PyPi, e.g., the latest GitHub snapshot etc.

Btw regarding Falcon 3.0 + Cython, there are some good news, and some worse:

• ➕ (Blowing my own 🎺 here) we are now offering pure Cython code for certain parts of the framework, like decoding a query string. On CPython, this can outperform the std lib by an order of magnitude for percent-encoded query strings.
• ➖ Parts of our ASGI code are not cythonized, as we haven't found any way to utilize a cythonized coroutine in any ASGI server. It seems that wrapping it in another Python async task degrades the performance to worse than pure Python. We'll circle back on this in 3.1: maybe there is a way to speed up coroutines with Cython in a more usable way, or maybe we could offer patches to the popular uvicorn (or other ASGI servers) to somehow remove the said barrier, if at all possible. FWIW, to that end, we have also tried Cython 3.0 alpha, and while that offered a slight improvement, it did not eliminate the issue.

Btw, absent critical bugs, the plan is to ship a stable release on Monday or Tuesday (6th/7th April).

Btw, absent critical bugs, the plan is to ship a stable release on Monday or Tuesday (6th/7th April).

Awesome!

The final release is here! https://github.com/falconry/falcon/releases/tag/3.0.0

First bug fix release: https://github.com/falconry/falcon/releases/tag/3.0.1