1

#!/bin/sh

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2017: Andrey Skvortsov

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

exit_code=0

    27

set_exit_error()

    28

{

    29

    if [ $exit_code -eq 0 ]; then

    30

       exit_code=1

    31

    fi

    32

}

    33

    34

    35

compile_checks()

    36

{

    37

    echo "Syntax checking using python ..."

    38

    python --version

    39

    40

    # remove compiled Python files

    41

    find . -name '*.pyc' -exec rm -f {} \;

    42

    43

    for i in $py_files; do

    44

        # echo $i

    45

        python -m py_compile $i

    46

        if [ $? -ne 0 ]; then

    47

            echo "Syntax error in $i"

    48

            set_exit_error

    49

        fi

    50

    done

    51

    echo "DONE"

    52

    echo ""

    53

}

    54

    55

# pep8 was renamed to pycodestyle

    56

# detect existed version

    57

pep8_detect()

    58

{

    59

    test -n $pep8 && (which pep8 > /dev/null) && pep8="pep8"

    60

    test -n $pep8 && (which pycodestyle > /dev/null) && pep8="pycodestyle"

    61

    if [ -z $pep8 ]; then

    62

        echo "pep8/pycodestyle is not found"

    63

        set_exit_error

    64

    fi

    65

    echo -n "pep8 version: "

    66

    $pep8 --version

    67

}

    68

    69

pep8_checks_default()

    70

{

    71

    echo "Check basic code-style problems for PEP-8"

    72

    73

    test -n $pep8 && pep8_detect

    74

    test -z $pep8 && return

    75

    76

    user_ignore=

    77

    # user_ignore=$user_ignore,E265  # E265 block comment should start with '# '

    78

    user_ignore=$user_ignore,E501  # E501 line too long (80 > 79 characters)

    79

    80

    # ignored by default,

    81

    default_ignore=

    82

    default_ignore=$default_ignore,E121  # E121 continuation line under-indented for hanging indent

    83

    default_ignore=$default_ignore,E123  # E123 closing bracket does not match indentation of opening bracket’s line

    84

    default_ignore=$default_ignore,E126  # E126 continuation line over-indented for hanging indent

    85

    default_ignore=$default_ignore,E133  # E133 closing bracket is missing indentation

    86

    default_ignore=$default_ignore,E226  # E226 missing whitespace around arithmetic operator

    87

    default_ignore=$default_ignore,E241  # E241 multiple spaces after ':'

    88

    default_ignore=$default_ignore,E242  # E242 tab after ‘,’

    89

    default_ignore=$default_ignore,E704  # E704 multiple statements on one line (def)

    90

    default_ignore=$default_ignore,W503  # W503 line break occurred before a binary operator

    91

    ignore=$user_ignore,$default_ignore

    92

    93

    # $pep8 --ignore $ignore --exclude build ./

    94

    $pep8 --max-line-length 300 --exclude build $py_files

    95

    if [ $? -ne 0 ]; then

    96

        set_exit_error

    97

    fi

    98

    99

    echo "DONE"

   100

    echo ""

   101

}

   102

   103

   104

pep8_checks_selected()

   105

