├── .gitignore ├── .travis.yml ├── COPYING ├── MANIFEST.in ├── README ├── README.rst ├── setup.cfg ├── setup.py ├── static.py ├── testdata ├── priv │ └── foo.txt └── pub │ ├── encoding.html.genshi │ ├── favicon.ico │ ├── gzipped.html.gz │ ├── index.html │ ├── kid.html.kid │ ├── sub.html.stp │ ├── test.html.genshi │ ├── test.xml │ └── unicode.html ├── tests ├── __init__.py └── test_app.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.egg 3 | /build 4 | /dist 5 | .tox 6 | .coverage 7 | *.egg-info 8 | *~ 9 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: python 3 | install: pip install tox 4 | env: 5 | - TOXENV=py26 6 | - TOXENV=py27 7 | - TOXENV=py33 8 | - TOXENV=py34 9 | - TOXENV=pypy 10 | script: tox 11 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 489 | 490 | Also add information on how to contact you by electronic and paper mail. 491 | 492 | You should also get your employer (if you work as a programmer) or your 493 | school, if any, to sign a "copyright disclaimer" for the library, if 494 | necessary. Here is a sample; alter the names: 495 | 496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker. 498 | 499 | , 1 April 1990 500 | Ty Coon, President of Vice 501 | 502 | That's all there is to it! 503 | 504 | 505 | 506 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | recursive-include testdata *.txt *.html *.xml *.kid *.genshi *.stp *.ico 2 | include COPYING 3 | include README.rst 4 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | = static = 2 | 3 | A really simple WSGI way to serve static (or mixed) content. 4 | 5 | See docstrings of static module for details. 6 | 7 | == License == 8 | 9 | Created and maintained by Luke Arno 10 | 11 | Copyright (C) 2006-2009 Luke Arno - http://lukearno.com/ 12 | 13 | This library is free software; you can redistribute it and/or 14 | modify it under the terms of the GNU Lesser General Public 15 | License as published by the Free Software Foundation; either 16 | version 2.1 of the License, or (at your option) any later version. 17 | 18 | This library is distributed in the hope that it will be useful, 19 | but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21 | Lesser General Public License for more details. 22 | 23 | You should have received a copy of the GNU Lesser General Public 24 | License along with this library; if not, write to: 25 | 26 | The Free Software Foundation, Inc., 27 | 51 Franklin Street, Fifth Floor, 28 | Boston, MA 02110-1301, USA. 29 | 30 | Luke Arno can be found at http://lukearno.com/ 31 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. -*- mode: rst; coding: utf-8 -*- 2 | 3 | static3 - A really simple WSGI way to serve static (or mixed) content. 4 | ==================================================================================== 5 | 6 | .. image:: https://travis-ci.org/rmohr/static3.svg?branch=master 7 | :target: https://travis-ci.org/rmohr/static3 8 | 9 | .. contents:: Table of Contents 10 | :backlinks: top 11 | 12 | This software is a Python3 compatible fork of Luke Arnos library static_. 13 | 14 | The library is now Python3 compatible and Genshi_ support (the sucessor of 15 | kid_) is added. On Python2 Genshi and/or kid can be used as template engine. On 16 | Python3 only Genshi is available. 17 | 18 | This library provides an easy way to include static content 19 | in your WSGI applications. There is a convenience method for serving 20 | files located via pkg_resources. There are also facilities for serving 21 | mixed (static and dynamic) content using "magic" file handlers. 22 | Python builtin string substitution, kid and Genshi template support are provided 23 | and it is easy to roll your own handlers. Note that this distribution 24 | does not require kid or Genshi unless you want to use that type of template. Also 25 | provides a command of the same name as a convenience when you just want 26 | to share a little content over HTTP, ad hoc. 27 | 28 | Installation and Usage 29 | ---------------------- 30 | 31 | Latest release via PIP:: 32 | 33 | pip install static3 34 | 35 | Installation via GitHub:: 36 | 37 | git clone https://github.com/rmohr/static3.git 38 | cd static3 39 | pip install . 40 | 41 | Cling 42 | ^^^^^ 43 | 44 | `Cling` serves static content only. Just give it the base directory with your 45 | files you want to make accessible. You get a full WSGI app with an example as 46 | simple as that:: 47 | 48 | from static import Cling 49 | from wsgiref.simple_server import make_server 50 | my_app = Cling("/my/directory") 51 | make_server("localhost", 9999, my_app).serve_forever() 52 | 53 | Now you can access everything in the given directory via http://localhost:9999.D 54 | 55 | Serving compressed files 56 | ^^^^^^^^^^^^^^^^^^^^^^^^ 57 | 58 | If a gzip compressed file with the ´gz´ postfix is present, it is served, along with the corresponding headers. 59 | So if the file 'index.html' and the file 'index.html.gz' are present, the file 'index.html.gz' is served, if the the client indicated that it supports gzipped content. 60 | 61 | Additionally, you can configure arbitrary headers. You can match files by mime 62 | type, file extension, or prefix. For example, the following would add 63 | Cache-Control headers to paths with a css mime type for 10s, no-cache for all 64 | paths ending in .js for 100s, and add CORS header to all paths under the /imgs/ 65 | dir:: 66 | 67 | headers = [ 68 | {'type': 'text/css', 'Cache-Control': 'max-age=10'}, 69 | {'ext': '.js', 'Cache-Control': 'no-cache'}, 70 | {'prefix': '/imgs/', 'Access-Control-Allow-Origin': '*'}, 71 | ] 72 | Cling("/my/directory", headers=headers) 73 | 74 | 75 | Shock 76 | ^^^^^ 77 | 78 | `Shock` has the same basic functionality like `Cling` but with Shock we can 79 | also have some templating fun. Shock comes with three templating backends. 80 | String substitution, kid and Genshi. The decision which backend to use is done 81 | by examining the extension of the file to serve. The file extensions are 'stp', 82 | 'kid' and 'genshi'. So if you want to provide a file called 'index.html' via 83 | the kid backend, name your file 'index.html.kid'. A short example might look 84 | like this:: 85 | 86 | from static import Shock, KidMagic 87 | from wsgiref.simple_server import make_server 88 | my_app = Shock("/my/directory", magics=[KidMagic(title="Hello World")]) 89 | make_server("localhost", 9999, my_app).serve_forever() 90 | 91 | And the example 'index.html.kid':: 92 | 93 | 96 | 97 | 98 | 99 |

