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

version_gt()

    35

{

    36

    test "$(printf '%s\n' "$@" | sort -V | head -n 1)" != "$1";

    37

}

    38

    39

    40

compile_checks()

    41

{

    42

    echo "Syntax checking using python ..."

    43

    python --version

    44

    45

    # remove compiled Python files

    46

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

    47

    48

    for i in $py_files; do

    49

        # echo $i

    50

        python -m py_compile $i

    51

        if [ $? -ne 0 ]; then

    52

            echo "Syntax error in $i"

    53

            set_exit_error

    54

        fi

    55

    done

    56

    echo "DONE"

    57

    echo ""

    58

}

    59

    60

    61

python3_compile_checks()

    62

{

    63

    echo "Syntax checking using python3 ..."

    64

    python3 --version

    65

    66

    # remove compiled Python files

    67

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

    68

    69

    for i in $py_files; do

    70

        # echo $i

    71

        python3 -m py_compile $i

    72

        if [ $? -ne 0 ]; then

    73

            echo "Syntax error in $i"

    74

            set_exit_error

    75

        fi

    76

    done

    77

    78

    # remove compiled Python files

    79

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

    80

    81

    echo "DONE"

    82

    echo ""

    83

}

    84

    85

localization_checks()

    86

{

    87

    echo "Check correct localization formats"

    88

    xgettext --version

    89

    90

    for i in $py_files; do

    91

        xgettext -s --language=Python --package-name Beremiz --output=/tmp/m.pot $i 2>&1 | grep 'warning'

    92

        if [ $? -eq 0 ]; then

    93

            echo "Syntax error in $i"

    94

            set_exit_error

    95

        fi

    96

    done

    97

    echo "DONE"

    98

    echo ""

    99

}

   100

   101

# pep8 was renamed to pycodestyle

   102

# detect existed version

   103

pep8_detect()

   104

{

   105

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

   106

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

   107

    if [ -z $pep8 ]; then

   108

        echo "pep8/pycodestyle is not found"

   109

        set_exit_error

   110

    fi

   111

    echo -n "pep8 version: "

   112

    $pep8 --version

   113

}

   114

   115

pep8_checks_default()

   116

{

   117

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

   118

   119

    test -n $pep8 && pep8_detect

   120

    test -z $pep8 && return

   121

   122

    user_ignore=

   123

    user_ignore=$user_ignore,W606  # W606 'async' and 'await' are reserved keywords starting with Python 3.7

   124

   125

    # ignored by default,

   126

    default_ignore=

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

    default_ignore=$default_ignore,W504  # W504 line break occurred after a binary operator

   137

    default_ignore=$default_ignore,W505  # W505 doc line too long (82 > 79 characters)

   138

    ignore=$user_ignore,$default_ignore

   139

   140

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

   141

    if [ $? -ne 0 ]; then

   142

        set_exit_error

   143

    fi

   144

   145

    echo "DONE"

   146

    echo ""

   147

}

   148

   149

   150

pep8_checks_selected()

   151

{

   152

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

   153

   154

    test -n $pep8 && pep8_detect

   155

    test -z $pep8 && return

   156

   157

    # select checks:

   158

    user_select=

   159

    user_select=$user_select,W291   # W291 trailing whitespace

   160

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

   161

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

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

    user_select=$user_select,W191   # W191 indentation contains tabs

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

   212

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

   213

    if [ $? -ne 0 ]; then

   214

        set_exit_error

   215

    fi

   216

   217

    echo "DONE"

   218

    echo ""

   219

}

   220

   221

flake8_checks()

   222

{

   223

    echo "Check for problems using flake8 ..."

   224

   225

    which flake8 > /dev/null

   226

    if [ $? -ne 0 ]; then

   227

        echo "flake8 is not found"

   228

        set_exit_error

   229

        return

   230

    fi

   231

   232

    echo -n "flake8 version: "

   233

    flake8 --version

   234

   235

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

   236

    if [ $? -ne 0 ]; then

   237

        set_exit_error

   238

    fi

   239

   240

    echo "DONE"

   241

    echo ""

   242

}

   243

   244

pylint_checks()

   245

   246