{

   106

    echo "Check basic code-style problems for PEP-8 (selective)"

   107

   108

    test -n $pep8 && pep8_detect

   109

    test -z $pep8 && return

   110

   111

    # select checks:

   112

    user_select=

   113

    user_select=$user_select,W291   # W291 trailing whitespace

   114

    user_select=$user_select,E401   # E401 multiple imports on one line

   115

    user_select=$user_select,E265   # E265 block comment should start with '# '

   116

    user_select=$user_select,E228   # E228 missing whitespace around modulo operator

   117

    user_select=$user_select,W293   # W293 blank line contains whitespace

   118

    user_select=$user_select,E302   # E302 expected 2 blank lines, found 1

   119

    user_select=$user_select,E301   # E301 expected 2 blank lines, found 1

   120

    user_select=$user_select,E261   # E261 at least two spaces before inline comment

   121

    user_select=$user_select,E271   # E271 multiple spaces after keyword

   122

    user_select=$user_select,E231   # E231 missing whitespace after ','

   123

    user_select=$user_select,E303   # E303 too many blank lines (2)

   124

    user_select=$user_select,E225   # E225 missing whitespace around operator

   125

    user_select=$user_select,E711   # E711 comparison to None should be 'if cond is not None:'

   126

    user_select=$user_select,E251   # E251 unexpected spaces around keyword / parameter equals

   127

    user_select=$user_select,E227   # E227 missing whitespace around bitwise or shift operator

   128

    user_select=$user_select,E202   # E202 whitespace before ')'

   129

    user_select=$user_select,E201   # E201 whitespace after '{'

   130

    user_select=$user_select,W391   # W391 blank line at end of file

   131

    user_select=$user_select,E305   # E305 expected 2 blank lines after class or function definition, found X

   132

    user_select=$user_select,E306   # E306 expected 1 blank line before a nested definition, found X

   133

    user_select=$user_select,E703   # E703 statement ends with a semicolon

   134

    user_select=$user_select,E701   # E701 multiple statements on one line (colon)

   135

    user_select=$user_select,E221   # E221 multiple spaces before operator

   136

    user_select=$user_select,E741   # E741 ambiguous variable name 'l'

   137

    user_select=$user_select,E111   # E111 indentation is not a multiple of four

   138

    user_select=$user_select,E222   # E222 multiple spaces after operator

   139

    user_select=$user_select,E712   # E712 comparison to True should be 'if cond is True:' or 'if cond:'

   140

    user_select=$user_select,E262   # E262 inline comment should start with '# '

   141

    user_select=$user_select,E203   # E203 whitespace before ','

   142

    user_select=$user_select,E731   # E731 do not assign a lambda expression, use a def

   143

    user_select=$user_select,W601   # W601 .has_key() is deprecated, use 'in'

   144

    user_select=$user_select,E502   # E502 the backslash is redundant between brackets

   145

    user_select=$user_select,W602   # W602 deprecated form of raising exception

   146

    user_select=$user_select,E129   # E129 visually indented line with same indent as next logical line

   147

    user_select=$user_select,E127   # E127 continuation line over-indented for visual indent

   148

    user_select=$user_select,E128   # E128 continuation line under-indented for visual indent

   149

    user_select=$user_select,E125   # E125 continuation line with same indent as next logical line

   150

    user_select=$user_select,E114   # E114 indentation is not a multiple of four (comment)

   151

    user_select=$user_select,E211   # E211 whitespace before '['

   152

    user_select=$user_select,W191   # W191 indentation contains tabs

   153

    user_select=$user_select,E101   # E101 indentation contains mixed spaces and tabs

   154

    user_select=$user_select,E124   # E124 closing bracket does not match visual indentation

   155

    user_select=$user_select,E272   # E272 multiple spaces before keyword

   156

    user_select=$user_select,E713   # E713 test for membership should be 'not in'

   157

    user_select=$user_select,E122   # E122 continuation line missing indentation or outdented

   158

    user_select=$user_select,E131   # E131 continuation line unaligned for hanging indent

   159

    user_select=$user_select,E721   # E721 do not compare types, use 'isinstance()'

   160

    user_select=$user_select,E115   # E115 expected an indented block (comment)

   161

    user_select=$user_select,E722   # E722 do not use bare except'

   162

    user_select=$user_select,E266   # E266 too many leading '#' for block comment

   163

    user_select=$user_select,E402   # E402 module level import not at top of file

   164

    user_select=$user_select,W503   # W503 line break before binary operator

   165

   166

    $pep8 --select $user_select --exclude=build $py_files

   167

    if [ $? -ne 0 ]; then

   168

        set_exit_error

   169

    fi

   170

   171

    echo "DONE"

   172

    echo ""

   173

}

   174

   175

flake8_checks()

   176

