api.decorators

Complexity

Total Complexity

24

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Importance

Changes

0

7 Functions

Rating	Name	Duplication	Size	Complexity
A	no_cache()	0	2	1
A	hit_count()	0	16	2
B	json()	0	20	6
A	rate_limit()	0	24	4
B	etag()	0	23	7
B	paginate()	0	53	3
A	cache_control()	0	12	1

import functools

This module should have a docstring.

import hashlib
from flask import jsonify, request, url_for, current_app, make_response, g
from .rate_limit import RateLimit
from .errors import too_many_requests, precondition_failed, not_modified


def json(f):

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

  @functools.wraps(f)

The indentation here looks off. 4 spaces were expected, but 2 were found.

  def wrapped(*args, **kwargs):

The indentation here looks off. 4 spaces were expected, but 2 were found.

This function should have a docstring.

    rv = f(*args, **kwargs)

The indentation here looks off. 8 spaces were expected, but 4 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    status_or_headers = None

The indentation here looks off. 8 spaces were expected, but 4 were found.

    headers = None

The indentation here looks off. 8 spaces were expected, but 4 were found.

    if isinstance(rv, tuple):

The indentation here looks off. 8 spaces were expected, but 4 were found.

      rv, status_or_headers, headers = rv + (None, ) * (3 - len(rv))

The indentation here looks off. 12 spaces were expected, but 6 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    if isinstance(status_or_headers, (dict, list)):

The indentation here looks off. 8 spaces were expected, but 4 were found.

      headers, status_or_headers = status_or_headers, None

The indentation here looks off. 12 spaces were expected, but 6 were found.

    if not isinstance(rv, dict):

The indentation here looks off. 8 spaces were expected, but 4 were found.

      rv = rv.to_json()

The indentation here looks off. 12 spaces were expected, but 6 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    rv = jsonify(rv)

The indentation here looks off. 8 spaces were expected, but 4 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    if status_or_headers is not None:

The indentation here looks off. 8 spaces were expected, but 4 were found.

      rv.status_code = status_or_headers

The indentation here looks off. 12 spaces were expected, but 6 were found.

    if headers is not None:

The indentation here looks off. 8 spaces were expected, but 4 were found.

      rv.headers.extend(headers)

The indentation here looks off. 12 spaces were expected, but 6 were found.

    return rv

The indentation here looks off. 8 spaces were expected, but 4 were found.

  return wrapped

The indentation here looks off. 4 spaces were expected, but 2 were found.

def hit_count(f):

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

  @functools.wraps(f)

The indentation here looks off. 4 spaces were expected, but 2 were found.

  def wrapped(*args, **kwargs):

The indentation here looks off. 4 spaces were expected, but 2 were found.

This function should have a docstring.

    rv = f(*args, **kwargs)

The indentation here looks off. 8 spaces were expected, but 4 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    if current_app.config['TESTING']:

The indentation here looks off. 8 spaces were expected, but 4 were found.

      from .rate_limit import FakeRedis

The indentation here looks off. 12 spaces were expected, but 6 were found.

      redis = FakeRedis()

The indentation here looks off. 12 spaces were expected, but 6 were found.

    else:  # pragma: no cover

The indentation here looks off. 8 spaces were expected, but 4 were found.

      from redis import Redis

The indentation here looks off. 12 spaces were expected, but 6 were found.

      redis = Redis()

The indentation here looks off. 12 spaces were expected, but 6 were found.

    key = 'hit-count%s' % (request.path)

The indentation here looks off. 8 spaces were expected, but 4 were found.

    redis.incr(key)

The indentation here looks off. 8 spaces were expected, but 4 were found.

    return rv

The indentation here looks off. 8 spaces were expected, but 4 were found.

  return wrapped

The indentation here looks off. 4 spaces were expected, but 2 were found.

def rate_limit(limit, per, scope_func=lambda: request.remote_addr):

The variable request does not seem to be defined.

This function should have a docstring.

  def decorator(f):

The indentation here looks off. 4 spaces were expected, but 2 were found.

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

    @functools.wraps(f)

The indentation here looks off. 8 spaces were expected, but 4 were found.

    def wrapped(*args, **kwargs):

The indentation here looks off. 8 spaces were expected, but 4 were found.

This function should have a docstring.

      if current_app.config['USE_RATE_LIMITS']:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        key = 'rate-limit/%s/%s/' % (f.__name__, scope_func())

The indentation here looks off. 16 spaces were expected, but 8 were found.

        limiter = RateLimit(key, limit, per)

The indentation here looks off. 16 spaces were expected, but 8 were found.

        if not limiter.over_limit:

The indentation here looks off. 16 spaces were expected, but 8 were found.

          rv = f(*args, **kwargs)

The indentation here looks off. 20 spaces were expected, but 10 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        else:

The indentation here looks off. 16 spaces were expected, but 8 were found.

          rv = too_many_requests('You have exceeded your request rate')

The indentation here looks off. 20 spaces were expected, but 10 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

        # rv = make_response(rv)
        g.headers = {

The indentation here looks off. 16 spaces were expected, but 8 were found.

            'X-RateLimit-Remaining': str(limiter.remaining),
            'X-RateLimit-Limit': str(limiter.limit),
            'X-RateLimit-Reset': str(limiter.reset)
        }
        return rv

The indentation here looks off. 16 spaces were expected, but 8 were found.

      else:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        return f(*args, **kwargs)

The indentation here looks off. 16 spaces were expected, but 8 were found.

    return wrapped

The indentation here looks off. 8 spaces were expected, but 4 were found.

  return decorator

The indentation here looks off. 4 spaces were expected, but 2 were found.

def paginate(max_per_page=10):

This function should have a docstring.

  def decorator(f):

The indentation here looks off. 4 spaces were expected, but 2 were found.

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

    @functools.wraps(f)

