pax_global_header00006660000000000000000000000064127143445130014516gustar00rootroot0000000000000052 comment=e5f88c5e91789bd4db7fde0cf59e4a15c3326f11 static3-0.7.0/000077500000000000000000000000001271434451300130745ustar00rootroot00000000000000static3-0.7.0/.gitignore000066400000000000000000000000661271434451300150660ustar00rootroot00000000000000*.pyc *.egg /build /dist .tox .coverage *.egg-info *~ static3-0.7.0/.travis.yml000066400000000000000000000002271271434451300152060ustar00rootroot00000000000000sudo: false language: python install: pip install tox env: - TOXENV=py26 - TOXENV=py27 - TOXENV=py33 - TOXENV=py34 - TOXENV=pypy script: tox static3-0.7.0/COPYING000066400000000000000000000635461271434451300141450ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! static3-0.7.0/MANIFEST.in000066400000000000000000000001551271434451300146330ustar00rootroot00000000000000recursive-include testdata *.txt *.html *.xml *.kid *.genshi *.stp *.ico include COPYING include README.rst static3-0.7.0/README000066400000000000000000000017611271434451300137610ustar00rootroot00000000000000= static = A really simple WSGI way to serve static (or mixed) content. See docstrings of static module for details. == License == Created and maintained by Luke Arno Copyright (C) 2006-2009 Luke Arno - http://lukearno.com/ This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to: The Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Luke Arno can be found at http://lukearno.com/ static3-0.7.0/README.rst000066400000000000000000000117661271434451300145760ustar00rootroot00000000000000.. -*- mode: rst; coding: utf-8 -*- static3 - A really simple WSGI way to serve static (or mixed) content. ==================================================================================== .. image:: https://travis-ci.org/rmohr/static3.svg?branch=master :target: https://travis-ci.org/rmohr/static3 .. contents:: Table of Contents :backlinks: top This software is a Python3 compatible fork of Luke Arnos library static_. The library is now Python3 compatible and Genshi_ support (the sucessor of kid_) is added. On Python2 Genshi and/or kid can be used as template engine. On Python3 only Genshi is available. This library provides an easy way to include static content in your WSGI applications. There is a convenience method for serving files located via pkg_resources. There are also facilities for serving mixed (static and dynamic) content using "magic" file handlers. Python builtin string substitution, kid and Genshi template support are provided and it is easy to roll your own handlers. Note that this distribution does not require kid or Genshi unless you want to use that type of template. Also provides a command of the same name as a convenience when you just want to share a little content over HTTP, ad hoc. Installation and Usage ---------------------- Latest release via PIP:: pip install static3 Installation via GitHub:: git clone https://github.com/rmohr/static3.git cd static3 pip install . Cling ^^^^^ `Cling` serves static content only. Just give it the base directory with your files you want to make accessible. You get a full WSGI app with an example as simple as that:: from static import Cling from wsgiref.simple_server import make_server my_app = Cling("/my/directory") make_server("localhost", 9999, my_app).serve_forever() Now you can access everything in the given directory via http://localhost:9999.D Serving compressed files ^^^^^^^^^^^^^^^^^^^^^^^^ If a gzip compressed file with the ´gz´ postfix is present, it is served, along with the corresponding headers. 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. Additionally, you can configure arbitrary headers. You can match files by mime type, file extension, or prefix. For example, the following would add Cache-Control headers to paths with a css mime type for 10s, no-cache for all paths ending in .js for 100s, and add CORS header to all paths under the /imgs/ dir:: headers = [ {'type': 'text/css', 'Cache-Control': 'max-age=10'}, {'ext': '.js', 'Cache-Control': 'no-cache'}, {'prefix': '/imgs/', 'Access-Control-Allow-Origin': '*'}, ] Cling("/my/directory", headers=headers) Shock ^^^^^ `Shock` has the same basic functionality like `Cling` but with Shock we can also have some templating fun. Shock comes with three templating backends. String substitution, kid and Genshi. The decision which backend to use is done by examining the extension of the file to serve. The file extensions are 'stp', 'kid' and 'genshi'. So if you want to provide a file called 'index.html' via the kid backend, name your file 'index.html.kid'. A short example might look like this:: from static import Shock, KidMagic from wsgiref.simple_server import make_server my_app = Shock("/my/directory", magics=[KidMagic(title="Hello World")]) make_server("localhost", 9999, my_app).serve_forever() And the example 'index.html.kid'::

$title

A similar template 'index.html.genshi' for Genshi::

$title

This simple application will replace the placeholder `title` with 'Hello World' in every provided file which ends in '.kid'. In this example it already is already obvious, that although different template engines can be used, they can only be used in a very `static` way. Never the less `Shock` is perfectly suitable for simple semi-static things like make the URL to your companies logo, or the company name variable. Unicode Support ^^^^^^^^^^^^^^^ When using a template system in Python3 it might be necessary to explicitly set an encoding for the sites provided. This can be done via the `encoding` attribute of `Shock`:: from static import Shock shock = Shock("/var/www/pub") shock.encoding="latin-1" When using `Cling` or `Shock` to serve static content the encoding need not to be set, as the content is just streamed through. If you have templates encoded in different formats, an instance of `Shock` needs to be instantiated for every codec used. .. _static: https://pypi.python.org/pypi/static .. _kid: https://pypi.python.org/pypi/kid .. _Genshi: https://pypi.python.org/pypi/Genshi static3-0.7.0/setup.cfg000066400000000000000000000000731271434451300147150ustar00rootroot00000000000000[egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 static3-0.7.0/setup.py000066400000000000000000000051541271434451300146130ustar00rootroot00000000000000""" Copyright (C) 2013 Roman Mohr """ """setup - setuptools based setup for static Copyright (C) 2006-2009 Luke Arno - http://lukearno.com/ This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to: The Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Luke Arno can be found at http://lukearno.com/ """ from setuptools import setup from setuptools.command.test import test as TestCommand import sys class PyTest(TestCommand): def finalize_options(self): TestCommand.finalize_options(self) self.test_args = ['--cov', 'static', 'tests'] self.test_suite = True def run_tests(self): # import here, cause outside the eggs aren't loaded import pytest errno = pytest.main(self.test_args) sys.exit(errno) setup(name='static3', version='0.7.0', description= 'A really simple WSGI way to serve static (or mixed) content.', long_description=open('README.rst', 'rb').read().decode('utf-8'), author='Roman Mohr', author_email='roman@fenkhuber.at', url='https://github.com/rmohr/static3', license="LGPL", py_modules=['static'], packages=[], cmdclass={'test': PyTest}, tests_require=['pytest', 'webtest', 'pytest-cov'], extras_require={ 'KidMagic': 'kid', 'GenshiMagic': 'Genshi', }, entry_points=""" [console_scripts] static=static:command """, keywords="wsgi web http static content webapps", classifiers=['Development Status :: 4 - Beta', 'Environment :: Web Environment', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU Library or ' 'Lesser General Public License (LGPL)', 'Natural Language :: English', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Topic :: Software Development :: Libraries', 'Topic :: Utilities']) static3-0.7.0/static.py000077500000000000000000000412201271434451300147370ustar00rootroot00000000000000#!/usr/bin/env python """ Copyright (C) 2012 Roman Mohr """ """static - A stupidly simple WSGI way to serve static (or mixed) content. (See the docstrings of the various functions and classes.) Copyright (C) 2006-2009 Luke Arno - http://lukearno.com/ This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to: The Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Luke Arno can be found at http://lukearno.com/ """ import mimetypes import email.utils as rfc822 import time import string import sys from os import path, stat from wsgiref import util from wsgiref.headers import Headers from wsgiref.simple_server import make_server from optparse import OptionParser try: from pkg_resources import resource_filename, Requirement except: pass try: import kid except: pass try: from genshi.template import MarkupTemplate except: pass if sys.version < '3': import codecs def u(x): return codecs.unicode_escape_decode(x)[0] else: def u(x): return x class MagicError(Exception): pass def _encode(string, encoding): if sys.version_info[0] > 2: return string.encode(encoding=encoding, errors='strict') else: if type(u('')) == type(string): string = string.encode(encoding) return string def _decode(string, encoding): if sys.version_info[0] > 2: return string.decode(encoding=encoding, errors='strict') else: return string def _open(filename, encoding): if sys.version_info[0] > 2: return open(filename, 'r', encoding=encoding, errors='strict') else: return open(filename, 'rb') class StatusApp: """Used by WSGI apps to return some HTTP status.""" def __init__(self, status, message=None, encoding=sys.getdefaultencoding()): self.status = status self.encoding = encoding if message is None: self.message = status else: self.message = message def __call__(self, environ, start_response, headers=[]): if self.message: Headers(headers).add_header('Content-type', 'text/plain') start_response(self.status, headers) if environ['REQUEST_METHOD'] == 'HEAD': return [_encode("", self.encoding)] else: return [_encode(self.message, self.encoding)] class Cling(object): """A stupidly simple way to serve static content via WSGI. Serve the file of the same path as PATH_INFO in self.datadir. Look up the Content-type in self.content_types by extension or use 'text/plain' if the extension is not found. Serve up the contents of the file or delegate to self.not_found. """ block_size = 16 * 4096 index_file = 'index.html' not_found = StatusApp('404 Not Found') not_modified = StatusApp('304 Not Modified', "") moved_permanently = StatusApp('301 Moved Permanently') method_not_allowed = StatusApp('405 Method Not Allowed') def __init__(self, root, **kw): """Just set the root and any other attribs passes via **kw.""" self.root = root self.encoding = sys.getdefaultencoding() for k, v in kw.items(): setattr(self, k, v) def __call__(self, environ, start_response): """Respond to a request when called in the usual WSGI way.""" if environ['REQUEST_METHOD'] not in ('GET', 'HEAD'): headers = [('Allow', 'GET, HEAD')] return self.method_not_allowed(environ, start_response, headers) path_info = environ.get('PATH_INFO', '') full_path = self._full_path(path_info) if not self._is_under_root(full_path): return self.not_found(environ, start_response) if path.isdir(full_path): if full_path[-1] != '/' or full_path == self.root: location = util.request_uri(environ, include_query=False) + '/' if environ.get('QUERY_STRING'): location += '?' + environ.get('QUERY_STRING') headers = [('Location', location)] return self.moved_permanently(environ, start_response, headers) else: full_path = self._full_path(path_info + self.index_file) prezipped = ('gzip' in environ.get('HTTP_ACCEPT_ENCODING', []) and path.exists(full_path + '.gz')) if prezipped: full_path += '.gz' content_type = self._guess_type(full_path) try: etag, last_modified = self._conditions(full_path, environ) headers = [('Date', rfc822.formatdate(time.time())), ('Last-Modified', last_modified), ('ETag', etag)] if_modified = environ.get('HTTP_IF_MODIFIED_SINCE') if if_modified and (rfc822.parsedate(if_modified) >= rfc822.parsedate(last_modified)): return self.not_modified(environ, start_response, headers) if_none = environ.get('HTTP_IF_NONE_MATCH') if if_none and (if_none == '*' or etag in if_none): return self.not_modified(environ, start_response, headers) file_like = self._file_like(full_path) headers.append(('Content-Type', content_type)) if prezipped: headers.extend([('Content-Encoding', 'gzip'), ('Vary', 'Accept-Encoding')]) self._add_headers(headers, path_info, content_type) start_response("200 OK", headers) if environ['REQUEST_METHOD'] == 'GET': return self._body(full_path, environ, file_like) else: return [b''] except (IOError, OSError) as e: print(e) return self.not_found(environ, start_response) def _full_path(self, path_info): """Return the full path from which to read.""" return self.root + path_info def _is_under_root(self, full_path): """Guard against arbitrary file retrieval.""" if (path.abspath(full_path) + path.sep)\ .startswith(path.abspath(self.root) + path.sep): return True else: return False def _guess_type(self, full_path): """Guess the mime type using the mimetypes module.""" return mimetypes.guess_type(full_path)[0] or 'text/plain' def _conditions(self, full_path, environ): """Return a tuple of etag, last_modified by mtime from stat.""" mtime = stat(full_path).st_mtime return str(mtime), rfc822.formatdate(mtime) def _add_headers(self, headers, path, content_type): DEFAULT = '__static_no_match__' CONFIG_ITEMS = ['prefix', 'type', 'ext'] for config in getattr(self, 'headers', []): if path.startswith(config.get('prefix', DEFAULT)) or \ content_type == config.get('type', DEFAULT) or \ path.endswith(config.get('ext', DEFAULT)): for key, value in config.items(): if key not in CONFIG_ITEMS: headers.append((key, value)) def _file_like(self, full_path): """Return the appropriate file object.""" return open(full_path, 'rb') def _body(self, full_path, environ, file_like): """Return an iterator over the body of the response.""" way_to_send = environ.get('wsgi.file_wrapper', iter_and_close) return way_to_send(file_like, self.block_size) def iter_and_close(file_like, block_size): """Yield file contents by block then close the file.""" while 1: try: block = file_like.read(block_size) if block: yield block else: raise StopIteration except StopIteration: file_like.close() return def cling_wrap(package_name, dir_name, **kw): """Return a Cling that serves from the given package and dir_name. This uses pkg_resources.resource_filename which is not the recommended way, since it extracts the files. I think this works fine unless you have some _very_ serious requirements for static content, in which case you probably shouldn't be serving it through a WSGI app, IMHO. YMMV. """ resource = Requirement.parse(package_name) return Cling(resource_filename(resource, dir_name), **kw) class Shock(Cling): """A stupidly simple way to serve up mixed content. Serves static content just like Cling (it's superclass) except that it process content with the first matching magic from self.magics if any apply. See Cling and classes with "Magic" in their names in this module. If you are using Shock with the StringMagic class for instance: shock = Shock('/data', magics=[StringMagic(food='cheese')]) Let's say you have a file called /data/foo.txt.stp containing one line: "I love to eat $food!" When you do a GET on /foo.txt you will see this in your browser: "I love to eat cheese!" This is really nice if you have a color variable in your css files or something trivial like that. It seems silly to create or change a handful of objects for a couple of dynamic bits of text. """ magics = () def _match_magic(self, full_path): """Return the first magic that matches this path or None.""" for magic in self.magics: if magic.matches(full_path): return magic def _full_path(self, path_info): """Return the full path from which to read.""" full_path = self.root + path_info if path.exists(full_path): return full_path else: for magic in self.magics: if path.exists(magic.new_path(full_path)): return magic.new_path(full_path) else: return full_path def _guess_type(self, full_path): """Guess the mime type magically or using the mimetypes module.""" magic = self._match_magic(full_path) if magic is not None: return (mimetypes.guess_type(magic.old_path(full_path))[0] or 'text/plain') else: return mimetypes.guess_type(full_path)[0] or 'text/plain' def _conditions(self, full_path, environ): """Return Etag and Last-Modified values defaults to now for both.""" magic = self._match_magic(full_path) if magic is not None: return magic.conditions(full_path, environ) else: mtime = stat(full_path).st_mtime return str(mtime), rfc822.formatdate(mtime) def _file_like(self, full_path): """Return the appropriate file object.""" magic = self._match_magic(full_path) if magic is not None: return magic.file_like(full_path, self.encoding) else: return open(full_path, 'rb') def _body(self, full_path, environ, file_like): """Return an iterator over the body of the response.""" magic = self._match_magic(full_path) if magic is not None: return [_encode(s, self.encoding) for s in magic.body(environ, file_like)] else: way_to_send = environ.get('wsgi.file_wrapper', iter_and_close) return way_to_send(file_like, self.block_size) class BaseMagic(object): """Base class for magic file handling. Really a do nothing if you were to use this directly. In a strait forward case you would just override .extension and body(). (See StringMagic in this module for a simple example of subclassing.) In a more complex case you may need to override many or all methods. """ extension = '' def exists(self, full_path): """Check that self.new_path(full_path) exists.""" if path.exists(self.new_path(full_path)): return self.new_path(full_path) def new_path(self, full_path): """Add the self.extension to the path.""" return full_path + self.extension def old_path(self, full_path): """Remove self.extension from path or raise MagicError.""" if self.matches(full_path): return full_path[:-len(self.extension)] else: raise MagicError("Path does not match this magic.") def matches(self, full_path): """Check that path ends with self.extension.""" if full_path.endswith(self.extension): return full_path def conditions(self, full_path, environ): """Return Etag and Last-Modified values (based on mtime).""" mtime = int(time.time()) return str(mtime), rfc822.formatdate(mtime) def file_like(self, full_path, encoding): """Return a file object for path.""" return _open(full_path, encoding) def body(self, environ, file_like): """Return an iterator over the body of the response.""" return [file_like.read()] class StringMagic(BaseMagic): """Magic to replace variables in file contents using string.Template. Using this requires Python2.4. """ extension = '.stp' safe = False def __init__(self, **variables): """Keyword arguments populate self.variables.""" self.variables = variables def body(self, environ, file_like): """Pass environ and self.variables in to template. self.variables overrides environ so that suprises in environ don't cause unexpected output if you are passing a value in explicitly. """ variables = environ.copy() variables.update(self.variables) template = string.Template(file_like.read()) if self.safe is True: return [template.safe_substitute(variables)] else: return [template.substitute(variables)] class KidMagic(StringMagic): """Like StringMagic only using the Kid templating language. Using this requires Kid: http://kid.lesscode.org/ """ extension = '.kid' def body(self, environ, full_path): """Pass environ and **self.variables into the template.""" template = kid.Template(file=full_path, environ=environ, **self.variables) return [template.serialize()] class GenshiMagic(StringMagic): """Like StringMagic only using the Genshi templating language. Using this requires Genshi """ extension = '.genshi' def body(self, environ, full_path): """Pass environ and **self.variables into the template.""" template = MarkupTemplate(full_path.read()) variables = self.variables.copy() variables["environ"] = environ return [template.generate(**variables) .render('html', doctype='html')] def command(): parser = OptionParser(usage="%prog DIR [HOST][:][PORT]", version="static 0.3.6") options, args = parser.parse_args() if len(args) in (1, 2): if len(args) == 2: parts = args[1].split(":") if len(parts) == 1: host = parts[0] port = None elif len(parts) == 2: host, port = parts else: sys.exit("Invalid host:port specification.") elif len(args) == 1: host, port = None, None if not host: host = '0.0.0.0' if not port: port = 9999 try: port = int(port) except: sys.exit("Invalid host:port specification.") app = Cling(args[0]) try: make_server(host, port, app).serve_forever() except KeyboardInterrupt: print("Cio, baby!") except: sys.exit("Problem initializing server.") else: parser.print_help(sys.stderr) sys.exit(1) def test(): from wsgiref.validate import validator magics = (StringMagic(title="String Test"), KidMagic(title="Kid Test"), GenshiMagic(title="Genshi Test")) #app = Shock('testdata/pub', magics=magics) app = Cling('testdata/pub') try: make_server('localhost', 9999, validator(app)).serve_forever() except KeyboardInterrupt: print("Ciao, baby!") if __name__ == '__main__': test() static3-0.7.0/testdata/000077500000000000000000000000001271434451300147055ustar00rootroot00000000000000static3-0.7.0/testdata/priv/000077500000000000000000000000001271434451300156655ustar00rootroot00000000000000static3-0.7.0/testdata/priv/foo.txt000066400000000000000000000001051271434451300172050ustar00rootroot00000000000000This is private. You should not be able to reach it with a ../ path. static3-0.7.0/testdata/pub/000077500000000000000000000000001271434451300154735ustar00rootroot00000000000000static3-0.7.0/testdata/pub/encoding.html.genshi000066400000000000000000000004501271434451300214220ustar00rootroot00000000000000 mixed content test äölö@ł¶ŋ¶€←ħŋ static3-0.7.0/testdata/pub/favicon.ico000066400000000000000000000113561271434451300176220ustar00rootroot00000000000000 6(00F( @wwwwwwwwwwwwwwwppppppppppppppppwwwwwwwwwwwwwwwppppppppppppwwwwwwwwwwwwwwwppppppppppppwwwwwwwwwwwwwwwp( wwwwwwwwppppwwwwwwwwppwwwwwwwwwwwwwwww(0` ʦ """)))UUUMMMBBB999|PP3f3333f333ff3fffff3f3f̙f3333f3333333333f3333333f3f33ff3f3f3f3333f3333333f3̙33333f333ff3ffffff3f33f3ff3f3f3ffff3fffffffff3fffffff3f̙ffff3ff333f3ff33fff33f3ff̙3f3f3333f333ff3fffff̙̙3̙f̙̙̙3f̙3f3f3333f333ff3fffff3f3f̙3ffffffffff!___www   C CC CC C C CC CC C C CC CC C     C CC CC C         C CC CC C     C CC CC C C CC CC C C CC CC C    C C C C C C   C C     C C   C C C C C C    C C C C C C   C C     C C   C C C C C C   static3-0.7.0/testdata/pub/gzipped.html.gz000066400000000000000000000007331271434451300204450ustar00rootroot00000000000000@WTgzipped.htmlR_o08RXtJ3A;bj ŭ-R;;;Ueׇ} :e%'ً՗ec})fKW (n!MRo>3&+۶MYb84wRaH&'|>,]ե-ЄȤ(gSuP]D-TQMR9تZl%#A[Yk-LQIɛc0|&j|v^j^3 (E?mt PJVl,5z8Y$RN;ƫ6DC_imwL$.(REM]RX৪N ~yO?pϐai y1ВJ\^V;T-UK'Ostatic3-0.7.0/testdata/pub/index.html000066400000000000000000000017461271434451300175000ustar00rootroot00000000000000 mixed content test