{

   177

    echo "Check for problems using flake8 ..."

   178

   179

    which flake8 > /dev/null

   180

    if [ $? -ne 0 ]; then

   181

        echo "flake8 is not found"

   182

        set_exit_error

   183

        return

   184

    fi

   185

   186

    echo -n "flake8 version: "

   187

    flake8 --version

   188

   189

    flake8 --max-line-length=300  --exclude=build --builtins="_" $py_files

   190

    if [ $? -ne 0 ]; then

   191

        set_exit_error

   192

    fi

   193

   194

    echo "DONE"

   195

    echo ""

   196

}

   197

   198

pylint_checks()

   199

{

   200

    echo "Check for problems using pylint ..."

   201

   202

    which pylint > /dev/null

   203

    if [ $? -ne 0 ]; then

   204

        echo "pylint is not found"

   205

        set_exit_error

   206

        return

   207

    fi

   208

    pylint --version

   209

   210

    export PYTHONPATH="$PWD/../CanFestival-3/objdictgen":$PYTHONPATH

   211

   212

    disable=

   213

    # These warnings most likely will not be fixed

   214

   215

    disable=$disable,C0103        # invalid-name

   216

    disable=$disable,C0326        # bad whitespace

   217

    disable=$disable,W0110        # (deprecated-lambda) map/filter on lambda could be replaced by comprehension

   218

    disable=$disable,W1401        # (anomalous-backslash-in-string) Anomalous backslash in string: '\.'. String constant might be missing an r prefix.

   219

    disable=$disable,W0613        # (unused-argument) Unused argument 'X'

   220

    disable=$disable,W0622        # (redefined-builtin) Redefining built-in

   221

    disable=$disable,W0621        # (redefined-outer-name) Redefining name 'Y' from outer scope (line X)

   222

    disable=$disable,W0122        # (exec-used) Use of exec

   223

    disable=$disable,W0123        # (eval-used) Use of eval

   224

    disable=$disable,I0011        # (locally-disabled) Locally disabling ungrouped-imports (C0412)

   225

    disable=$disable,R0204        # (redefined-variable-type) Redefinition of current type from X to Y

   226

    disable=$disable,R0201        # (no-self-use) Method could be a function

   227

    disable=$disable,W0221        # (arguments-differ) Arguments number differs from overridden 'X' method

   228

    disable=$disable,C0201        # (consider-iterating-dictionary) Consider iterating the dictionary directly instead of calling .keys()

   229

    disable=$disable,W0201        # (attribute-defined-outside-init) Attribute 'X' defined outside __init__

   230

    disable=$disable,I1101        # (c-extension-no-member) Module 'lxml.etree' has not 'X' member,

   231

                                  # but source is unavailable. Consider adding this module to extension-pkg-whitelist

   232

                                  # if you want to perform analysis based on run-time introspection of living objects.

   233

   234

    # It'd be nice to fix warnings below some day

   235

    disable=$disable,C0111        # missing-docstring

   236

    disable=$disable,W0703        # broad-except

   237

    disable=$disable,C0301        # Line too long

   238

    disable=$disable,C0302        # Too many lines in module

   239

    disable=$disable,W0511        # fixme

   240

    disable=$disable,R0901        # (too-many-ancestors) Too many ancestors (9/7)

   241

    disable=$disable,R0902        # (too-many-instance-attributes) Too many instance attributes (10/7)

   242

    disable=$disable,R0903        # (too-few-public-methods) Too few public methods (0/2)

   243

    disable=$disable,R0904        # (too-many-public-methods) Too many public methods (41/20)

   244

    disable=$disable,R0911        # (too-many-return-statements) Too many return statements (7/6)

   245

    disable=$disable,R0912        # (too-many-branches) Too many branches (61/12)

   246

    disable=$disable,R0913        # (too-many-arguments) Too many arguments (6/5)

   247

    disable=$disable,R0914        # (too-many-locals) Too many local variables (18/15)

   248

    disable=$disable,R0915        # (too-many-statements) Too many statements (57/50)

   249

    disable=$disable,R0916        # (too-many-boolean-expressions) Too many boolean expressions in if statement (6/5)

   250

    disable=$disable,R0101        # (too-many-nested-blocks) Too many nested blocks (7/5)

   251

    disable=$disable,R0801        # (duplicate-code) Similar lines in N files

   252

    disable=$disable,W0401        # (wildcard-import) Wildcard import 

   253

    disable=$disable,W0614        # (unused-wildcard-import), ] Unused import X from wildcard import

   254

    disable=$disable,W0212        # (protected-access) Access to a protected member X of a Y class

   255

    disable=$disable,E1101        # (no-member) Instance of 'X' has no 'Y' member

   256

   257

    enable=

   258

    enable=$enable,E1601          # print statement used

   259

    enable=$enable,C0325          # (superfluous-parens) Unnecessary parens after keyword

   260

    enable=$enable,W0404          # reimported module

   261

    enable=$enable,C0411          # (wrong-import-order) standard import "import x" comes before "import y"

   262

    enable=$enable,W0108          # (unnecessary-lambda) Lambda may not be necessary

   263

    enable=$enable,C0412          # (ungrouped-imports) Imports from package X are not grouped

   264

    enable=$enable,C0321          # (multiple-statements) More than one statement on a single line

   265

    enable=$enable,W0231          # (super-init-not-called) __init__ method from base class is not called

   266

    enable=$enable,W0105          # (pointless-string-statement) String statement has no effect

   267

    enable=$enable,W0311          # (bad-indentation) Bad indentation. Found 16 spaces, expected 12

   268

    enable=$enable,W0101          # (unreachable) Unreachable code

   269

    enable=$enable,E0102          # (function-redefined) method already defined

   270

    enable=$enable,W0602          # (global-variable-not-assigned) Using global for 'X' but no assignment is done

   271

    enable=$enable,W0611          # (unused-import) Unused import X

   272

    enable=$enable,C1001          # (old-style-class) Old-style class defined. Problem with PyJS

   273

    enable=$enable,W0102          # (dangerous-default-value) Dangerous default value {} as argument

   274

    enable=$enable,C0112          # (empty-docstring)

   275

    enable=$enable,W0631          # (undefined-loop-variable) Using possibly undefined loop variable 'X'

   276

    enable=$enable,W0104          # (pointless-statement) Statement seems to have no effect

   277

    enable=$enable,W0107          # (unnecessary-pass) Unnecessary pass statement

   278

    enable=$enable,W0406          # (import-self) Module import itself

   279

    enable=$enable,C0413          # (wrong-import-position) Import "import X" should be placed at the top of the module

   280

    enable=$enable,E1305          # (too-many-format-args) Too many arguments for format string

   281

    enable=$enable,E0704          # (misplaced-bare-raise) The raise statement is not inside an except clause

   282

    enable=$enable,C0123          # (unidiomatic-typecheck) Using type() instead of isinstance() for a typecheck.

   283

    enable=$enable,E0601          # (used-before-assignment) Using variable 'X' before assignment

   284

    enable=$enable,E1120          # (no-value-for-parameter) No value for argument 'X' in function call

   285

    enable=$enable,E0701          # (bad-except-order) Bad except clauses order (X is an ancestor class of Y)

   286

    enable=$enable,E0611          # (no-name-in-module) No name 'X' in module 'Y'

   287

    enable=$enable,E0213          # (no-self-argument) Method should have "self" as first argument

   288

    enable=$enable,E0401          # (import-error) Unable to import 'X'

   289

    enable=$enable,E1121          # (too-many-function-args) Too many positional arguments for function call

   290

    enable=$enable,W0232          # (no-init) Class has no __init__ method

   291

    enable=$enable,W0233          # (non-parent-init-called) __init__ method from a non direct base class 'X' is called

   292

    enable=$enable,W0601          # (global-variable-undefined) Global variable 'X' undefined at the module level

   293

    enable=$enable,W0111          # (assign-to-new-keyword) Name async will become a keyword in Python 3.7

   294

    enable=$enable,W0623          # (redefine-in-handler) Redefining name 'X' from outer scope (line Y) in exception handler

   295

    enable=$enable,E1310          # (bad-str-strip-call) Suspicious argument in str.strip call

   296

    enable=$enable,E1300          # (bad-format-character) Unsupported format character '"' (0x22) at index 17

   297

    enable=$enable,E1304          # (missing-format-string-key) Missing key 'X_name' in format string dictionary

   298

    enable=$enable,R1701          # (consider-merging-isinstance) Consider merging these isinstance calls to isinstance(CTNLDFLAGS, (str, unicode))

   299

    enable=$enable,R1704          # (redefined-argument-from-local) Redefining argument with the local name 'Y'

   300

    enable=$enable,W0106          # (expression-not-assigned) Expression "X" is assigned to nothing

   301

    enable=$enable,E1136          # (unsubscriptable-object) Value 'X' is unsubscriptable

   302

    enable=$enable,E0602          # (undefined-variable) Undefined variable 'X'

   303

    enable=$enable,W1618          # (no-absolute-import) import missing `from __future__ import absolute_import`

   304

    enable=$enable,W0403          # (relative-import) Relative import 'Y', should be 'X.Y '

   305

    enable=$enable,W0612          # (unused-variable) Unused variable 'X'

   306

    enable=$enable,C0330          # (bad-continuation) Wrong hanging indentation before block

   307

    # enable=

   308

   309

    options=

   310

    options="$options --rcfile=.pylint"

   311

    # options="$options --py3k"   # report errors for Python 3 porting

   312

   313

    if [ -n "$enable" ]; then

   314

        options="$options --disable=all"

   315

        options="$options --enable=$enable"

   316

    else

   317

        options="$options --disable=$disable"

   318

    fi

   319

    # echo $options

   320

   321

    echo $py_files | xargs pylint $options

   322

    if [ $? -ne 0 ]; then

   323

        set_exit_error

   324

    fi

   325

   326

    echo "DONE"

   327

    echo ""

   328

}

   329

   330

   331