$title

100 | 101 | 102 | 103 | A similar template 'index.html.genshi' for Genshi:: 104 | 105 | 108 | 109 | 110 | 111 |

$title

112 | 113 | 114 | 115 | This simple application will replace the placeholder `title` with 'Hello World' 116 | in every provided file which ends in '.kid'. 117 | In this example it already is already obvious, that although different template 118 | engines can be used, they can only be used in a very `static` way. Never the 119 | less `Shock` is perfectly suitable for simple semi-static things like make the 120 | URL to your companies logo, or the company name variable. 121 | 122 | Unicode Support 123 | ^^^^^^^^^^^^^^^ 124 | 125 | When using a template system in Python3 it might be necessary to explicitly 126 | set an encoding for the sites provided. This can be done via the 127 | `encoding` attribute of `Shock`:: 128 | 129 | from static import Shock 130 | shock = Shock("/var/www/pub") 131 | shock.encoding="latin-1" 132 | 133 | When using `Cling` or `Shock` to serve static content the 134 | encoding need not to be set, as the content is just streamed through. 135 | If you have templates encoded in different formats, an instance of 136 | `Shock` needs to be instantiated for every codec used. 137 | 138 | .. _static: https://pypi.python.org/pypi/static 139 | .. _kid: https://pypi.python.org/pypi/kid 140 | .. _Genshi: https://pypi.python.org/pypi/Genshi 141 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [egg_info] 2 | tag_build = 3 | tag_date = 0 4 | tag_svn_revision = 0 5 | 6 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright (C) 2013 Roman Mohr 3 | """ 4 | 5 | """setup - setuptools based setup for static 6 | 7 | Copyright (C) 2006-2009 Luke Arno - http://lukearno.com/ 8 | 9 | This library is free software; you can redistribute it and/or 10 | modify it under the terms of the GNU Lesser General Public 11 | License as published by the Free Software Foundation; either 12 | version 2.1 of the License, or (at your option) any later version. 13 | 14 | This library is distributed in the hope that it will be useful, 15 | but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 | Lesser General Public License for more details. 18 | 19 | You should have received a copy of the GNU Lesser General Public 20 | License along with this library; if not, write to: 21 | 22 | The Free Software Foundation, Inc., 23 | 51 Franklin Street, Fifth Floor, 24 | Boston, MA 02110-1301, USA. 25 | 26 | Luke Arno can be found at http://lukearno.com/ 27 | 28 | """ 29 | 30 | from setuptools import setup 31 | from setuptools.command.test import test as TestCommand 32 | import sys 33 | 34 | 35 | class PyTest(TestCommand): 36 | 37 | def finalize_options(self): 38 | TestCommand.finalize_options(self) 39 | self.test_args = ['--cov', 'static', 'tests'] 40 | self.test_suite = True 41 | 42 | def run_tests(self): 43 | # import here, cause outside the eggs aren't loaded 44 | import pytest 45 | errno = pytest.main(self.test_args) 46 | sys.exit(errno) 47 | 48 | 49 | setup(name='static3', 50 | version='0.7.0', 51 | description= 52 | 'A really simple WSGI way to serve static (or mixed) content.', 53 | long_description=open('README.rst', 'rb').read().decode('utf-8'), 54 | author='Roman Mohr', 55 | author_email='roman@fenkhuber.at', 56 | url='https://github.com/rmohr/static3', 57 | license="LGPL", 58 | py_modules=['static'], 59 | packages=[], 60 | cmdclass={'test': PyTest}, 61 | tests_require=['pytest', 'webtest', 'pytest-cov'], 62 | extras_require={ 63 | 'KidMagic': 'kid', 64 | 'GenshiMagic': 'Genshi', 65 | }, 66 | entry_points=""" 67 | [console_scripts] 68 | static=static:command 69 | """, 70 | keywords="wsgi web http static content webapps", 71 | classifiers=['Development Status :: 4 - Beta', 72 | 'Environment :: Web Environment', 73 | 'Intended Audience :: Developers', 74 | 'License :: OSI Approved :: GNU Library or ' 75 | 'Lesser General Public License (LGPL)', 76 | 'Natural Language :: English', 77 | 'Operating System :: OS Independent', 78 | 'Programming Language :: Python', 79 | 'Topic :: Software Development :: Libraries', 80 | 'Topic :: Utilities']) 81 | -------------------------------------------------------------------------------- /static.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | Copyright (C) 2012 Roman Mohr 4 | """ 5 | 6 | """static - A stupidly simple WSGI way to serve static (or mixed) content. 7 | 8 | (See the docstrings of the various functions and classes.) 9 | 10 | Copyright (C) 2006-2009 Luke Arno - http://lukearno.com/ 11 | 12 | This library is free software; you can redistribute it and/or 13 | modify it under the terms of the GNU Lesser General Public 14 | License as published by the Free Software Foundation; either 15 | version 2.1 of the License, or (at your option) any later version. 16 | 17 | This library is distributed in the hope that it will be useful, 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 | Lesser General Public License for more details. 21 | 22 | You should have received a copy of the GNU Lesser General Public 23 | License along with this library; if not, write to: 24 | 25 | The Free Software Foundation, Inc., 26 | 51 Franklin Street, Fifth Floor, 27 | Boston, MA 02110-1301, USA. 28 | 29 | Luke Arno can be found at http://lukearno.com/ 30 | 31 | """ 32 | 33 | import mimetypes 34 | import email.utils as rfc822 35 | import time 36 | import string 37 | import sys 38 | from os import path, stat 39 | from wsgiref import util 40 | from wsgiref.headers import Headers 41 | from wsgiref.simple_server import make_server 42 | from optparse import OptionParser 43 | 44 | try: 45 | from pkg_resources import resource_filename, Requirement 46 | except: 47 | pass 48 | 49 | try: 50 | import kid 51 | except: 52 | pass 53 | 54 | try: 55 | from genshi.template import MarkupTemplate 56 | except: 57 | pass 58 | 59 | if sys.version < '3': 60 | import codecs 61 | 62 | def u(x): 63 | return codecs.unicode_escape_decode(x)[0] 64 | else: 65 | def u(x): 66 | return x 67 | 68 | 69 | class MagicError(Exception): 70 | pass 71 | 72 | 73 | def _encode(string, encoding): 74 | if sys.version_info[0] > 2: 75 | return string.encode(encoding=encoding, errors='strict') 76 | else: 77 | if type(u('')) == type(string): 78 | string = string.encode(encoding) 79 | return string 80 | 81 | 82 | def _decode(string, encoding): 83 | if sys.version_info[0] > 2: 84 | return string.decode(encoding=encoding, errors='strict') 85 | else: 86 | return string 87 | 88 | 89 | def _open(filename, encoding): 90 | if sys.version_info[0] > 2: 91 | return open(filename, 'r', encoding=encoding, errors='strict') 92 | else: 93 | return open(filename, 'rb') 94 | 95 | 96 | class StatusApp: 97 | 98 | """Used by WSGI apps to return some HTTP status.""" 99 | 100 | def __init__(self, status, message=None, encoding=sys.getdefaultencoding()): 101 | self.status = status 102 | self.encoding = encoding 103 | if message is None: 104 | self.message = status 105 | else: 106 | self.message = message 107 | 108 | def __call__(self, environ, start_response, headers=[]): 109 | if self.message: 110 | Headers(headers).add_header('Content-type', 'text/plain') 111 | start_response(self.status, headers) 112 | if environ['REQUEST_METHOD'] == 'HEAD': 113 | return [_encode("", self.encoding)] 114 | else: 115 | return [_encode(self.message, self.encoding)] 116 | 117 | 118 | class Cling(object): 119 | 120 | """A stupidly simple way to serve static content via WSGI. 121 | 122 | Serve the file of the same path as PATH_INFO in self.datadir. 123 | 124 | Look up the Content-type in self.content_types by extension 125 | or use 'text/plain' if the extension is not found. 126 | 127 | Serve up the contents of the file or delegate to self.not_found. 128 | """ 129 | 130 | block_size = 16 * 4096 131 | index_file = 'index.html' 132 | not_found = StatusApp('404 Not Found') 133 | not_modified = StatusApp('304 Not Modified', "") 134 | moved_permanently = StatusApp('301 Moved Permanently') 135 | method_not_allowed = StatusApp('405 Method Not Allowed') 136 | 137 | def __init__(self, root, **kw): 138 | """Just set the root and any other attribs passes via **kw.""" 139 | self.root = root 140 | self.encoding = sys.getdefaultencoding() 141 | 142 | for k, v in kw.items(): 143 | setattr(self, k, v) 144 | 145 | def __call__(self, environ, start_response): 146 | """Respond to a request when called in the usual WSGI way.""" 147 | if environ['REQUEST_METHOD'] not in ('GET', 'HEAD'): 148 | headers = [('Allow', 'GET, HEAD')] 149 | return self.method_not_allowed(environ, start_response, headers) 150 | path_info = environ.get('PATH_INFO', '') 151 | full_path = self._full_path(path_info) 152 | if not self._is_under_root(full_path): 153 | return self.not_found(environ, start_response) 154 | if path.isdir(full_path): 155 | if full_path[-1] != '/' or full_path == self.root: 156 | location = util.request_uri(environ, include_query=False) + '/' 157 | if environ.get('QUERY_STRING'): 158 | location += '?' + environ.get('QUERY_STRING') 159 | headers = [('Location', location)] 160 | return self.moved_permanently(environ, start_response, headers) 161 | else: 162 | full_path = self._full_path(path_info + self.index_file) 163 | prezipped = ('gzip' in environ.get('HTTP_ACCEPT_ENCODING', []) 164 | and path.exists(full_path + '.gz')) 165 | if prezipped: 166 | full_path += '.gz' 167 | content_type = self._guess_type(full_path) 168 | try: 169 | etag, last_modified = self._conditions(full_path, environ) 170 | headers = [('Date', rfc822.formatdate(time.time())), 171 | ('Last-Modified', last_modified), 172 | ('ETag', etag)] 173 | if_modified = environ.get('HTTP_IF_MODIFIED_SINCE') 174 | if if_modified and (rfc822.parsedate(if_modified) 175 | >= rfc822.parsedate(last_modified)): 176 | return self.not_modified(environ, start_response, headers) 177 | if_none = environ.get('HTTP_IF_NONE_MATCH') 178 | if if_none and (if_none == '*' or etag in if_none): 179 | return self.not_modified(environ, start_response, headers) 180 | file_like = self._file_like(full_path) 181 | headers.append(('Content-Type', content_type)) 182 | if prezipped: 183 | headers.extend([('Content-Encoding', 'gzip'), 184 | ('Vary', 'Accept-Encoding')]) 185 | self._add_headers(headers, path_info, content_type) 186 | start_response("200 OK", headers) 187 | if environ['REQUEST_METHOD'] == 'GET': 188 | return self._body(full_path, environ, file_like) 189 | 190 | else: 191 | return [b''] 192 | except (IOError, OSError) as e: 193 | print(e) 194 | return self.not_found(environ, start_response) 195 | 196 | def _full_path(self, path_info): 197 | """Return the full path from which to read.""" 198 | return self.root + path_info 199 | 200 | def _is_under_root(self, full_path): 201 | """Guard against arbitrary file retrieval.""" 202 | if (path.abspath(full_path) + path.sep)\ 203 | .startswith(path.abspath(self.root) + path.sep): 204 | return True 205 | else: 206 | return False 207 | 208 | def _guess_type(self, full_path): 209 | """Guess the mime type using the mimetypes module.""" 210 | return mimetypes.guess_type(full_path)[0] or 'text/plain' 211 | 212 | def _conditions(self, full_path, environ): 213 | """Return a tuple of etag, last_modified by mtime from stat.""" 214 | mtime = stat(full_path).st_mtime 215 | return str(mtime), rfc822.formatdate(mtime) 216 | 217 | def _add_headers(self, headers, path, content_type): 218 | DEFAULT = '__static_no_match__' 219 | CONFIG_ITEMS = ['prefix', 'type', 'ext'] 220 | for config in getattr(self, 'headers', []): 221 | if path.startswith(config.get('prefix', DEFAULT)) or \ 222 | content_type == config.get('type', DEFAULT) or \ 223 | path.endswith(config.get('ext', DEFAULT)): 224 | 225 | for key, value in config.items(): 226 | if key not in CONFIG_ITEMS: 227 | headers.append((key, value)) 228 | 229 | def _file_like(self, full_path): 230 | """Return the appropriate file object.""" 231 | return open(full_path, 'rb') 232 | 233 | def _body(self, full_path, environ, file_like): 234 | """Return an iterator over the body of the response.""" 235 | way_to_send = environ.get('wsgi.file_wrapper', iter_and_close) 236 | return way_to_send(file_like, self.block_size) 237 | 238 | 239 | def iter_and_close(file_like, block_size): 240 | """Yield file contents by block then close the file.""" 241 | while 1: 242 | try: 243 | block = file_like.read(block_size) 244 | if block: 245 | yield block 246 | else: 247 | raise StopIteration 248 | except StopIteration: 249 | file_like.close() 250 | return 251 | 252 | 253 | def cling_wrap(package_name, dir_name, **kw): 254 | """Return a Cling that serves from the given package and dir_name. 255 | 256 | This uses pkg_resources.resource_filename which is not the 257 | recommended way, since it extracts the files. 258 | 259 | I think this works fine unless you have some _very_ serious 260 | requirements for static content, in which case you probably 261 | shouldn't be serving it through a WSGI app, IMHO. YMMV. 262 | """ 263 | resource = Requirement.parse(package_name) 264 | return Cling(resource_filename(resource, dir_name), **kw) 265 | 266 | 267 | class Shock(Cling): 268 | 269 | """A stupidly simple way to serve up mixed content. 270 | 271 | Serves static content just like Cling (it's superclass) 272 | except that it process content with the first matching 273 | magic from self.magics if any apply. 274 | 275 | See Cling and classes with "Magic" in their names in this module. 276 | 277 | If you are using Shock with the StringMagic class for instance: 278 | 279 | shock = Shock('/data', magics=[StringMagic(food='cheese')]) 280 | 281 | Let's say you have a file called /data/foo.txt.stp containing one line: 282 | 283 | "I love to eat $food!" 284 | 285 | When you do a GET on /foo.txt you will see this in your browser: 286 | 287 | "I love to eat cheese!" 288 | 289 | This is really nice if you have a color variable in your css files or 290 | something trivial like that. It seems silly to create or change a 291 | handful of objects for a couple of dynamic bits of text. 292 | """ 293 | 294 | magics = () 295 | 296 | def _match_magic(self, full_path): 297 | """Return the first magic that matches this path or None.""" 298 | for magic in self.magics: 299 | if magic.matches(full_path): 300 | return magic 301 | 302 | def _full_path(self, path_info): 303 | """Return the full path from which to read.""" 304 | full_path = self.root + path_info 305 | if path.exists(full_path): 306 | return full_path 307 | else: 308 | for magic in self.magics: 309 | if path.exists(magic.new_path(full_path)): 310 | return magic.new_path(full_path) 311 | else: 312 | return full_path 313 | 314 | def _guess_type(self, full_path): 315 | """Guess the mime type magically or using the mimetypes module.""" 316 | magic = self._match_magic(full_path) 317 | if magic is not None: 318 | return (mimetypes.guess_type(magic.old_path(full_path))[0] 319 | or 'text/plain') 320 | else: 321 | return mimetypes.guess_type(full_path)[0] or 'text/plain' 322 | 323 | def _conditions(self, full_path, environ): 324 | """Return Etag and Last-Modified values defaults to now for both.""" 325 | magic = self._match_magic(full_path) 326 | if magic is not None: 327 | return magic.conditions(full_path, environ) 328 | else: 329 | mtime = stat(full_path).st_mtime 330 | return str(mtime), rfc822.formatdate(mtime) 331 | 332 | def _file_like(self, full_path): 333 | """Return the appropriate file object.""" 334 | magic = self._match_magic(full_path) 335 | if magic is not None: 336 | return magic.file_like(full_path, self.encoding) 337 | else: 338 | return open(full_path, 'rb') 339 | 340 | def _body(self, full_path, environ, file_like): 341 | """Return an iterator over the body of the response.""" 342 | magic = self._match_magic(full_path) 343 | if magic is not None: 344 | return [_encode(s, self.encoding) for s in magic.body(environ, 345 | file_like)] 346 | else: 347 | way_to_send = environ.get('wsgi.file_wrapper', iter_and_close) 348 | return way_to_send(file_like, self.block_size) 349 | 350 | 351 | class BaseMagic(object): 352 | 353 | """Base class for magic file handling. 354 | 355 | Really a do nothing if you were to use this directly. 356 | 357 | In a strait forward case you would just override .extension and body(). 358 | (See StringMagic in this module for a simple example of subclassing.) 359 | 360 | In a more complex case you may need to override many or all methods. 361 | """ 362 | 363 | extension = '' 364 | 365 | def exists(self, full_path): 366 | """Check that self.new_path(full_path) exists.""" 367 | if path.exists(self.new_path(full_path)): 368 | return self.new_path(full_path) 369 | 370 | def new_path(self, full_path): 371 | """Add the self.extension to the path.""" 372 | return full_path + self.extension 373 | 374 | def old_path(self, full_path): 375 | """Remove self.extension from path or raise MagicError.""" 376 | if self.matches(full_path): 377 | return full_path[:-len(self.extension)] 378 | else: 379 | raise MagicError("Path does not match this magic.") 380 | 381 | def matches(self, full_path): 382 | """Check that path ends with self.extension.""" 383 | if full_path.endswith(self.extension): 384 | return full_path 385 | 386 | def conditions(self, full_path, environ): 387 | """Return Etag and Last-Modified values (based on mtime).""" 388 | mtime = int(time.time()) 389 | return str(mtime), rfc822.formatdate(mtime) 390 | 391 | def file_like(self, full_path, encoding): 392 | """Return a file object for path.""" 393 | return _open(full_path, encoding) 394 | 395 | def body(self, environ, file_like): 396 | """Return an iterator over the body of the response.""" 397 | return [file_like.read()] 398 | 399 | 400 | class StringMagic(BaseMagic): 401 | 402 | """Magic to replace variables in file contents using string.Template. 403 | 404 | Using this requires Python2.4. 405 | """ 406 | 407 | extension = '.stp' 408 | safe = False 409 | 410 | def __init__(self, **variables): 411 | """Keyword arguments populate self.variables.""" 412 | self.variables = variables 413 | 414 | def body(self, environ, file_like): 415 | """Pass environ and self.variables in to template. 416 | 417 | self.variables overrides environ so that suprises in environ don't 418 | cause unexpected output if you are passing a value in explicitly. 419 | """ 420 | variables = environ.copy() 421 | variables.update(self.variables) 422 | template = string.Template(file_like.read()) 423 | if self.safe is True: 424 | return [template.safe_substitute(variables)] 425 | else: 426 | return [template.substitute(variables)] 427 | 428 | 429 | class KidMagic(StringMagic): 430 | 431 | """Like StringMagic only using the Kid templating language. 432 | 433 | Using this requires Kid: http://kid.lesscode.org/ 434 | """ 435 | 436 | extension = '.kid' 437 | 438 | def body(self, environ, full_path): 439 | """Pass environ and **self.variables into the template.""" 440 | template = kid.Template(file=full_path, 441 | environ=environ, 442 | **self.variables) 443 | return [template.serialize()] 444 | 445 | 446 | class GenshiMagic(StringMagic): 447 | 448 | """Like StringMagic only using the Genshi templating language. 449 | 450 | Using this requires Genshi 451 | """ 452 | 453 | extension = '.genshi' 454 | 455 | def body(self, environ, full_path): 456 | """Pass environ and **self.variables into the template.""" 457 | 458 | template = MarkupTemplate(full_path.read()) 459 | variables = self.variables.copy() 460 | variables["environ"] = environ 461 | return [template.generate(**variables) 462 | .render('html', doctype='html')] 463 | 464 | 465 | def command(): 466 | parser = OptionParser(usage="%prog DIR [HOST][:][PORT]", 467 | version="static 0.3.6") 468 | options, args = parser.parse_args() 469 | if len(args) in (1, 2): 470 | if len(args) == 2: 471 | parts = args[1].split(":") 472 | if len(parts) == 1: 473 | host = parts[0] 474 | port = None 475 | elif len(parts) == 2: 476 | host, port = parts 477 | else: 478 | sys.exit("Invalid host:port specification.") 479 | elif len(args) == 1: 480 | host, port = None, None 481 | if not host: 482 | host = '0.0.0.0' 483 | if not port: 484 | port = 9999 485 | try: 486 | port = int(port) 487 | except: 488 | sys.exit("Invalid host:port specification.") 489 | app = Cling(args[0]) 490 | try: 491 | make_server(host, port, app).serve_forever() 492 | except KeyboardInterrupt: 493 | print("Cio, baby!") 494 | except: 495 | sys.exit("Problem initializing server.") 496 | else: 497 | parser.print_help(sys.stderr) 498 | sys.exit(1) 499 | 500 | 501 | def test(): 502 | from wsgiref.validate import validator 503 | magics = (StringMagic(title="String Test"), 504 | KidMagic(title="Kid Test"), GenshiMagic(title="Genshi Test")) 505 | #app = Shock('testdata/pub', magics=magics) 506 | app = Cling('testdata/pub') 507 | try: 508 | make_server('localhost', 9999, validator(app)).serve_forever() 509 | except KeyboardInterrupt: 510 | print("Ciao, baby!") 511 | 512 | 513 | if __name__ == '__main__': 514 | test() 515 | -------------------------------------------------------------------------------- /testdata/priv/foo.txt: -------------------------------------------------------------------------------- 1 | This is private. You should not be able to reach it with a ../ path. 2 | -------------------------------------------------------------------------------- /testdata/pub/encoding.html.genshi: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | mixed content test 7 | 8 | 9 | äölö@ł¶ŋ¶€←ħŋ 10 | 11 | 12 | -------------------------------------------------------------------------------- /testdata/pub/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rmohr/static3/e5f88c5e91789bd4db7fde0cf59e4a15c3326f11/testdata/pub/favicon.ico -------------------------------------------------------------------------------- /testdata/pub/gzipped.html.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rmohr/static3/e5f88c5e91789bd4db7fde0cf59e4a15c3326f11/testdata/pub/gzipped.html.gz -------------------------------------------------------------------------------- /testdata/pub/index.html: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | mixed content test 7 | 8 | 9 |

