1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
.. _introduction:
Introduction
============
Perfection is finally attained not when there is no longer anything
to add, but when there is no longer anything to take away.
*- Antoine de Saint-Exupéry*
`Falcon <https://falconframework.org>`__ is a reliable,
high-performance Python web framework for building
large-scale app backends and microservices. It encourages the REST
architectural style, and tries to do as little as possible while
remaining highly effective.
Falcon apps work with any WSGI server, and run like a champ under
CPython 3.5+ and PyPy 3.5+.
Features
--------
Falcon tries to do as little as possible while remaining highly effective.
- :ref:`ASGI, WSGI <app>`, and :ref:`WebSocket <ws>` support
- Native ``asyncio`` support
- No reliance on magic globals for routing and state management
- Stable interfaces with an emphasis on backwards-compatibility
- Simple API modeling through centralized RESTful :ref:`routing <routing>`
- Highly-optimized, extensible code base
- Easy access to headers and bodies through :ref:`request and response <rr>`
objects
- DRY request processing via :ref:`middleware <middleware>` components and hooks
- Strict adherence to RFCs
- Idiomatic :ref:`HTTP error <errors>` responses
- Straightforward exception handling
- Snappy :ref:`testing <testing>` with WSGI/ASGI helpers and mocks
- CPython 3.5+ and PyPy 3.5+ support
How is Falcon different?
------------------------
We designed Falcon to support the demanding needs of large-scale
microservices and responsive app backends. Falcon complements more
general Python web frameworks by providing bare-metal performance,
reliability, and flexibility wherever you need it.
**Fast.** Same hardware, more requests. Falcon turns around
requests several times faster than most other Python frameworks. For
an extra speed boost, Falcon compiles itself with Cython when
available, and also works well with `PyPy <https://pypy.org>`__.
Considering a move to another programming language? Benchmark with
Falcon + PyPy first.
**Reliable.** We go to great lengths to avoid introducing
breaking changes, and when we do they are fully documented and only
introduced (in the spirit of
`SemVer <http://semver.org/>`__) with a major version
increment. The code is rigorously tested with numerous inputs and we
require 100% coverage at all times. Falcon does not depend on any
external Python packages.
**Debuggable.** Falcon eschews magic. It's easy to tell which inputs lead to
which outputs. To avoid incentivizing the use of hard-to-debug global state,
Falcon does not use decorators to define routes. Unhandled exceptions are never
encapsulated or masked. Potentially surprising behaviors, such as automatic
request body parsing, are well-documented and disabled by default. Finally, we
take care to keep logic paths within the framework simple, shallow and
understandable. All of this makes it easier to reason about the code and to
debug edge cases in large-scale deployments.
**Flexible.** Falcon leaves a lot of decisions and implementation
details to you, the API developer. This gives you a lot of freedom to
customize and tune your implementation. Due to Falcon's minimalist
design, Python community members are free to independently innovate on
`Falcon add-ons and complementary packages <https://github.com/falconry/falcon/wiki>`__.
About Apache 2.0
----------------
Falcon is released under the terms of the `Apache 2.0 License`_. This means that you can use it in your commercial applications without having to also open-source your own code. It also means that if someone happens to contribute code that is associated with a patent, you are granted a free license to use said patent. That's a pretty sweet deal.
Now, if you do make changes to Falcon itself, please consider contributing your awesome work back to the community.
.. _`Apache 2.0 License`: http://opensource.org/licenses/Apache-2.0
Falcon License
--------------
Copyright 2012-2017 by Rackspace Hosting, Inc. and other contributors,
as noted in the individual source code files.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
By contributing to this project, you agree to also license your source
code under the terms of the Apache License, Version 2.0, as described
above.
|
