diff --git a/README.md b/README.md index ca1f248..093def0 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,8 @@ You can also use the [older version](https://github.com/serizba/cppflow/tree/243 ## Style guide We use the [Google's C++ style guide](https://google.github.io/styleguide/cppguide.html) using static code linker [cpplint](https://github.com/cpplint/cpplint). +We use the [Google's Python style guide](https://google.github.io/styleguide/pyguide.html) using static code linker [pylint](https://pylint.pycqa.org/en/latest/user_guide/installation/index.html) using attached pylintrc configuration. + ## Remark diff --git a/examples/efficientnet/create_model.py b/examples/efficientnet/create_model.py index e372622..e0b0887 100644 --- a/examples/efficientnet/create_model.py +++ b/examples/efficientnet/create_model.py @@ -1,4 +1,7 @@ #!/usr/bin/env python +""" + Example for create model functionality. +""" # MIT License # diff --git a/examples/load_frozen_graph/create_model.py b/examples/load_frozen_graph/create_model.py index 80d38dd..c59a384 100644 --- a/examples/load_frozen_graph/create_model.py +++ b/examples/load_frozen_graph/create_model.py @@ -1,4 +1,7 @@ #!/usr/bin/env python +""" + Example for a load frozen tf graph functionality. +""" # MIT License # @@ -41,10 +44,10 @@ convert_variables_to_constants_v2, ) -input = tf.keras.Input(shape=(5,)) -output = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input) -output = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid)(output) -model = tf.keras.Model(inputs=input, outputs=output) +input_1 = tf.keras.Input(shape=(5,)) +output_1 = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input_1) +output_1 = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid)(output_1) +model = tf.keras.Model(inputs=input_1, outputs=output_1) # Create frozen graph x = tf.TensorSpec(model.input_shape, tf.float32, name="x") diff --git a/examples/load_model/create_model.py b/examples/load_model/create_model.py index 091091f..96eb8df 100644 --- a/examples/load_model/create_model.py +++ b/examples/load_model/create_model.py @@ -1,4 +1,7 @@ #!/usr/bin/env python +""" + Example for a load model functionality. +""" # MIT License # @@ -33,13 +36,12 @@ # Imports import tensorflow as tf -import numpy as np -input = tf.keras.Input(shape=(5,)) +input_1 = tf.keras.Input(shape=(5,)) -output = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input) -output = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid)(output) -model = tf.keras.Model(inputs=input, outputs=output) +output_1 = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input_1) +output_1 = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid)(output_1) +model = tf.keras.Model(inputs=input_1, outputs=output_1) model.compile() diff --git a/examples/load_model/main.cpp b/examples/load_model/main.cpp index 5d9af8d..81031b5 100644 --- a/examples/load_model/main.cpp +++ b/examples/load_model/main.cpp @@ -25,8 +25,6 @@ /*! * @file main.cpp - * @brief A brief description here. - * @details Define custom details for the file here. * @author Afaq Sabir * @author Florian * @author Paul Nykiel diff --git a/examples/multi_input_output/create_model.py b/examples/multi_input_output/create_model.py index ac72d78..d93cc8d 100644 --- a/examples/multi_input_output/create_model.py +++ b/examples/multi_input_output/create_model.py @@ -1,4 +1,7 @@ #!/usr/bin/env python +""" + Example for a multiple inputs and outputs functionality. +""" # MIT License # @@ -33,7 +36,6 @@ # Imports import tensorflow as tf -import numpy as np input_1 = tf.keras.Input(shape=(5,), name='my_input_1') input_2 = tf.keras.Input(shape=(5,), name='my_input_2') @@ -41,8 +43,10 @@ x1 = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input_1) x2 = tf.keras.layers.Dense(5, activation=tf.nn.relu)(input_2) -output_1 = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid, name='my_outputs_1')(x1) -output_2 = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid, name='my_outputs_2')(x2) +output_1 = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid, + name='my_outputs_1')(x1) +output_2 = tf.keras.layers.Dense(1, activation=tf.nn.sigmoid, + name='my_outputs_2')(x2) model = tf.keras.Model(inputs=[input_1, input_2], outputs=[output_1, output_2]) diff --git a/include/cppflow/model.h b/include/cppflow/model.h index 6db34f2..368e145 100644 --- a/include/cppflow/model.h +++ b/include/cppflow/model.h @@ -26,7 +26,7 @@ // SOFTWARE. /*! - * @file cppflow.h + * @file model.h * @author Jiannan Liu * @author liufeng27 * @author Paul diff --git a/include/cppflow/ops.h b/include/cppflow/ops.h index 98f0b54..d7fbe95 100644 --- a/include/cppflow/ops.h +++ b/include/cppflow/ops.h @@ -22,7 +22,7 @@ // SOFTWARE. /*! - * @file context.h + * @file ops.h * @author Jiannan Liu * @author Sergio Izquierdo * @date @showdate "%B %d, %Y" 2020-07-31 diff --git a/include/cppflow/ops_generator/generator.py b/include/cppflow/ops_generator/generator.py index e895eda..8d86ff6 100644 --- a/include/cppflow/ops_generator/generator.py +++ b/include/cppflow/ops_generator/generator.py @@ -1,3 +1,39 @@ +#!/usr/bin/env python +""" + Generates the raw_ops.h cpp code. +""" + +# MIT License +# +# Copyright (c) 2020 Sergio Izquierdo +# Copyright (c) 2020 Jiannan Liu +# Copyright (c) 2022 Alfredo Rodriguez +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +## +# @file generator.py +# @author Alfredo Rodriguez +# @author Jiannan Liu +# @author Sergio Izquierdo +# @date @showdate "%B %d, %Y" 2020-09-16 + import tensorflow as tf from tensorflow.core.framework import op_def_pb2 from google.protobuf import text_format @@ -10,21 +46,40 @@ class Attribute: + """Class that describes the attribute. + + Attributes: + attr: An attribute. + name: The attribute's name. + type: The attribute's type. + islist: Whether a list attributes. + number_attr: Number of attributes + default: The attribute's default value. + """ + def __init__(self, attr, number_attr_list): self.attr = attr self.name = self.attr.name - if self.attr.type == "func": raise Exception("Passing functions as arguments is not yet supported") + if self.attr.type == 'func': + raise Exception('Passing functions as arguments is ' + 'not yet supported') # List attributes are defined as 'list(attr)'' - self.type, self.islist = (self.attr.type, False) if self.attr.type[:4] != 'list' else (self.attr.type[5:-1], True) + self.type, self.islist = ((self.attr.type, False) + if self.attr.type[:4] != 'list' + else (self.attr.type[5:-1], True)) self.number_attr = [i for n, i in number_attr_list if self.name == n] - self.number_attr, self.type = (self.number_attr[0].name, 'n_attr') if len(self.number_attr) else (None, self.type) + self.number_attr, self.type = ((self.number_attr[0].name, 'n_attr') + if len(self.number_attr) + else (None, self.type)) - self.default = bool(len(self.attr.default_value.ListFields())) and not self.islist and self.type not in ['shape', 'tensor'] + self.default = (bool(len(self.attr.default_value.ListFields())) and + not self.islist and + self.type not in ['shape', 'tensor']) def declaration(self): @@ -48,25 +103,31 @@ def declaration(self): # Warp list attributes in a C++ vector if self.islist: cpptype = cpptype.replace('&', '') # Not inner reference types - cpptype = 'const std::vector<{}>&'.format(cpptype.replace('const', '')) + cpptype = ('const std::vector<{}>&' + .format(cpptype.replace('const', ''))) # Get the default value for the attribute # Not yet supported for lists # Not supported for tensors or shape - if self.default and not self.islist and self.type not in ['shape', 'tensor']: + if (self.default and not self.islist and + self.type not in ['shape', 'tensor']): cppdefault = '=' + { 'int' : str(self.attr.default_value.i), 'bool' : str(self.attr.default_value.b).lower(), 'string' : '"' + str(self.attr.default_value.s)[2:-1] + '"', - 'float' : '{:.4e}'.format(self.attr.default_value.f).replace('inf', 'std::numeric_limits::infinity()'), - 'type' : 'static_cast({})'.format(self.attr.default_value.type) + 'float' : ('{:.4e}'.format(self.attr.default_value.f) + .replace('inf', + 'std::numeric_limits::infinity()')), + 'type' : ('static_cast({})' + .format(self.attr.default_value.type)) }[self.type] else: cppdefault = '' # datatype name=defaultval - return cpptype + ' ' + self.name.replace('template', 'template_arg') + cppdefault + return (cpptype + ' ' + self.name.replace('template', 'template_arg') + + cppdefault) def code(self): @@ -92,10 +153,11 @@ def code(self): TFE_OpSetAttrShapeList(op.get(), "{orig:}", {0}_values.data(), {0}_ndims.data(), static_cast({0}.size()), context::get_status()); status_check(context::get_status()); ''', - }[self.type].format(self.name.replace('template', 'template_arg'), orig=self.name)).replace('\n', '\n ') + }[self.type].format(self.name.replace('template', 'template_arg'), + orig=self.name)).replace('\n', '\n ') else: - return textwrap.dedent({ + return (textwrap.dedent({ 'shape' : ''' TFE_OpSetAttrShape(op.get(), "{orig:}", {0}.data(), static_cast({0}.size()), context::get_status()); status_check(context::get_status()); @@ -103,7 +165,7 @@ def code(self): 'int' : 'TFE_OpSetAttrInt(op.get(), "{orig:}", {0});', 'float' : 'TFE_OpSetAttrFloat(op.get(), "{orig:}", {0});', 'string': 'TFE_OpSetAttrString(op.get(), "{orig:}", (void*) {0}.c_str(), {0}.size());', - 'type' : 'TFE_OpSetAttrType(op.get(), "{orig:}", {0});', + 'type' : 'TFE_OpSetAttrType(op.get(), "{orig:}", {0});', 'bool' : 'TFE_OpSetAttrBool(op.get(), "{orig:}", (unsigned char){0});', 'tensor': ''' TFE_OpSetAttrTensor(op.get(), "{orig:}", {0}.get_tensor().get(), context::get_status()); @@ -111,7 +173,9 @@ def code(self): ''', 'n_attr': 'TFE_OpSetAttrInt(op.get(), "{orig:}", {n_attr:}.size());' - }[self.type].format(self.name.replace('template', 'template_arg'), orig=self.name, n_attr=self.number_attr)).replace('\n', '\n ') + }[self.type].format(self.name.replace('template', 'template_arg'), + orig=self.name, n_attr=self.number_attr)) + .replace('\n', '\n ')) @@ -119,22 +183,33 @@ def code(self): class Operation: + """Class that describes the operation. + Attributes: + op: An operation. + inputs: The operation's inputs. + attr_list: The attribute's list. + """ def __init__(self, op): self.op = op # More than one output? - if len(self.op.output_arg) != 1: raise Exception("More than one or no output not yet supported") + if len(self.op.output_arg) != 1: + raise Exception('More than one or no output not yet supported') self.inputs = [inp for inp in op.input_arg] # Number attributes define the length of an input list - number_attr = [(i.number_attr, i) for i in self.inputs if len(i.number_attr) > 0] + number_attr = [ + (i.number_attr, i) for i in self.inputs if len(i.number_attr) > 0 + ] # Attributes - self.attr_list = sorted([Attribute(a, number_attr) for a in self.op.attr], key=lambda a: a.default) + self.attr_list = sorted([ + Attribute(a, number_attr) for a in self.op.attr + ], key=lambda a: a.default) def code(self): @@ -147,7 +222,7 @@ def code(self): // Define Op std::unique_ptr op(TFE_NewOp(context::get_context(), "{}", context::get_status()), &TFE_DeleteOp); status_check(context::get_status()); - + // Required input arguments {} @@ -180,58 +255,97 @@ def code(self): out = 'tensor' if len(self.op.output_arg) else 'void' # snake_case name of the operation - snk = re.sub(r'(?&{}'.format(n.name) if len(n.number_attr) or len(n.type_list_attr) else - 'const tensor& {}'.format(n.name.replace('tensor', 'input_tensor')) for i, n in enumerate(self.inputs)]) + inp = ', '.join([ + 'const std::vector&{}'.format(n.name) + if len(n.number_attr) or len(n.type_list_attr) + else 'const tensor& {}'.format(n.name.replace('tensor', + 'input_tensor')) + for i, n in enumerate(self.inputs) + ]) # Declaration of attributes - atr = ', '.join(a.declaration() for a in self.attr_list if len(a.declaration())) + atr = ', '.join(a.declaration() for a in self.attr_list + if len(a.declaration())) atr = (', ' + atr) if inp != '' and atr != '' else atr # Operation original name opn = self.op.name # Code for input arguments - inp_code = '\n '.join(add_inputs_list.format(n.name) if len(n.number_attr) or len(n.type_list_attr) else - add_inputs.format(n.name.replace('tensor', 'input_tensor')) for n in self.inputs) + inp_code = '\n '.join(add_inputs_list.format(n.name) + if len(n.number_attr) or len(n.type_list_attr) + else add_inputs.format(n.name.replace('tensor', 'input_tensor')) + for n in self.inputs) # Code for attributes - atr_code = '\n '.join(a.code() for a in self.attr_list if len(a.code())) + atr_code = '\n '.join(a.code() for a in self.attr_list + if len(a.code())) return template.format('', out, snk, inp, atr, opn, inp_code, atr_code) ops_file = textwrap.dedent(''' +// MIT License +// +// Copyright (c) 2020 Sergio Izquierdo +// Copyright (c) 2020 Jiannan Liu +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. + /** - * @file ops.h - * TensorFlow raw_ops mappings + * @file raw_ops.h + * @brief TensorFlow raw_ops mappings + * THIS FILE IS AUTOGENERATED - TO UPDATE USE "generator.py" + * @author Jiannan Liu + * @author Sergio Izquierdo */ -#ifndef CPPFLOW2_RAW_OPS_H -#define CPPFLOW2_RAW_OPS_H +#ifndef INCLUDE_CPPFLOW_RAW_OPS_H_ +#define INCLUDE_CPPFLOW_RAW_OPS_H_ +// C headers +#include +#include +#include + +// C++ headers #include #include #include #include -#include -#include -#include - -#include "tensor.h" -#include "datatype.h" +// CppFlow headers +#include "cppflow/tensor.h" +#include "cppflow/datatype.h" namespace cppflow {{ {} -}} // cppflow +}} // namespace cppflow -#endif +#endif // INCLUDE_CPPFLOW_RAW_OPS_H_ ''') @@ -243,7 +357,7 @@ def code(self): # All TF C API operations correspond with tf.raw_ops for op_name in sorted(dir(tf.raw_ops)): - if not op_name.startswith("_"): + if not op_name.startswith('_'): num_ops += 1 #if num_ops == 51: @@ -253,8 +367,8 @@ def code(self): # Grab operation definition op = [op for op in ops.op if op.name == op_name] - if len(op) == 0: raise Exception("Operation not found") - + if len(op) == 0: raise Exception('Operation not found') + op = Operation(op[0]) ops_code += op.code() diff --git a/include/cppflow/tensor.h b/include/cppflow/tensor.h index 96618c7..51cd940 100644 --- a/include/cppflow/tensor.h +++ b/include/cppflow/tensor.h @@ -25,7 +25,7 @@ // SOFTWARE. /*! - * @file context.h + * @file tensor.h * @author Alfredo Rodriguez * @author CarlPoirier * @author Jiannan Liu diff --git a/pylintrc b/pylintrc new file mode 100644 index 0000000..f1fde7c --- /dev/null +++ b/pylintrc @@ -0,0 +1,428 @@ +# This Pylint rcfile contains a best-effort configuration to uphold the +# best-practices and style described in the Google Python style guide: +# https://google.github.io/styleguide/pyguide.html +# +# Its canonical open-source location is: +# https://google.github.io/styleguide/pylintrc + +[MASTER] + +# Files or directories to be skipped. They should be base names, not paths. +ignore=third_party + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Pickle collected data for later comparisons. +persistent=no + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Use multiple processes to speed up Pylint. +jobs=4 + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# 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 (only on the command line, not in the configuration file where +# it should appear only once). 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=abstract-method, + apply-builtin, + arguments-differ, + attribute-defined-outside-init, + backtick, + bad-option-value, + basestring-builtin, + buffer-builtin, + c-extension-no-member, + consider-using-enumerate, + cmp-builtin, + cmp-method, + coerce-builtin, + coerce-method, + delslice-method, + div-method, + duplicate-code, + eq-without-hash, + execfile-builtin, + file-builtin, + filter-builtin-not-iterating, + fixme, + getslice-method, + global-statement, + hex-method, + idiv-method, + implicit-str-concat, + import-error, + import-self, + import-star-module-level, + inconsistent-return-statements, + input-builtin, + intern-builtin, + invalid-str-codec, + locally-disabled, + long-builtin, + long-suffix, + map-builtin-not-iterating, + misplaced-comparison-constant, + missing-function-docstring, + metaclass-assignment, + next-method-called, + next-method-defined, + no-absolute-import, + no-else-break, + no-else-continue, + no-else-raise, + no-else-return, + no-init, # added + no-member, + no-name-in-module, + no-self-use, + nonzero-method, + oct-method, + old-division, + old-ne-operator, + old-octal-literal, + old-raise-syntax, + parameter-unpacking, + print-statement, + raising-string, + range-builtin-not-iterating, + raw_input-builtin, + rdiv-method, + reduce-builtin, + relative-import, + reload-builtin, + round-builtin, + setslice-method, + signature-differs, + standarderror-builtin, + suppressed-message, + sys-max-int, + too-few-public-methods, + too-many-ancestors, + too-many-arguments, + too-many-boolean-expressions, + too-many-branches, + too-many-instance-attributes, + too-many-locals, + too-many-nested-blocks, + too-many-public-methods, + too-many-return-statements, + too-many-statements, + trailing-newlines, + unichr-builtin, + unicode-builtin, + unnecessary-pass, + unpacking-in-except, + useless-else-on-loop, + useless-object-inheritance, + useless-suppression, + using-cmp-argument, + wrong-import-order, + xrange-builtin, + zip-builtin-not-iterating, + + +[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 + +# Tells whether to display a full report or only the messages +reports=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) + +# 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] + +# Good variable names which should always be accepted, separated by a comma +good-names=main,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl + +# Regular expression matching correct function names +function-rgx=^(?:(?PsetUp|tearDown|setUpModule|tearDownModule)|(?P_?[A-Z][a-zA-Z0-9]*)|(?P_?[a-z][a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct constant names +const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression matching correct attribute names +attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ + +# Regular expression matching correct argument names +argument-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct class names +class-rgx=^_?[A-Z][a-zA-Z0-9]*$ + +# Regular expression matching correct module names +module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$ + +# Regular expression matching correct method names +method-rgx=(?x)^(?:(?P_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P_{0,2}[a-z][a-z0-9_]*))$ + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=10 + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager + +# 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 module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=80 + +# TODO(https://github.com/PyCQA/pylint/issues/3352): Direct pylint to exempt +# lines made too long by directives to pytype. + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=(?x)( + ^\s*(\#\ )??$| + ^\s*(from\s+\S+\s+)?import\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=yes + +# Maximum number of lines in a module +max-module-lines=99999 + +# String used as indentation unit. The internal Google style guide mandates 2 +# spaces. Google's externaly-published style guide says 4, consistent with +# PEP 8. +indent-string=' ' + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=TODO + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=yes + + +[VARIABLES] + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging,absl.logging,tensorflow.io.logging + + +[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 + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub, + TERMIOS, + Bastion, + rexec, + sets + +# 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= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant, absl + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls, + class_ + +# 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=StandardError, + Exception, + BaseException