

Module hug.transform

hug/transform.py

Defines Hug's built-in output transforming functions

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View Source

"""hug/transform.py

Defines Hug's built-in output transforming functions

Copyright (C) 2016  Timothy Edmund Crosley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated

documentation files (the "Software"), to deal in the Software without restriction, including without limitation

the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and

to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or

substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED

TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

"""

from __future__ import absolute_import

from hug.decorators import auto_kwargs

def content_type(transformers, default=None):

    """Returns a different transformer depending on the content type passed in.

       If none match and no default is given no transformation takes place.

       should pass in a dict with the following format:

            {'[content-type]': transformation_action,

             ...

            }

    """

    transformers = {

        content_type: auto_kwargs(transformer) if transformer else transformer

        for content_type, transformer in transformers.items()

    }

    default = default and auto_kwargs(default)

    def transform(data, request):

        transformer = transformers.get(request.content_type.split(";")[0], default)

        if not transformer:

            return data

        return transformer(data)

    return transform

def suffix(transformers, default=None):

    """Returns a different transformer depending on the suffix at the end of the requested URL.

       If none match and no default is given no transformation takes place.

       should pass in a dict with the following format:

            {'[suffix]': transformation_action,

             ...

            }

    """

    transformers = {

        suffix: auto_kwargs(transformer) if transformer else transformer

        for suffix, transformer in transformers.items()

    }

    default = default and auto_kwargs(default)

    def transform(data, request):

        path = request.path

        transformer = default

        for suffix_test, suffix_transformer in transformers.items():

            if path.endswith(suffix_test):

                transformer = suffix_transformer

                break

        return transformer(data) if transformer else data

    return transform

def prefix(transformers, default=None):

    """Returns a different transformer depending on the prefix at the end of the requested URL.

       If none match and no default is given no transformation takes place.

       should pass in a dict with the following format:

            {'[prefix]': transformation_action,

             ...

            }

    """

    transformers = {

        prefix: auto_kwargs(transformer) if transformer else transformer

        for prefix, transformer in transformers.items()

    }

    default = default and auto_kwargs(default)

    def transform(data, request=None, response=None):

        path = request.path

        transformer = default

        for prefix_test, prefix_transformer in transformers.items():

            if path.startswith(prefix_test):

                transformer = prefix_transformer

                break

        return transformer(data) if transformer else data

    return transform

def all(*transformers):

    """Returns the results of applying all passed in transformers to data

       should pass in list of transformers

            [transformer_1, transformer_2...]

    """

    transformers = tuple(auto_kwargs(transformer) for transformer in transformers)

    def transform(data, request=None, response=None):

        for transformer in transformers:

            data = transformer(data, request=request, response=response)

        return data

    return transform

Functions

all

def all(
    *transformers
)

Returns the results of applying all passed in transformers to data

should pass in list of transformers

 [transformer_1, transformer_2...]

View Source

def all(*transformers):

    """Returns the results of applying all passed in transformers to data

       should pass in list of transformers

            [transformer_1, transformer_2...]

    """

    transformers = tuple(auto_kwargs(transformer) for transformer in transformers)

    def transform(data, request=None, response=None):

        for transformer in transformers:

            data = transformer(data, request=request, response=response)

        return data

    return transform

content_type

def content_type(
    transformers,
    default=None
)

Returns a different transformer depending on the content type passed in. If none match and no default is given no transformation takes place.

should pass in a dict with the following format:

 {'[content-type]': transformation_action,
  ...
 }

View Source

def content_type(transformers, default=None):

    """Returns a different transformer depending on the content type passed in.

       If none match and no default is given no transformation takes place.

       should pass in a dict with the following format:

            {'[content-type]': transformation_action,

             ...

            }

    """

    transformers = {

        content_type: auto_kwargs(transformer) if transformer else transformer

        for content_type, transformer in transformers.items()

    }

    default = default and auto_kwargs(default)

    def transform(data, request):

        transformer = transformers.get(request.content_type.split(";")[0], default)

        if not transformer:

            return data

        return transformer(data)

    return transform

prefix

def prefix(
    transformers,
    default=None
)

Returns a different transformer depending on the prefix at the end of the requested URL. If none match and no default is given no transformation takes place.

should pass in a dict with the following format:

 {'[prefix]': transformation_action,
  ...
 }

View Source

def prefix(transformers, default=None):

    """Returns a different transformer depending on the prefix at the end of the requested URL.

       If none match and no default is given no transformation takes place.

       should pass in a dict with the following format:

            {'[prefix]': transformation_action,

             ...

            }

    """

    transformers = {

        prefix: auto_kwargs(transformer) if transformer else transformer

        for prefix, transformer in transformers.items()

    }

    default = default and auto_kwargs(default)

    def transform(data, request=None, response=None):

        path = request.path

        transformer = default

        for prefix_test, prefix_transformer in transformers.items():

            if path.startswith(prefix_test):

                transformer = prefix_transformer

                break

        return transformer(data) if transformer else data

    return transform

suffix

def suffix(
    transformers,
    default=None
)

Returns a different transformer depending on the suffix at the end of the requested URL. If none match and no default is given no transformation takes place.

should pass in a dict with the following format:

 {'[suffix]': transformation_action,
  ...
 }

View Source

def suffix(transformers, default=None):

    """Returns a different transformer depending on the suffix at the end of the requested URL.

       If none match and no default is given no transformation takes place.

       should pass in a dict with the following format:

            {'[suffix]': transformation_action,

             ...

            }

    """

    transformers = {

        suffix: auto_kwargs(transformer) if transformer else transformer

        for suffix, transformer in transformers.items()

    }

    default = default and auto_kwargs(default)

    def transform(data, request):

        path = request.path

        transformer = default

        for suffix_test, suffix_transformer in transformers.items():

            if path.endswith(suffix_test):

                transformer = suffix_transformer

                break

        return transformer(data) if transformer else data

    return transform