Mixed Content Test

This file should be served with a content type of 'text/html'.

A 304 should be returned on subsequent requests, until you touch the file.

A content type for 'text/xml' should be returned for this file.

For a test of using Python builtin string substitution try this file.

For a test of using Kid templates this file. (Requires Kid)

For a test of using genshi templates this file.

static3-0.7.0/testdata/pub/kid.html.kid000066400000000000000000000017731271434451300177060ustar00rootroot00000000000000 kid magic test

Title: $title

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

varables longer than 50 characters truncated
VariableValue
static3-0.7.0/testdata/pub/sub.html.stp000066400000000000000000000010601271434451300177540ustar00rootroot00000000000000 string substituted content test

$title

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

Path info: $PATH_INFO.

static3-0.7.0/testdata/pub/test.html.genshi000066400000000000000000000017241271434451300206200ustar00rootroot00000000000000 genshi magic test

Title: $title

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

varables longer than 50 characters truncated
VariableValue
static3-0.7.0/testdata/pub/test.xml000066400000000000000000000001271271434451300171740ustar00rootroot00000000000000 static3-0.7.0/testdata/pub/unicode.html000066400000000000000000000001511271434451300200040ustar00rootroot00000000000000 öäü static3-0.7.0/tests/000077500000000000000000000000001271434451300142365ustar00rootroot00000000000000static3-0.7.0/tests/__init__.py000066400000000000000000000000001271434451300163350ustar00rootroot00000000000000static3-0.7.0/tests/test_app.py000066400000000000000000000107071271434451300164340ustar00rootroot00000000000000# # Copyright 2013 Roman Mohr # # This file is part of static3. # # static3 is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Foobar is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Foobar. If not, see . import pytest import webtest from static import u @pytest.fixture def _cling(): from static import Cling return Cling(root="testdata/pub") @pytest.fixture def _shock(): from static import Shock, StringMagic, KidMagic, GenshiMagic magics = (StringMagic(title="String Test"), KidMagic(title="Kid Test"), GenshiMagic(title="Genshi Test")) return Shock(root="testdata/pub", magics=magics) @pytest.fixture def ascii_shock(_shock): _shock.encoding = 'ascii' return webtest.TestApp(_shock) @pytest.fixture def cling(_cling): return webtest.TestApp(_cling) @pytest.fixture def shock(_shock): return webtest.TestApp(_shock) @pytest.mark.skipif("sys.version_info >= (3,0)") def test_kid(shock): response = shock.get("/kid.html.kid") assert "Title: Kid Test" in response assert "REQUEST_METHOD" in response def test_genshi(shock): response = shock.get("/test.html") assert "Title: Genshi Test" in response assert "REQUEST_METHOD" in response def test_string(shock): response = shock.get("/sub.html.stp") assert "