Mixed Content Test

10 |

11 | This file should be served with 12 | a content type of 'text/html'. 13 |

14 |

15 | A 304 should be returned on subsequent requests, 16 | until you touch the file. 17 |

18 |

19 | A content type for 'text/xml' should be returned for 20 | this file. 21 |

22 |

23 | For a test of using Python builtin string substitution try 24 | this file. 25 |

26 |

27 | For a test of using Kid templates 28 | this file. 29 | (Requires Kid) 30 |

31 |

32 | For a test of using genshi templates 33 | this file. 34 |

35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /testdata/pub/kid.html.kid: -------------------------------------------------------------------------------- 1 | 2 | 4 | 7 | 8 | kid magic test 9 | 19 | 20 | 21 |

Title: $title

22 |

23 | If everything is working, the title above should be: "Kid Test" 24 | and below you should see a table of your WSGI environ. 25 | You should receive no 304s from this resource. 26 |

27 | 28 | 29 | 30 | 31 | 34 |
varables longer than 50 characters truncated
VariableValue
32 | 33 |
35 | 36 | 37 | -------------------------------------------------------------------------------- /testdata/pub/sub.html.stp: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | string substituted content test 7 | 8 | 9 |

$title

10 |

11 | If everything is working, the title above should be: "String Test" 12 | and below you should see that path info is '/sub.html'. 13 | You should receive no 304s from this resource. 14 |

