falconry / falcon Goto Github PK

Tie to Rawr, Fluffy White Stuff articles on Python web server performance. Consider implementing part of test app in something like Flask and/or Pecan for context.

Validation helpers that throw appropriate HTTP exceptions for URI params as well as the body (validate XML, JSON).

Would this be better as a separate project/add-on?

Magic assertions, oh my!

Add helpers to get params as a list (make explicit, similar to how this works for int)

Plunder the test suite for useful helper functions and classes that would enable unit-testing of services that depend on Falcon.

Using:

pip install falcon

Produces:

(FalconExample)chads-mac-mini:FalconExample chadlung$ pip install falcon
Downloading/unpacking falcon
Could not find any downloads that satisfy the requirement falcon
No distributions at all found for falcon

Detailed Error Log Data:

Downloading/unpacking falcon

Getting page http://pypi.python.org/simple/falcon
URLs to search for versions for falcon:

• http://pypi.python.org/simple/falcon/
  Getting page https://github.com/racker/falcon
  Analyzing links from page http://pypi.python.org/simple/falcon/
  Skipping link http://pypi.python.org/packages/2.7/f/falcon/falcon-0.0.1-py2.7.egg#md5=cf05f40e9b936882f31abaac196c2d28 (from http://pypi.python.org/simple/falcon/); unknown archive format: .egg
  Skipping link https://github.com/racker/falcon (from http://pypi.python.org/simple/falcon/); not a file
  Analyzing links from page https://github.com/racker/falcon
  Skipping link https://github.com/opensearch.xml (from https://github.com/racker/falcon); unknown archive format: .xml
  Skipping link https://github.com/fluidicon.png (from https://github.com/racker/falcon); unknown archive format: .png
  Skipping link https://github.com/racker/apple-touch-icon-114.png (from https://github.com/racker/falcon); unknown archive format: .png
  Skipping link https://github.com/racker/apple-touch-icon-144.png (from https://github.com/racker/falcon); unknown archive format: .png
  Skipping link http://github-media-downloads.s3.amazonaws.com/github-logo.svg (from https://github.com/racker/falcon); unknown archive format: .svg
  Skipping link https://github.com/favicon.ico (from https://github.com/racker/falcon); unknown archive format: .ico
  Skipping link https://a248.e.akamai.net/assets.github.com/assets/github-5cd6c534cb445a9d0da23349b0dee8dcb14a3045.css (from https://github.com/racker/falcon); unknown archive format: .css
  Skipping link https://a248.e.akamai.net/assets.github.com/assets/github2-6e435db7b63fa6c2a062d4026dc820e7b6254f34.css (from https://github.com/racker/falcon); unknown archive format: .css
  Skipping link https://github.com/racker/falcon/tree/23f1b284e257774a67bd00278d65772430931710 (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/commits/master.atom (from https://github.com/racker/falcon); unknown archive format: .atom
  Skipping link https://github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/explore (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/search (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/features (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/blog (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/signup (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/login?return_to=%2Fracker%2Ffalcon (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/stargazers (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/network (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/pulls (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/issues (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/graphs (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/languages/Python (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/languages/Shell (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon#readme (from https://github.com/racker/falcon); not a file
  Could not parse version from link: https://github.com/racker/falcon/archive/master.zip (from https://github.com/racker/falcon)
  Skipping link https://github.com/racker/falcon/archive/master.zip (from https://github.com/racker/falcon); wrong project name (not falcon)
  Skipping link https://github.com/racker/falcon.git (from https://github.com/racker/falcon); unknown archive format: .git
  Skipping link https://github.com/racker/[email protected]:racker/falcon.git (from https://github.com/racker/falcon); unknown archive format: .git
  Skipping link git://github.com/racker/falcon.git (from https://github.com/racker/falcon); unknown archive format: .git
  Skipping link https://github.com/racker/falcon/tags (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/tree/master (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/tree/v0.0.1 (from https://github.com/racker/falcon); unknown archive format: .1
  Skipping link https://github.com/racker/falcon/commits/master (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/branches (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/find/master (from https://github.com/racker/falcon); not a file
  Skipping link 23f1b28 (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/kgriffs (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/tree/master/bench (from https://github.com/racker/falcon); not a file
  Skipping link 2b91261 (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/tree/master/falcon (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/tree/master/tests (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/.gitignore (from https://github.com/racker/falcon); not a file
  Skipping link 54b3b2e (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/AUTHORS (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/LICENSE (from https://github.com/racker/falcon); not a file
  Skipping link 00441ef (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/NEWS.md (from https://github.com/racker/falcon); unknown archive format: .md
  Skipping link adbf04e (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/NOTES.md (from https://github.com/racker/falcon); unknown archive format: .md
  Skipping link be497f1 (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/README.md (from https://github.com/racker/falcon); unknown archive format: .md
  Skipping link https://github.com/racker/falcon/blob/master/cover.sh (from https://github.com/racker/falcon); unknown archive format: .sh
  Skipping link c854cc7 (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon/blob/master/setup.cfg (from https://github.com/racker/falcon); unknown archive format: .cfg
  Skipping link https://github.com/racker/falcon/blob/master/setup.py (from https://github.com/racker/falcon); unknown archive format: .py
  Skipping link https://github.com/racker/falcon/blob/master/tox.ini (from https://github.com/racker/falcon); unknown archive format: .ini
  Skipping link https://github.com/racker/falcon#falcon (from https://github.com/racker/falcon); not a file
  Skipping link https://upload.wikimedia.org/wikipedia/commons/thumb/3/39/Brown-Falcon%2C-Vic%2C-3.1.2008.jpg/160px-Brown-Falcon%2C-Vic%2C-3.1.2008.jpg (from https://github.com/racker/falcon); unknown archive format: .jpg
  Skipping link https://github.com/racker/falcon#design-goals (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon#install (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon#test (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon#usage (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/racker/falcon#contributing (from https://github.com/racker/falcon); not a file
  Skipping link http://goo.gl/QpbS7 (from https://github.com/racker/falcon); not a file
  Skipping link http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments (from https://github.com/racker/falcon); unknown archive format: .html
  Skipping link https://github.com/about (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/contact (from https://github.com/racker/falcon); not a file
  Skipping link http://enterprise.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://status.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://mac.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://windows.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://eclipse.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://mobile.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://get.gaug.es/ (from https://github.com/racker/falcon); not a file
  Skipping link http://speakerdeck.com (from https://github.com/racker/falcon); not a file
  Skipping link https://gist.github.com (from https://github.com/racker/falcon); not a file
  Skipping link http://jobs.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://help.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://developer.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://github.github.com/github-flavored-markdown/ (from https://github.com/racker/falcon); not a file
  Skipping link http://pages.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link http://training.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/edu (from https://github.com/racker/falcon); not a file
  Skipping link http://shop.github.com (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/plans (from https://github.com/racker/falcon); not a file
  Skipping link http://octodex.github.com/ (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/site/terms (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/site/privacy (from https://github.com/racker/falcon); not a file
  Skipping link https://github.com/security (from https://github.com/racker/falcon); not a file
  Could not find any downloads that satisfy the requirement falcon

No distributions at all found for falcon

Exception information:
Traceback (most recent call last):
File "/Users/chadlung/PythonProjects/FalconExample/lib/python2.7/site-packages/pip-1.2.1-py2.7.egg/pip/basecommand.py", line 107, in main
status = self.run(options, args)
File "/Users/chadlung/PythonProjects/FalconExample/lib/python2.7/site-packages/pip-1.2.1-py2.7.egg/pip/commands/install.py", line 256, in run
requirement_set.prepare_files(finder, force_root_egg_info=self.bundle, bundle=self.bundle)
File "/Users/chadlung/PythonProjects/FalconExample/lib/python2.7/site-packages/pip-1.2.1-py2.7.egg/pip/req.py", line 1011, in prepare_files
url = finder.find_requirement(req_to_install, upgrade=self.upgrade)
File "/Users/chadlung/PythonProjects/FalconExample/lib/python2.7/site-packages/pip-1.2.1-py2.7.egg/pip/index.py", line 157, in find_requirement
raise DistributionNotFound('No distributions at all found for %s' % req)
DistributionNotFound: No distributions at all found for falcon

Mirros Response. And it really is a stream.

Examine memory usage and tweak if needed.

http://guppy-pe.sourceforge.net/

Need to do this in a DRY manner.

Having a mechanism for taking control of exception handling and response generation from them would be ideal in many circumstances. This allows applications to use Exception classes that better fit their domain without having to do any implicit Exception mapping or re-throwing.

Includes:

• client_accepts_xml for Request
• XML serialization for HTTPError

Useful for processing req/resp objects in a DRY way.

Would need a way to possible attach attributes to req/resp objects - ctx dict?

Ideas for hooks:

• Before/after a request, scoped at global or resource level
• Input validators
• Output escapers
• dict serializer/deserializer (e.g., json.dumps) and auto-set media/content type
• Cache-Control

As an API developer, I can set common headers with the flick of the rist.

When the package is installed on a given system, it should compile everything using Cython if available (possibly as an optional argument).

Also, look into annotating the code to further improve performance (would need to auto-generate or something so as not to break running interpreted).

(Copied by @vytas7 from the first comment of #1056 )

The updraft development server: https://github.com/falconry/updraft

Desired Features:

• Auto-reload
• Full pdb support
• Legible Tracebacks

Notes:

• Should probably log out a note about this being a development server.

In Python 3, the body will always be unicode, but in Python 2 it may not be, so have to check.

• Watch for performance regression.
• Need to convert resp.body to a byte string (Python 2) or bytearray (Python 3). Test with gunicorn and such to see if we can just always return a bytearray.
• Allow specifying the encoding, but default to UTF-8.
• Make sure to test with some crazy code points to ensure this all works OK.

Add a devops metric collector that is easy to query programmatically, and eventually hook up to statsd, zmq, etc.

Includes 400, 404, 405, and 500 responders.

http://tools.ietf.org/html/rfc6570

• {/list*} => /red/green/blue
• Path Segment Expansion: {/var}
• Mandatory query params (when literals are specified, will also need query continuation support)
• Max length? Maybe not, because would mean 404 if exceeded unless rearchitect how route matching works. Have to match and then throw a different exception if too long.
• Etc.

Depends on issue #114

• Layout
• Content
• Logo
• Background
• Publish on CDN

I like how in Flask you can control the trailing slash:
http://flask.pocoo.org/mailinglist/archive/2011/2/27/re-automatic-removal-of-trailing-slashes/#043b1a0b6e841ab8e7d38bd7374cbb58

Something like this in Falcon would be useful.

/myapp/somewhere/
/myapp/somewhere

• sometimes I'd want these to get handled by the same mapped resource regardless of the trailing slash being present or not.

Export metrics periodically via statsd if py-statsd is available.

Something really fast for caching stuff like auth tokens. Uses ZMQ to replicate to all processes and keep lookups in-process.

Must support the Vary header.

Have a repo and a built-in tool or something to pull it down easily to bootstrap new projects.

As an API developer, I can consolidate all app messages in a single log file so that I don't loose the context of the messages.

It would be cool if wsgi.errors could still (optionally) be written to in tandem.

Would remove the need to lookup self._routes, callable may be faster?

Need to figure out whether an auto-serializer is needed/necessary/should be encouraged for data APIs? If so, look into implementing as a before/after hook.

Also, benchmark WSME to see if it a viable alternative. Con: json-patch support may be wonky?

Support plugins that can drop functions and classes into the falcon module namespace.

Ideas:

• Async middleware
• Async pipe file to/from disk
• ZMQ, statsd channels for metrics collector
• ?

Create sphinx docs or something and publish to Read the Docs.

Can hide problems, encourage bad coding practices.

Add optional support for executing ingress hooks in parallel using greenlets, asyncio, and/or Twisted. Processing should not continue until all parallel hooks return success (need to be able to specify conditions on the ctx that must all be true before proceeding to the next group). If any hook fails/bails out, the remaining hooks and the main app do not execute, and any parallel hooks that are still running are killed.

Find the biggest bottlenecks and optimize them.

http://packages.python.org/line_profiler/