String Test

" in response assert "Path info: /sub.html." in response def test_static_cling(cling): response = cling.get("/index.html") assert "Mixed Content" in response assert response.content_type == "text/html" response = cling.get("/test.xml") assert "green" in response # dependes on the mimetypes version, both is fine assert (response.content_type == "text/xml" or response.content_type == "application/xml") response = cling.get("/unicode.html") assert u('\u00f6\u00e4\u00fc') in response def test_cling_head(cling): response = cling.head("/index.html") assert response.content_type == "text/html" assert response.body == b'' def test_shock_head(shock): response = shock.head("/index.html") assert response.content_type == "text/html" assert response.body == b'' def test_gzip_cling(cling): response = cling.get("/gzipped.html", headers=[('Accept-Encoding', 'gzip, deflate')]) assert "Mixed Content" in response assert response.content_type == "text/html" assert 'Content-Encoding' not in response.headers assert response.headers['Vary'] == 'Accept-Encoding' def test_headers_cling(): from static import Cling def get(headers, url='/index.html'): app = webtest.TestApp(Cling(root="testdata/pub", headers=headers)) return app.get(url) response = get([{'type': 'text/html', 'Cache-Control': 'max-age=10'}]) assert response.headers['Cache-Control'] == 'max-age=10' response = get( [{'type': 'text/html', 'Cache-Control': 'max-age=10'}], '/test.xml') assert 'Cache-Control' not in response.headers.keys() response = get([{'ext': 'html', 'Cache-Control': 'max-age=10'}]) assert response.headers['Cache-Control'] == 'max-age=10' response = get( [{'ext': 'html', 'Cache-Control': 'max-age=10'}], '/test.xml') assert 'Cache-Control' not in response.headers.keys() response = get([{'prefix': '/index', 'Cache-Control': 'max-age=10'}]) assert response.headers['Cache-Control'] == 'max-age=10' response = get( [{'prefix': '/index', 'Cache-Control': 'max-age=10'}], '/test.xml') assert 'Cache-Control' not in response.headers.keys() def test_static_shock(shock): response = shock.get("/index.html") assert "Mixed Content" in response @pytest.mark.skipif("sys.version_info >= (3,0)") def test_encoding(ascii_shock): with pytest.raises(UnicodeEncodeError): ascii_shock.get("/encoding.html") @pytest.mark.skipif("sys.version_info < (3,0)") def test_decoding(ascii_shock): with pytest.raises(UnicodeDecodeError): ascii_shock.get("/encoding.html") static3-0.7.0/tox.ini000066400000000000000000000004171271434451300144110ustar00rootroot00000000000000[tox] envlist = py26, py27, py33, py34, pypy [testenv] deps= distribute pytest genshi py{26,27},pypy: kid commands=python setup.py test [] sitepackages=False setenv= PIP_USE_MIRRORS=true [pytest] norecursedirs = bin eggs .git _build tmp* lib *.egg