Mercurial > p > roundup > code
view roundup/cgi/TAL/README.txt @ 5710:0b79bfcb3312
Add support for making an idempotent POST. This allows retrying a POST
that was interrupted. It involves creating a post once only (poe) url
/rest/data/<class>/@poe/<random_token>. This url acts the same as a
post to /rest/data/<class>. However once the @poe url is used, it
can't be used for a second POST.
To make these changes:
1) Take the body of post_collection into a new post_collection_inner
function. Have post_collection call post_collection_inner.
2) Add a handler for POST to rest/data/class/@poe. This will return a
unique POE url. By default the url expires after 30 minutes. The
POE random token is only good for a specific user and is stored in
the session db.
3) Add a handler for POST to rest/data/<class>/@poe/<random token>.
The random token generated in 2 is validated for proper class (if
token is not generic) and proper user and must not have expired.
If everything is valid, call post_collection_inner to process the
input and generate the new entry.
To make recognition of 2 stable (so it's not confused with
rest/data/<:class_name>/<:item_id>), removed @ from
Routing::url_to_regex.
The current Routing.execute method stops on the first regular
expression to match the URL. Since item_id doesn't accept a POST, I
was getting 405 bad method sometimes. My guess is the order of the
regular expressions is not stable, so sometime I would get the right
regexp for /data/<class>/@poe and sometime I would get the one for
/data/<class>/<item_id>. By removing the @ from the url_to_regexp,
there was no way for the item_id case to match @poe.
There are alternate fixes we may need to look at. If a regexp matches
but the method does not, return to the regexp matching loop in
execute() looking for another match. Only once every possible match
has failed should the code return a 405 method failure.
Another fix is to implement a more sophisticated mechanism so that
@Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'PATCH')
has different regexps for matching <:class_name> <:item_id> and
<:attr_name>. Currently the regexp specified by url_to_regex is used
for every component.
Other fixes:
Made failure to find any props in props_from_args return an empty
dict rather than throwing an unhandled error.
Make __init__ for SimulateFieldStorageFromJson handle an empty json
doc. Useful for POSTing to rest/data/class/@poe with an empty
document.
Testing:
added testPostPOE to test/rest_common.py that I think covers
all the code that was added.
Documentation:
Add doc to rest.txt in the "Client API" section titled: Safely
Re-sending POST". Move existing section "Adding new rest endpoints" in
"Client API" to a new second level section called "Programming the
REST API". Also a minor change to the simple rest client moving the
header setting to continuation lines rather than showing one long
line.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 Apr 2019 21:07:11 -0400 |
| parents | b9988e118055 |
| children |
line wrap: on
line source
TAL - Template Attribute Language --------------------------------- This is an implementation of TAL, the Zope Template Attribute Language. For TAL, see the Zope Presentation Templates ZWiki: http://dev.zope.org/Wikis/DevSite/Projects/ZPT/FrontPage It is not a Zope product nor is it designed exclusively to run inside of Zope, but if you have a Zope checkout that includes Products/ParsedXML, its Expat parser will be used. Prerequisites ------------- You need: - A recent checkout of Zope2; don't forget to run the wo_pcgi.py script to compile everything. (See above -- this is now optional.) - A recent checkout of the Zope2 product ParsedXML, accessible throught <Zope2>/lib/python/Products/ParsedXML; don't forget to run the setup.py script to compiles Expat. (Again, optional.) - Python 1.5.2; the driver script refuses to work with other versions unless you specify the -n option; this is done so that I don't accidentally use Python 2.x features. - Create a .path file containing proper module search path; it should point the <Zope2>/lib/python directory that you want to use. How To Play ----------- (Don't forget to edit .path, see above!) The script driver.py takes an XML file with TAL markup as argument and writes the expanded version to standard output. The filename argument defaults to tests/input/test01.xml. Regression test --------------- There are unit test suites in the 'tests' subdirectory; these can be run with tests/run.py. This should print the testcase names plus progress info, followed by a final line saying "OK". It requires that ../unittest.py exists. There are a number of test files in the 'tests' subdirectory, named tests/input/test<number>.xml and tests/input/test<number>.html. The Python script ./runtest.py calls driver.main() for each test file, and should print "<file> OK" for each one. These tests are also run as part of the unit test suites, so tests/run.py is all you need. What's Here ----------- DummyEngine.py simple-minded TALES execution engine TALInterpreter.py class to interpret intermediate code TALGenerator.py class to generate intermediate code XMLParser.py base class to parse XML, avoiding DOM TALParser.py class to parse XML with TAL into intermediate code HTMLTALParser.py class to parse HTML with TAL into intermediate code HTMLParser.py HTML-parsing base class driver.py script to demonstrate TAL expansion timer.py script to time various processing phases setpath.py hack to set sys.path and import ZODB __init__.py empty file that makes this directory a package runtest.py Python script to run file-comparison tests ndiff.py helper for runtest.py to produce diffs tests/ drectory with test files and output tests/run.py Python script to run all tests Author and License ------------------ This code is written by Guido van Rossum (project lead), Fred Drake, and Tim Peters. It is owned by Digital Creations and can be redistributed under the Zope Public License. TO DO ----- (See also http://www.zope.org/Members/jim/ZPTIssueTracker .) - Need to remove leading whitespace and newline when omitting an element (either through tal:replace with a value of nothing or tal:condition with a false condition). - Empty TAL/METAL attributes are ignored: tal:replace="" is ignored rather than causing an error. - HTMLTALParser.py and TALParser.py are silly names. Should be HTMLTALCompiler.py and XMLTALCompiler.py (or maybe shortened, without "TAL"?) - Should we preserve case of tags and attribute names in HTML?