get_files_to_check()

   332

{

   333

    py_files=$(find . -name '*.py' -not -path '*/build/*')

   334

    if [ -e .hg/skiphook ]; then

   335

	echo "Skipping checks in the hook ..."

   336

	exit 0

   337

    fi

   338

    if [ "$1" = "--only-changes" ]; then

   339

        if which hg > /dev/null; then

   340

            if [ ! -z "$HG_NODE" ]; then

   341

                hg_change="--change $HG_NODE"

   342

                msg="for commit $HG_NODE"

   343

            else

   344

                hg_change=""

   345

                msg="in local repository"

   346

            fi

   347

            echo "Only changes ${msg} will be checked"

   348

            echo ""

   349

            py_files=$(hg status -m -a -n -I '**.py' $hg_change)

   350

            if [ $? -ne 0 ]; then

   351

                exit 1;

   352

            fi

   353

       fi

   354

    fi

   355

    if [ "$1" = "--files-to-check" ]; then

   356

        list="$2"

   357

        if [ -z "$list" ]; then

   358

            echo "--files-to-check requires filename as argument"

   359

            print_help

   360

        fi

   361

        if [ -e "$list" ]; then

   362

            py_files=$(cat $2 | grep '\.py$')

   363

        fi

   364

    fi

   365

    if [ -z "$py_files" ]; then

   366

        echo "No files to check"

   367

        exit 0;

   368

    fi

   369

}

   370

   371

   372

print_help()

   373

{

   374

    echo "Usage: check_source.sh [--only-changes | --files-to-check <filename> ]"

   375

    echo ""

   376

    echo "By default without arguments script checks all python source files"

   377

    echo ""

   378

    echo "--only-changes"

   379

    echo "                only files with local changes are checked. "

   380

    echo "                If script is called from mercurial pretxncommit hook,"

   381

    echo "                then only commited files are checked"

   382

    echo ""

   383

    echo "--files-to-check <file.lst>"

   384

    echo "                script read list of files to check from file.lst"

   385

   386

    exit 1

   387

}

   388

   389

main()

   390

{

   391

    get_files_to_check $@

   392

    compile_checks

   393

    pep8_checks_default

   394

    # pep8_checks_selected

   395

   396

    # flake8_checks

   397

    pylint_checks

   398

    exit $exit_code

   399

}

   400

   401

[ "$1" = "--help" -o "$1" = "-h" ] && print_help

   402

main $@