tequilaOS/platform_build_soong
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix pylint issues in gen_stub_libs.

Browse source 
Test: pylint scriptlib
Bug: None
Change-Id: I7fc9d55a033bab98c318cfb4db1af4eda7187af3
This commit is contained in:
Dan Albert 2020-06-22 15:59:12 -07:00
parent 21143a601c
commit 802cc82af6
3 changed files with 87 additions and 338 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

271
cc/pylintrc
View file

@ -1,280 +1,11 @@
[MASTER]
# Specify a configuration file.
#rcfile=
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
# Profiled execution.
profile=no
# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=CVS
# 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=
[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. See also the "--disable" option for examples.
#enable=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
# file where it should appear only once).You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
disable=design,fixme
[REPORTS]
# Set the output format. Available formats are text, parseable, colorized, msvs
# (visual studio) and html. You can also give a reporter class, eg
# mypackage.mymodule.MyReporterClass.
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
reports=yes
# 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)
# Add a comment according to your evaluation note. This is used by the global
# evaluation report (RP0004).
comment=no
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details
#msg-template=
[BASIC]
# Required attributes for module, separated by a comma
required-attributes=
# 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 attribute names in class
# bodies
class-attribute-rgx=([A-Za-z_][A-Za-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 function or class names that do
# not require a docstring.
no-docstring-rgx=__.*__
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
[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
# When zope mode is activated, add a predefined set of Zope acquired attributes
# to generated-members.
zope=no
# 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
[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=4
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
# Ignore imports when computing similarities.
ignore-imports=no
ignore-imports=yes
[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=
[FORMAT]
# Maximum number of characters on a single line.
max-line-length=80
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
# List of optional constructs for which whitespace checking is disabled
no-space-check=trailing-comma,dict-separator
# 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).
indent-string=' '
[IMPORTS]
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,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=
[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=15
# Maximum number of return / yield for function / method body
max-returns=6
# Maximum number of branch for function / method body
max-branches=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 interface methods to ignore, separated by a comma. This is used for
# instance to not check methods defines in Zope's Interface base class.
ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
# 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
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=mcs
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception

24
cc/scriptlib/gen_stub_libs.py
View file

@ -118,7 +118,8 @@ def should_omit_version(version, arch, api, llndk, apex):
if 'platform-only' in version.tags:
return True
no_llndk_no_apex = 'llndk' not in version.tags and 'apex' not in version.tags
no_llndk_no_apex = ('llndk' not in version.tags
and 'apex' not in version.tags)
keep = no_llndk_no_apex or \
('llndk' in version.tags and llndk) or \
('apex' in version.tags and apex)
@ -205,7 +206,6 @@ def symbol_versioned_in_api(tags, api):
class ParseError(RuntimeError):
"""An error that occurred while parsing a symbol file."""
pass
class MultiplyDefinedSymbolError(RuntimeError):
@ -217,7 +217,7 @@ class MultiplyDefinedSymbolError(RuntimeError):
self.multiply_defined_symbols = multiply_defined_symbols
class Version(object):
class Version:
"""A version block of a symbol file."""
def __init__(self, name, base, tags, symbols):
self.name = name
@ -237,7 +237,7 @@ class Version(object):
return True
class Symbol(object):
class Symbol:
"""A symbol definition from a symbol file."""
def __init__(self, name, tags):
self.name = name
@ -247,7 +247,7 @@ class Symbol(object):
return self.name == other.name and set(self.tags) == set(other.tags)
class SymbolFileParser(object):
class SymbolFileParser:
"""Parses NDK symbol files."""
def __init__(self, input_file, api_map, arch, api, llndk, apex):
self.input_file = input_file
@ -283,11 +283,13 @@ class SymbolFileParser(object):
symbol_names = set()
multiply_defined_symbols = set()
for version in versions:
if should_omit_version(version, self.arch, self.api, self.llndk, self.apex):
if should_omit_version(version, self.arch, self.api, self.llndk,
self.apex):
continue
for symbol in version.symbols:
if should_omit_symbol(symbol, self.arch, self.api, self.llndk, self.apex):
if should_omit_symbol(symbol, self.arch, self.api, self.llndk,
self.apex):
continue
if symbol.name in symbol_names:
@ -369,7 +371,7 @@ class SymbolFileParser(object):
return self.current_line
class Generator(object):
class Generator:
"""Output generator that writes stub source files and version scripts."""
def __init__(self, src_file, version_script, arch, api, llndk, apex):
self.src_file = src_file
@ -386,14 +388,16 @@ class Generator(object):
def write_version(self, version):
"""Writes a single version block's data to the output files."""
if should_omit_version(version, self.arch, self.api, self.llndk, self.apex):
if should_omit_version(version, self.arch, self.api, self.llndk,
self.apex):
return
section_versioned = symbol_versioned_in_api(version.tags, self.api)
version_empty = True
pruned_symbols = []
for symbol in version.symbols:
if should_omit_symbol(symbol, self.arch, self.api, self.llndk, self.apex):
if should_omit_symbol(symbol, self.arch, self.api, self.llndk,
self.apex):
continue
if symbol_versioned_in_api(symbol.tags, self.api):

130
cc/scriptlib/test_gen_stub_libs.py
View file

@ -22,6 +22,7 @@ import unittest
import gen_stub_libs as gsl
# pylint: disable=missing-docstring
@ -164,15 +165,15 @@ class SymbolPresenceTest(unittest.TestCase):
class OmitVersionTest(unittest.TestCase):
def test_omit_private(self):
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, [], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, [], []), 'arm', 9,
False, False))
self.assertTrue(
gsl.should_omit_version(
gsl.Version('foo_PRIVATE', None, [], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo_PRIVATE', None, [], []),
'arm', 9, False, False))
self.assertTrue(
gsl.should_omit_version(
gsl.Version('foo_PLATFORM', None, [], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo_PLATFORM', None, [], []),
'arm', 9, False, False))
self.assertTrue(
gsl.should_omit_version(
@ -181,44 +182,44 @@ class OmitVersionTest(unittest.TestCase):
def test_omit_llndk(self):
self.assertTrue(
gsl.should_omit_version(
gsl.Version('foo', None, ['llndk'], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, ['llndk'], []),
'arm', 9, False, False))
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, [], []), 'arm', 9, True, False))
gsl.should_omit_version(gsl.Version('foo', None, [], []), 'arm', 9,
True, False))
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, ['llndk'], []), 'arm', 9, True, False))
gsl.should_omit_version(gsl.Version('foo', None, ['llndk'], []),
'arm', 9, True, False))
def test_omit_apex(self):
self.assertTrue(
gsl.should_omit_version(
gsl.Version('foo', None, ['apex'], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, ['apex'], []),
'arm', 9, False, False))
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, [], []), 'arm', 9, False, True))
gsl.should_omit_version(gsl.Version('foo', None, [], []), 'arm', 9,
False, True))
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, ['apex'], []), 'arm', 9, False, True))
gsl.should_omit_version(gsl.Version('foo', None, ['apex'], []),
'arm', 9, False, True))
def test_omit_arch(self):
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, [], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, [], []), 'arm', 9,
False, False))
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, ['arm'], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, ['arm'], []),
'arm', 9, False, False))
self.assertTrue(
gsl.should_omit_version(
gsl.Version('foo', None, ['x86'], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, ['x86'], []),
'arm', 9, False, False))
def test_omit_api(self):
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, [], []), 'arm', 9, False, False))
gsl.should_omit_version(gsl.Version('foo', None, [], []), 'arm', 9,
False, False))
self.assertFalse(
gsl.should_omit_version(
gsl.Version('foo', None, ['introduced=9'], []), 'arm', 9,
@ -233,47 +234,51 @@ class OmitVersionTest(unittest.TestCase):
class OmitSymbolTest(unittest.TestCase):
def test_omit_llndk(self):
self.assertTrue(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['llndk']), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['llndk']), 'arm', 9,
False, False))
self.assertFalse(
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, True, False))
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, True,
False))
self.assertFalse(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['llndk']), 'arm', 9, True, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['llndk']), 'arm', 9,
True, False))
def test_omit_apex(self):
self.assertTrue(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['apex']), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['apex']), 'arm', 9,
False, False))
self.assertFalse(
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, False, True))
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, False,
True))
self.assertFalse(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['apex']), 'arm', 9, False, True))
gsl.should_omit_symbol(gsl.Symbol('foo', ['apex']), 'arm', 9,
False, True))
def test_omit_arch(self):
self.assertFalse(
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, False,
False))
self.assertFalse(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['arm']), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['arm']), 'arm', 9, False,
False))
self.assertTrue(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['x86']), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['x86']), 'arm', 9, False,
False))
def test_omit_api(self):
self.assertFalse(
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', []), 'arm', 9, False,
False))
self.assertFalse(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['introduced=9']), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['introduced=9']), 'arm',
9, False, False))
self.assertTrue(
gsl.should_omit_symbol(
gsl.Symbol('foo', ['introduced=14']), 'arm', 9, False, False))
gsl.should_omit_symbol(gsl.Symbol('foo', ['introduced=14']), 'arm',
9, False, False))
class SymbolFileParseTest(unittest.TestCase):
@ -404,7 +409,8 @@ class SymbolFileParseTest(unittest.TestCase):
def test_parse_fails_invalid_input(self):
with self.assertRaises(gsl.ParseError):
input_file = io.StringIO('foo')
parser = gsl.SymbolFileParser(input_file, {}, 'arm', 16, False, False)
parser = gsl.SymbolFileParser(input_file, {}, 'arm', 16, False,
False)
parser.parse()
def test_parse(self):
@ -472,7 +478,8 @@ class GeneratorTest(unittest.TestCase):
# OmitVersionTest, PrivateVersionTest, and SymbolPresenceTest.
src_file = io.StringIO()
version_file = io.StringIO()
generator = gsl.Generator(src_file, version_file, 'arm', 9, False, False)
generator = gsl.Generator(src_file, version_file, 'arm', 9, False,
False)
version = gsl.Version('VERSION_PRIVATE', None, [], [
gsl.Symbol('foo', []),
@ -500,7 +507,8 @@ class GeneratorTest(unittest.TestCase):
# SymbolPresenceTest.
src_file = io.StringIO()
version_file = io.StringIO()
generator = gsl.Generator(src_file, version_file, 'arm', 9, False, False)
generator = gsl.Generator(src_file, version_file, 'arm', 9, False,
False)
version = gsl.Version('VERSION_1', None, [], [
gsl.Symbol('foo', ['x86']),
@ -533,7 +541,8 @@ class GeneratorTest(unittest.TestCase):
def test_write(self):
src_file = io.StringIO()
version_file = io.StringIO()
generator = gsl.Generator(src_file, version_file, 'arm', 9, False, False)
generator = gsl.Generator(src_file, version_file, 'arm', 9, False,
False)
versions = [
gsl.Version('VERSION_1', None, [], [
@ -615,12 +624,14 @@ class IntegrationTest(unittest.TestCase):
wobble;
} VERSION_4;
"""))
parser = gsl.SymbolFileParser(input_file, api_map, 'arm', 9, False, False)
parser = gsl.SymbolFileParser(input_file, api_map, 'arm', 9, False,
False)
versions = parser.parse()
src_file = io.StringIO()
version_file = io.StringIO()
generator = gsl.Generator(src_file, version_file, 'arm', 9, False, False)
generator = gsl.Generator(src_file, version_file, 'arm', 9, False,
False)
generator.write(versions)
expected_src = textwrap.dedent("""\
@ -665,12 +676,14 @@ class IntegrationTest(unittest.TestCase):
*;
};
"""))
parser = gsl.SymbolFileParser(input_file, api_map, 'arm', 9001, False, False)
parser = gsl.SymbolFileParser(input_file, api_map, 'arm', 9001, False,
False)
versions = parser.parse()
src_file = io.StringIO()
version_file = io.StringIO()
generator = gsl.Generator(src_file, version_file, 'arm', 9001, False, False)
generator = gsl.Generator(src_file, version_file, 'arm', 9001, False,
False)
generator.write(versions)
expected_src = textwrap.dedent("""\
@ -715,10 +728,10 @@ class IntegrationTest(unittest.TestCase):
"""))
parser = gsl.SymbolFileParser(input_file, {}, 'arm', 16, False, False)
with self.assertRaises(gsl.MultiplyDefinedSymbolError) as cm:
with self.assertRaises(gsl.MultiplyDefinedSymbolError) as ex_context:
parser.parse()
self.assertEquals(['bar', 'foo'],
cm.exception.multiply_defined_symbols)
self.assertEqual(['bar', 'foo'],
ex_context.exception.multiply_defined_symbols)
def test_integration_with_apex(self):
api_map = {
@ -759,7 +772,8 @@ class IntegrationTest(unittest.TestCase):
wobble;
} VERSION_4;
"""))
parser = gsl.SymbolFileParser(input_file, api_map, 'arm', 9, False, True)
parser = gsl.SymbolFileParser(input_file, api_map, 'arm', 9, False,
True)
versions = parser.parse()
src_file = io.StringIO()