The indentation here looks off. 8 spaces were expected, but 4 were found.

    def wrapped(*args, **kwargs):

The indentation here looks off. 8 spaces were expected, but 4 were found.

This function should have a docstring.

      page = request.args.get('page', 1, type=int)

The indentation here looks off. 12 spaces were expected, but 6 were found.

      per_page = min(

The indentation here looks off. 12 spaces were expected, but 6 were found.

          request.args.get('per_page', max_per_page, type=int), max_per_page)
      query = f(*args, **kwargs)

The indentation here looks off. 12 spaces were expected, but 6 were found.

      p = query.paginate(page, per_page)

The indentation here looks off. 12 spaces were expected, but 6 were found.

The name p does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

      pages = {

The indentation here looks off. 12 spaces were expected, but 6 were found.

          'page': page,
          'per_page': per_page,
          'total': p.total,
          'pages': p.pages
      }
      if p.has_prev:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        pages['prev'] = url_for(

The indentation here looks off. 16 spaces were expected, but 8 were found.

            request.endpoint,
            page=p.prev_num,
            per_page=per_page,
            _external=True,
            **kwargs)
      else:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        pages['prev'] = None

The indentation here looks off. 16 spaces were expected, but 8 were found.

      if p.has_next:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        pages['next'] = url_for(

The indentation here looks off. 16 spaces were expected, but 8 were found.

            request.endpoint,
            page=p.next_num,
            per_page=per_page,
            _external=True,
            **kwargs)
      else:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        pages['next'] = None

The indentation here looks off. 16 spaces were expected, but 8 were found.

      pages['first'] = url_for(

The indentation here looks off. 12 spaces were expected, but 6 were found.

          request.endpoint,
          page=1,
          per_page=per_page,
          _external=True,
          **kwargs)
      pages['last'] = url_for(

The indentation here looks off. 12 spaces were expected, but 6 were found.

          request.endpoint,
          page=p.pages,
          per_page=per_page,
          _external=True,
          **kwargs)
      return jsonify({

The indentation here looks off. 12 spaces were expected, but 6 were found.

          'urls': [item.get_url() for item in p.items],
          'meta': pages
      })

    return wrapped

The indentation here looks off. 8 spaces were expected, but 4 were found.

  return decorator

The indentation here looks off. 4 spaces were expected, but 2 were found.

def cache_control(*directives):

This function should have a docstring.

  def decorator(f):

The indentation here looks off. 4 spaces were expected, but 2 were found.

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

    @functools.wraps(f)

The indentation here looks off. 8 spaces were expected, but 4 were found.

    def wrapped(*args, **kwargs):

The indentation here looks off. 8 spaces were expected, but 4 were found.

This function should have a docstring.

      rv = f(*args, **kwargs)

The indentation here looks off. 12 spaces were expected, but 6 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

      rv = make_response(rv)

The indentation here looks off. 12 spaces were expected, but 6 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

      rv.headers['Cache-Control'] = ', '.join(directives)

The indentation here looks off. 12 spaces were expected, but 6 were found.

      return rv

The indentation here looks off. 12 spaces were expected, but 6 were found.

    return wrapped

The indentation here looks off. 8 spaces were expected, but 4 were found.

  return decorator

The indentation here looks off. 4 spaces were expected, but 2 were found.

def no_cache(f):

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

  return cache_control('no-cache', 'no-store', 'max-age=0')(f)

The indentation here looks off. 4 spaces were expected, but 2 were found.

def etag(f):

The name f does not conform to the argument naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This function should have a docstring.

  @functools.wraps(f)

The indentation here looks off. 4 spaces were expected, but 2 were found.

  def wrapped(*args, **kwargs):

The indentation here looks off. 4 spaces were expected, but 2 were found.

This function should have a docstring.

    # only for HEAD and GET requests
    assert request.method in ['HEAD', 'GET'],\

The indentation here looks off. 8 spaces were expected, but 4 were found.

        '@etag is only supported for GET requests'
    rv = f(*args, **kwargs)

The indentation here looks off. 8 spaces were expected, but 4 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    rv = make_response(rv)

The indentation here looks off. 8 spaces were expected, but 4 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    etag = '"' + hashlib.md5(rv.get_data()).hexdigest() + '"'

The indentation here looks off. 8 spaces were expected, but 4 were found.

etag is re-defining a name which is already available in the outer-scope (previously defined on line 147).

    rv.headers['ETag'] = etag

The indentation here looks off. 8 spaces were expected, but 4 were found.

    if_match = request.headers.get('If-Match')

The indentation here looks off. 8 spaces were expected, but 4 were found.

    if_none_match = request.headers.get('If-None-Match')

The indentation here looks off. 8 spaces were expected, but 4 were found.

    if if_match:

The indentation here looks off. 8 spaces were expected, but 4 were found.

      etag_list = [tag.strip() for tag in if_match.split(',')]

The indentation here looks off. 12 spaces were expected, but 6 were found.

      if etag not in etag_list and '*' not in etag_list:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        rv = precondition_failed()

The indentation here looks off. 16 spaces were expected, but 8 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    elif if_none_match:

The indentation here looks off. 8 spaces were expected, but 4 were found.

      etag_list = [tag.strip() for tag in if_none_match.split(',')]

The indentation here looks off. 12 spaces were expected, but 6 were found.

      if etag in etag_list or '*' in etag_list:

The indentation here looks off. 12 spaces were expected, but 6 were found.

        rv = not_modified()

The indentation here looks off. 16 spaces were expected, but 8 were found.

The name rv does not conform to the variable naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

    return rv

The indentation here looks off. 8 spaces were expected, but 4 were found.

  return wrapped

The indentation here looks off. 4 spaces were expected, but 2 were found.