Skip to content

Commit

Permalink
pylint a few python scripts and lint in lint.sh (flutter#33675)
Browse files Browse the repository at this point in the history
  • Loading branch information
zanderso authored Jun 4, 2022
1 parent 6e180c9 commit 2f0b7f9
Show file tree
Hide file tree
Showing 16 changed files with 632 additions and 360 deletions.
254 changes: 254 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
[MASTER]

# Specify a configuration file.
#rcfile=

# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=

# Add files or directories to the blocklist. They should be base names, not
# paths.
ignore=CVS,.git,out

# Pickle collected data for later comparisons.
persistent=yes

# List of plugins (as comma separated values of python modules names) to load,
# usually to register additional checkers.
load-plugins=
pylint_quotes


# Configure quote preferences.
string-quote = single-avoid-escape
triple-quote = double
docstring-quote = double


[MESSAGES CONTROL]

# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time.
#enable=

# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once).
disable=
exec-used,
fixme,
missing-class-docstring,
missing-function-docstring,
missing-module-docstring,
too-few-public-methods,
too-many-branches,
too-many-lines,
too-many-return-statements,
too-many-statements,


[REPORTS]

# Set the output format. Available formats are text, parseable, colorized, msvs
# (visual studio) and html
output-format=text

# Put messages in a separate file for each module / package specified on the
# command line instead of printing them on stdout. Reports (if any) will be
# written in a file name "pylint_global.[txt|html]".
files-output=no

# Tells whether to display a full report or only the messages
# CHANGED:
reports=no

# Activate the evaluation score.
score=no

# Python expression which should return a note less than 10 (10 is the highest
# note). You have access to the variables errors warning, statement which
# respectively contain the number of errors / warnings messages and the total
# number of statements analyzed. This is used by the global evaluation report
# (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)


[VARIABLES]

# Tells whether we should check for unused import in __init__ files.
init-import=no

# A regular expression matching the beginning of the name of dummy variables
# (i.e. not used).
dummy-variables-rgx=_|dummy

# List of additional names supposed to be defined in builtins. Remember that
# you should avoid to define new builtins when possible.
additional-builtins=


[TYPECHECK]

# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes

# List of classes names for which member attributes should not be checked
# (useful for classes with attributes dynamically set).
ignored-classes=SQLObject,twisted.internet.reactor,hashlib,google.appengine.api.memcache

# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E0201 when accessed. Python regular
# expressions are accepted.
generated-members=REQUEST,acl_users,aq_parent,multiprocessing.managers.SyncManager


[MISCELLANEOUS]

# List of note tags to take in consideration, separated by a comma.
notes=FIXME,XXX,TODO


[SIMILARITIES]

# Minimum lines number of a similarity.
min-similarity-lines=10

# Ignore comments when computing similarities.
ignore-comments=yes

# Ignore docstrings when computing similarities.
ignore-docstrings=yes


[FORMAT]

# Maximum number of characters on a single line.
# yapf is configured (in .style.yapf) to format to a line length of 80, but
# sometimes it is not successful if a comment or string literal isn't already
# well-formatted. Therefore, we use pylint to put a hard limit somewhere
# further out at a point where manual formatting should be done.
max-line-length=100

# Maximum number of lines in a module
max-module-lines=1000

# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
# CHANGED:
indent-string=' '


[BASIC]

# List of builtins function names that should not be used, separated by a comma
bad-functions=map,filter,apply,input

# Regular expression which should only match correct module names
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$

# Regular expression which should only match correct module level names
const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$

# Regular expression which should only match correct class names
class-rgx=[A-Z_][a-zA-Z0-9]+$

# Regular expression which should only match correct function names
function-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct method names
method-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct instance attribute names
attr-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct argument names
argument-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct variable names
variable-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct list comprehension /
# generator expression variable names
inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$

# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,ex,Run,_

# Bad variable names which should always be refused, separated by a comma
bad-names=foo,bar,baz,toto,tutu,tata

# Regular expression which should only match functions or classes name which do
# not require a docstring
no-docstring-rgx=__.*__


[DESIGN]

# Maximum number of arguments for function / method
max-args=5

# Argument names that match this expression will be ignored. Default to name
# with leading underscore
ignored-argument-names=_.*

# Maximum number of locals for function / method body
max-locals=25

# Maximum number of return / yield for function / method body
max-returns=6

# Maximum number of branch for function / method body
max-branchs=12

# Maximum number of statements in function / method body
max-statements=50

# Maximum number of parents for a class (see R0901).
max-parents=7

# Maximum number of attributes for a class (see R0902).
max-attributes=7

# Minimum number of public methods for a class (see R0903).
min-public-methods=2

# Maximum number of public methods for a class (see R0904).
max-public-methods=20


[CLASSES]

# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,__new__,setUp

# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls


[IMPORTS]

# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec

# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled)
import-graph=

# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled)
ext-import-graph=

# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled)
int-import-graph=


[EXCEPTIONS]

# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception
29 changes: 15 additions & 14 deletions build/copy_info_plist.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,34 @@
Precondition: $CWD/../../flutter is the path to the flutter engine repo.
usage: copy_info_plist.py --source <src_path> --destination <dest_path> --bitcode --minversion=<deployment_target>
usage: copy_info_plist.py --source <src_path> --destination <dest_path>
--bitcode --minversion=<deployment_target>
"""

import argparse
import os
import subprocess

import argparse
import sys
import git_revision
import os


def GetClangVersion(bitcode):
def get_clang_version(bitcode):
clang_executable = str(
os.path.join(
"..", "..", "buildtools", "mac-x64", "clang", "bin", "clang++"
'..', '..', 'buildtools', 'mac-x64', 'clang', 'bin', 'clang++'
)
)
if bitcode:
clang_executable = "clang++"
version = subprocess.check_output([clang_executable, "--version"])
clang_executable = 'clang++'
version = subprocess.check_output([clang_executable, '--version'])
return version.splitlines()[0]


def main():

parser = argparse.ArgumentParser(
description='Copies the Info.plist and adds extra fields to it like the git hash of the engine'
description='Copies the Info.plist and adds extra fields to it like the '
'git hash of the engine'
)

parser.add_argument(
Expand All @@ -61,19 +62,19 @@ def main():
args = parser.parse_args()

text = open(args.source).read()
engine_path = os.path.join(os.getcwd(), "..", "..", "flutter")
revision = git_revision.GetRepositoryVersion(engine_path)
engine_path = os.path.join(os.getcwd(), '..', '..', 'flutter')
revision = git_revision.get_repository_version(engine_path)
bitcode = args.bitcode is not None
clang_version = GetClangVersion(bitcode)
clang_version = get_clang_version(bitcode)
text = text.format(
revision=revision,
clang_version=clang_version,
min_version=args.minversion
)

with open(args.destination, "w") as outfile:
with open(args.destination, 'w') as outfile:
outfile.write(text)


if __name__ == "__main__":
if __name__ == '__main__':
main()
25 changes: 12 additions & 13 deletions build/dart/tools/dart_package_name.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,20 @@
"""This script outputs the package name specified in the pubspec.yaml"""

import argparse
import os
import sys


# TODO(johnmccutchan): Use the yaml package to parse.
def PackageName(line):
assert line.startswith("name:")
return line.split(":")[1].strip()
def package_name(line):
assert line.startswith('name:')
return line.split(':')[1].strip()


def main(pubspec_file):
source_file = open(pubspec_file, "r")
source_file = open(pubspec_file, 'r')
for line in source_file:
if line.startswith("name:"):
print(PackageName(line))
if line.startswith('name:'):
print(package_name(line))
return 0
source_file.close()
# Couldn't find it.
Expand All @@ -30,16 +29,16 @@ def main(pubspec_file):

if __name__ == '__main__':
parser = argparse.ArgumentParser(
description="This script outputs the package name specified in the"
"pubspec.yaml"
description='This script outputs the package name specified in the '
'pubspec.yaml'
)
parser.add_argument(
"--pubspec",
dest="pubspec_file",
metavar="<pubspec-file>",
'--pubspec',
dest='pubspec_file',
metavar='<pubspec-file>',
type=str,
required=True,
help="Path to pubspec file"
help='Path to pubspec file'
)
args = parser.parse_args()
sys.exit(main(args.pubspec_file))
Loading

0 comments on commit 2f0b7f9

Please sign in to comment.