OpenQuizz
Une application de gestion des contenus pédagogiques
SharedDataMiddleware Class Reference
Inheritance diagram for SharedDataMiddleware:
Collaboration diagram for SharedDataMiddleware:

Public Member Functions

def __init__ (self, app, exports, disallow=None, cache=True, cache_timeout=60 *60 *12, fallback_mimetype="application/octet-stream")
 
def is_allowed (self, filename)
 
def get_file_loader (self, filename)
 
def get_package_loader (self, package, package_path)
 
def get_directory_loader (self, directory)
 
def generate_etag (self, mtime, file_size, real_filename)
 
def __call__ (self, environ, start_response)
 

Data Fields

 app
 
 exports
 
 cache
 
 cache_timeout
 
 is_allowed
 
 fallback_mimetype
 

Detailed Description

A WSGI middleware that provides static content for development
environments or simple server setups. Usage is quite simple::

    import os
    from werkzeug.middleware.shared_data import SharedDataMiddleware

    app = SharedDataMiddleware(app, {
        '/static': os.path.join(os.path.dirname(__file__), 'static')
    })

The contents of the folder ``./shared`` will now be available on
``http://example.com/shared/``.  This is pretty useful during development
because a standalone media server is not required.  One can also mount
files on the root folder and still continue to use the application because
the shared data middleware forwards all unhandled requests to the
application, even if the requests are below one of the shared folders.

If `pkg_resources` is available you can also tell the middleware to serve
files from package data::

    app = SharedDataMiddleware(app, {
        '/static': ('myapplication', 'static')
    })

This will then serve the ``static`` folder in the `myapplication`
Python package.

The optional `disallow` parameter can be a list of :func:`~fnmatch.fnmatch`
rules for files that are not accessible from the web.  If `cache` is set to
`False` no caching headers are sent.

Currently the middleware does not support non ASCII filenames.  If the
encoding on the file system happens to be the encoding of the URI it may
work but this could also be by accident.  We strongly suggest using ASCII
only file names for static files.

The middleware will guess the mimetype using the Python `mimetype`
module.  If it's unable to figure out the charset it will fall back
to `fallback_mimetype`.

:param app: the application to wrap.  If you don't want to wrap an
            application you can pass it :exc:`NotFound`.
:param exports: a list or dict of exported files and folders.
:param disallow: a list of :func:`~fnmatch.fnmatch` rules.
:param cache: enable or disable caching headers.
:param cache_timeout: the cache timeout in seconds for the headers.
:param fallback_mimetype: The fallback mimetype for unknown files.

.. versionchanged:: 1.0
    The default ``fallback_mimetype`` is
    ``application/octet-stream``. If a filename looks like a text
    mimetype, the ``utf-8`` charset is added to it.

.. versionadded:: 0.6
    Added ``fallback_mimetype``.

.. versionchanged:: 0.5
    Added ``cache_timeout``.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  app,
  exports,
  disallow = None,
  cache = True,
  cache_timeout = 60 * 60 * 12,
  fallback_mimetype = "application/octet-stream" 
)

Member Function Documentation

◆ __call__()

def __call__ (   self,
  environ,
  start_response 
)

◆ generate_etag()

def generate_etag (   self,
  mtime,
  file_size,
  real_filename 
)

◆ get_directory_loader()

def get_directory_loader (   self,
  directory 
)

◆ get_file_loader()

def get_file_loader (   self,
  filename 
)

◆ get_package_loader()

def get_package_loader (   self,
  package,
  package_path 
)

◆ is_allowed()

def is_allowed (   self,
  filename 
)
Subclasses can override this method to disallow the access to
certain files.  However by providing `disallow` in the constructor
this method is overwritten.

Field Documentation

◆ app

app

◆ cache

cache

◆ cache_timeout

cache_timeout

◆ exports

exports

◆ fallback_mimetype

fallback_mimetype

◆ is_allowed

is_allowed

The documentation for this class was generated from the following file: