check-python-code 2.73 KB
Newer Older
1 2 3
#!/bin/bash
#

4
# Copyright (C) 2009, 2011 Google Inc.
Klaus Aehlig's avatar
Klaus Aehlig committed
5
# All rights reserved.
6
#
Klaus Aehlig's avatar
Klaus Aehlig committed
7 8 9
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
10
#
Klaus Aehlig's avatar
Klaus Aehlig committed
11 12
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
13
#
Klaus Aehlig's avatar
Klaus Aehlig committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29

30 31
set -e

32 33 34
# Ensure the checks always use the same locale
export LC_ALL=C

35 36 37 38 39 40 41
readonly maxlinelen=$(for ((i=0; i<81; ++i)); do echo -n .; done)

if [[ "${#maxlinelen}" != 81 ]]; then
  echo "Internal error: Check for line length is incorrect" >&2
  exit 1
fi

42 43 44
# "[...] If the last ARG evaluates to 0, let returns 1; 0 is returned
# otherwise.", hence ignoring the return value.
let problems=0 || :
45 46

for script; do
47
  if grep -n -H -F $'\t' "$script"; then
48 49 50
    let ++problems
    echo "Found tabs in $script" >&2
  fi
51

52
  if grep -n -H -E '[[:space:]]$' "$script"; then
53 54 55 56
    let ++problems
    echo "Found end-of-line-whitespace in $script" >&2
  fi

57 58 59 60 61 62
  # FIXME: This will also match "foo.xrange(...)"
  if grep -n -H -E '^[^#]*\<xrange\>' "$script"; then
    let ++problems
    echo "Forbidden function 'xrange' used in $script" >&2
  fi

63 64 65 66 67 68
  if grep -n -H -E -i '#[[:space:]]*(vim|Local[[:space:]]+Variables):' "$script"
  then
    let ++problems
    echo "Found editor-specific settings in $script" >&2
  fi

69
  if grep -n -H "^$maxlinelen" "$script"; then
70 71 72
    let ++problems
    echo "Longest line in $script is longer than 80 characters" >&2
  fi
73 74 75 76 77 78 79

  if grep -n -H -E -i \
    '#.*\bpylint[[:space:]]*:[[:space:]]*disable-msg\b' "$script"
  then
    let ++problems
    echo "Found old-style pylint disable pragma in $script" >&2
  fi
80 81 82
done

if [[ "$problems" -gt 0 ]]; then
83
  echo "Found $problems problem(s) while checking code." >&2
84 85
  exit 1
fi