15 |

16 | Path info: $PATH_INFO. 17 |

18 | 19 | 20 | -------------------------------------------------------------------------------- /testdata/pub/test.html.genshi: -------------------------------------------------------------------------------- 1 | 2 | 4 | 6 | 7 | genshi magic test 8 | 18 | 19 | 20 |

Title: $title

21 |

22 | If everything is working, the title above should be: "Genshi Test" 23 | and below you should see a table of your WSGI environ. 24 | You should receive no 304s from this resource. 25 |

26 | 27 | 28 | 29 | 30 | 33 |
varables longer than 50 characters truncated
VariableValue
31 | 32 |
34 | 35 | 36 | -------------------------------------------------------------------------------- /testdata/pub/test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /testdata/pub/unicode.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | öäü 6 | 7 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rmohr/static3/e5f88c5e91789bd4db7fde0cf59e4a15c3326f11/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_app.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013 Roman Mohr 3 | # 4 | # This file is part of static3. 5 | # 6 | # static3 is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # Foobar is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Foobar. If not, see . 18 | 19 | import pytest 20 | import webtest 21 | 22 | from static import u 23 | 24 | 25 | @pytest.fixture 26 | def _cling(): 27 | from static import Cling 28 | return Cling(root="testdata/pub") 29 | 30 | 31 | @pytest.fixture 32 | def _shock(): 33 | from static import Shock, StringMagic, KidMagic, GenshiMagic 34 | magics = (StringMagic(title="String Test"), 35 | KidMagic(title="Kid Test"), GenshiMagic(title="Genshi Test")) 36 | return Shock(root="testdata/pub", magics=magics) 37 | 38 | 39 | @pytest.fixture 40 | def ascii_shock(_shock): 41 | _shock.encoding = 'ascii' 42 | return webtest.TestApp(_shock) 43 | 44 | 45 | @pytest.fixture 46 | def cling(_cling): 47 | return webtest.TestApp(_cling) 48 | 49 | 50 | @pytest.fixture 51 | def shock(_shock): 52 | return webtest.TestApp(_shock) 53 | 54 | 55 | @pytest.mark.skipif("sys.version_info >= (3,0)") 56 | def test_kid(shock): 57 | response = shock.get("/kid.html.kid") 58 | assert "Title: Kid Test" in response 59 | assert "REQUEST_METHOD" in response 60 | 61 | 62 | def test_genshi(shock): 63 | response = shock.get("/test.html") 64 | assert "Title: Genshi Test" in response 65 | assert "REQUEST_METHOD" in response 66 | 67 | 68 | def test_string(shock): 69 | response = shock.get("/sub.html.stp") 70 | assert "

