Type FormDict

object --+    
         |    
      dict --+
             |
            FormDict

Translate a cgi.FieldStorage into a (possibly recursive) dict.

If you've used cgi.FieldStorage from the Python standard library, you've probably translated it into a dict, which has a more friendly API. Then, at some point (either before or after you wrote the translation), you probably realized why cgi.FieldStorage is the way it is--because the same field can have multiple values.

This code works around this requirement in a more friendly way that is inspired by PHP. Specifically:

• A field named foo cannot have multiple values. If multiple values are encountered, a aquarium.util.InternalLibrary.FormValueError is raised (in the constructor).
• If you actually wish for foo to have multiple values, name the HTML fields foo[]. The key foo within this dict will automatically have a list for its value.
• If your form had the elements field[1][1]=="bob" and field[1][2]=="junk" the resultant dict would be what you expect: {'field': {'1': {'1': 'bob'}, {'2': 'junk'}}.
• Something of the form field[][0] is unsupported.

XXX Below here doesn't actually work and is more of a TODO:

• If you name an HTML field something like foo[bar], then the key foo within this dict will automatically have a dict (actually a FormDict) containing the key bar for its value.
• You can perform the above recursively. I.e. the following is valid: foo[bar][][bat].
• In the same way that a simple field like foo cannot have multiple values without raising a FormValueError, if you mix field types, such as naming one field foo[] and another foo[bar], you'll get a FormValueError. It is expected that you should only get this error if:
  1. you as the programmer mess up.
  2. the user is maliciously adding fields to your perfect form. Hence, an exception is indeed appropriate.

The following attributes are used:

fieldStorage

This is the original cgi.FieldStorage object, just in case you actually need it. I won't even use it outside of the constructor.