{

   247

    echo "Check for problems using pylint ..."

   248

   249

    which pylint > /dev/null

   250

    if [ $? -ne 0 ]; then

   251

        echo "pylint is not found"

   252

        set_exit_error

   253

        return

   254

    fi

   255

    pylint --version

   256

   257

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

   258

   259

    disable=

   260

    # These warnings most likely will not be fixed

   261

   262

    disable=$disable,C0103        # invalid-name

   263

    disable=$disable,C0326        # bad whitespace

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

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

   279

   280

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

   281

    disable=$disable,C0111        # missing-docstring

   282

    disable=$disable,W0703        # broad-except

   283

    disable=$disable,C0301        # Line too long

   284

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

   285

    disable=$disable,W0511        # fixme

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

   303

    enable=

   304

    enable=$enable,E1601          # print statement used

   305

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

   306

    enable=$enable,W0404          # reimported module

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

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

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

    enable=$enable,W0109          # (duplicate-key) Duplicate key 'X' in dictionary

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

    enable=$enable,R0123          # (literal-comparison) Comparison to literal

   355

   356

    # python3 compatibility checks

   357

    enable=$enable,W1648          # (bad-python3-import) Module moved in Python 3

   358

    enable=$enable,W1613          # (xrange-builtin) xrange built-in referenced

   359

    enable=$enable,W1612          # (unicode-builtin) unicode built-in referenced

   360

    enable=$enable,W1619          # (old-division) division w/o __future__ statement

   361

    enable=$enable,W1601          # (apply-builtin) apply built-in referenced

   362

    enable=$enable,W1659          # (xreadlines-attribute) Accessing a removed xreadlines attribute

   363

    enable=$enable,W1607          # (file-builtin) file built-in referenced

   364

    enable=$enable,W1606          # (execfile-builtin) execfile built-in referenced

   365

    enable=$enable,W1629          # (nonzero-method) __nonzero__ method defined

   366

    enable=$enable,W1602          # (basestring-builtin) basestring built-in referenced

   367

    enable=$enable,W1646          # (invalid-str-codec) non-text encoding used in str.decode

   368

    enable=$enable,W1645          # (exception-message-attribute) Exception.message removed in Python 3

   369

    enable=$enable,W1649          # (deprecated-string-function) Accessing a deprecated function on the string module

   370

    enable=$enable,W1651          # (deprecated-itertools-function) Accessing a deprecated function on the itertools module

   371

    enable=$enable,W1652          # (deprecated-types-field) Accessing a deprecated fields on the types module

   372

    enable=$enable,W1611          # (standarderror-builtin) StandardError built-in referenced

   373

    enable=$enable,W1624          # (indexing-exception) Indexing exceptions will not work on Python 3

   374

    enable=$enable,W1625          # (raising-string) Raising a string exception

   375

    enable=$enable,W1622          # (next-method-called) Called a next() method on an object

   376

    enable=$enable,W1653          # (next-method-defined) next method defined

   377

    enable=$enable,W1610          # (reduce-builtin) reduce built-in referenced

   378

    enable=$enable,W1633          # (round-builtin) round built-in referenced

   379

    # enable=

   380

   381

    options=

   382

   383

    ver=$(pylint --version 2>&1 | grep pylint  | awk '{ print $2 }')

   384

    if version_gt $ver '1.6.8'; then

   385

	echo "Use multiple threads for pylint"

   386

	options="$options --jobs=0 "

   387

    fi

   388

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

   389

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

   390

   391

    if [ -n "$enable" ]; then

   392

        options="$options --disable=all"

   393

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

   394

    else

   395

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

   396

    fi

   397

    # echo $options

   398

   399

    echo $py_files | xargs pylint $options

   400

    if [ $? -ne 0 ]; then

   401

        set_exit_error

   402

    fi

   403

   404

    echo "DONE"

   405

    echo ""

   406

}

   407

   408

   409

get_files_to_check()

   410

{

   411

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

   412

    if [ -e .hg/skiphook ]; then

   413

	echo "Skipping checks in the hook ..."

   414

	exit 0

   415

    fi

   416

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

   417

        if which hg > /dev/null; then

   418

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

   419

                hg_change="--change $HG_NODE"

   420

                msg="for commit $HG_NODE"

   421

            else

   422

                hg_change=""

   423

                msg="in local repository"

   424

            fi

   425

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

   426

            echo ""

   427

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

   428

            if [ $? -ne 0 ]; then

   429

                exit 1;

   430

            fi

   431

       fi

   432

    fi

   433

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

   434

        list="$2"

   435

        if [ -z "$list" ]; then

   436

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

   437

            print_help

   438

        fi

   439

        if [ -e "$list" ]; then

   440

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

   441

        fi

   442

    fi

   443

    if [ -z "$py_files" ]; then

   444

        echo "No files to check"

   445

        exit 0;

   446

    fi

   447

}

   448

   449

   450

print_help()

   451

{

   452

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

   453

    echo ""

   454

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

   455

    echo ""

   456

    echo "--only-changes"

   457

    echo "                only files with local changes are checked. "

   458

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

   459

    echo "                then only commited files are checked"

   460

    echo ""

   461

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

   462

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

   463

   464

    exit 1

   465

}

   466

   467

main()

   468

{

   469

    get_files_to_check $@

   470

    python3_compile_checks

   471

    compile_checks

   472

    localization_checks

   473

    pep8_checks_default

   474

    # pep8_checks_selected

   475

   476

    # flake8_checks

   477

    pylint_checks

   478

    exit $exit_code

   479

}

   480

   481

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

   482

main $@