String Test

" in response 71 | assert "Path info: /sub.html." in response 72 | 73 | 74 | def test_static_cling(cling): 75 | response = cling.get("/index.html") 76 | assert "Mixed Content" in response 77 | assert response.content_type == "text/html" 78 | response = cling.get("/test.xml") 79 | assert "green" in response 80 | # dependes on the mimetypes version, both is fine 81 | assert (response.content_type == "text/xml" 82 | or response.content_type == "application/xml") 83 | response = cling.get("/unicode.html") 84 | assert u('\u00f6\u00e4\u00fc') in response 85 | 86 | 87 | def test_cling_head(cling): 88 | response = cling.head("/index.html") 89 | assert response.content_type == "text/html" 90 | assert response.body == b'' 91 | 92 | 93 | def test_shock_head(shock): 94 | response = shock.head("/index.html") 95 | assert response.content_type == "text/html" 96 | assert response.body == b'' 97 | 98 | 99 | def test_gzip_cling(cling): 100 | response = cling.get("/gzipped.html", headers=[('Accept-Encoding', 101 | 'gzip, deflate')]) 102 | assert "Mixed Content" in response 103 | assert response.content_type == "text/html" 104 | assert 'Content-Encoding' not in response.headers 105 | assert response.headers['Vary'] == 'Accept-Encoding' 106 | 107 | 108 | def test_headers_cling(): 109 | from static import Cling 110 | 111 | def get(headers, url='/index.html'): 112 | app = webtest.TestApp(Cling(root="testdata/pub", headers=headers)) 113 | return app.get(url) 114 | 115 | response = get([{'type': 'text/html', 'Cache-Control': 'max-age=10'}]) 116 | assert response.headers['Cache-Control'] == 'max-age=10' 117 | 118 | response = get( 119 | [{'type': 'text/html', 'Cache-Control': 'max-age=10'}], '/test.xml') 120 | assert 'Cache-Control' not in response.headers.keys() 121 | 122 | response = get([{'ext': 'html', 'Cache-Control': 'max-age=10'}]) 123 | assert response.headers['Cache-Control'] == 'max-age=10' 124 | 125 | response = get( 126 | [{'ext': 'html', 'Cache-Control': 'max-age=10'}], '/test.xml') 127 | assert 'Cache-Control' not in response.headers.keys() 128 | 129 | response = get([{'prefix': '/index', 'Cache-Control': 'max-age=10'}]) 130 | assert response.headers['Cache-Control'] == 'max-age=10' 131 | 132 | response = get( 133 | [{'prefix': '/index', 'Cache-Control': 'max-age=10'}], '/test.xml') 134 | assert 'Cache-Control' not in response.headers.keys() 135 | 136 | 137 | def test_static_shock(shock): 138 | response = shock.get("/index.html") 139 | assert "Mixed Content" in response 140 | 141 | 142 | @pytest.mark.skipif("sys.version_info >= (3,0)") 143 | def test_encoding(ascii_shock): 144 | with pytest.raises(UnicodeEncodeError): 145 | ascii_shock.get("/encoding.html") 146 | 147 | 148 | @pytest.mark.skipif("sys.version_info < (3,0)") 149 | def test_decoding(ascii_shock): 150 | with pytest.raises(UnicodeDecodeError): 151 | ascii_shock.get("/encoding.html") 152 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py26, py27, py33, py34, pypy 3 | 4 | [testenv] 5 | deps= 6 | distribute 7 | pytest 8 | genshi 9 | py{26,27},pypy: kid 10 | commands=python setup.py test [] 11 | sitepackages=False 12 | setenv= 13 | PIP_USE_MIRRORS=true 14 | 15 | [pytest] 16 | norecursedirs = bin eggs .git _build tmp* lib *.egg 17 | 18 | --------------------------------------------------------------------------------