From 08b563cb3dd4407465c6f4b996ca0bd6167b87db Mon Sep 17 00:00:00 2001 From: Graeme Watt Date: Thu, 28 Mar 2024 21:34:27 +0000 Subject: [PATCH 1/3] Remove pin on Pylint to support Python 3.11 * pylintrc and tests/pylintrc generated with Pylint 3.1.0 by running "pylint --generate-rcfile" in a Python 3.11 virtual environment. * Tweaked code and "pylintrc" files so that Pylint checks all pass. * Add Python 3.11 and ROOT 6.30 to matrix in tests.yml. * Skip Pylint step in CI for Python 3.6 and Python 3.7. * ROOT binary built with Python 3.12 not yet supported by Micromamba. * Closes #234. --- .github/workflows/tests.yml | 20 +- docs/dev.rst | 3 +- hepdata_lib/c_file_reader.py | 5 - hepdata_lib/helpers.py | 16 +- hepdata_lib/root_utils.py | 4 +- pylintrc | 847 +++++++++++++++++++--------------- setup.py | 3 +- tests/pylintrc | 865 +++++++++++++++++++---------------- tests/test_cfilereader.py | 2 +- tests/test_rootfilereader.py | 136 +++--- tests/test_table.py | 2 +- tests/test_variable.py | 4 +- 12 files changed, 1049 insertions(+), 858 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 0d8044e6..f308fb38 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -25,23 +25,31 @@ jobs: strategy: matrix: os: [ubuntu-latest] - root-version: ["6.24", "6.26", "6.28"] - python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"] + root-version: ["6.24", "6.26", "6.28", "6.30"] + python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"] exclude: - root-version: "6.24" python-version: "3.10" + - root-version: "6.24" + python-version: "3.11" - root-version: "6.26" python-version: "3.6" - root-version: "6.26" python-version: "3.7" + - root-version: "6.26" + python-version: "3.11" - root-version: "6.28" python-version: "3.6" - root-version: "6.28" python-version: "3.7" + - root-version: "6.30" + python-version: "3.6" + - root-version: "6.30" + python-version: "3.7" include: - os: macos-latest - root-version: "6.28" - python-version: "3.10" + root-version: "6.30" + python-version: "3.11" steps: - uses: actions/checkout@v4 @@ -70,7 +78,7 @@ jobs: run: | python -m pip install --upgrade pip setuptools wheel python -m pip install --upgrade \ - 'pylint==2.9.6' \ + 'pylint' \ pytest_pylint \ configparser \ astroid \ @@ -109,7 +117,7 @@ jobs: path: examples/*.html - name: Run pylint - if: ${{ always() }} + if: ${{ always() && !startsWith(matrix.python-version, '3.6') && !startsWith(matrix.python-version, '3.7') }} run: | python -m pylint hepdata_lib/*.py python -m pylint tests/*.py --rcfile=tests/pylintrc diff --git a/docs/dev.rst b/docs/dev.rst index f4f4bcb0..2c4d8a53 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -121,7 +121,8 @@ Analysing the code pylint hepdata_lib/*.py pylint tests/*.py --rcfile=tests/pylintrc -These commands are run by GitHub Actions, so you should first check locally that no issues are flagged. +These commands are run by GitHub Actions (for Python 3.8 or later), +so you should first check locally that no issues are flagged. Making a release diff --git a/hepdata_lib/c_file_reader.py b/hepdata_lib/c_file_reader.py index 5b43d044..db664595 100644 --- a/hepdata_lib/c_file_reader.py +++ b/hepdata_lib/c_file_reader.py @@ -75,7 +75,6 @@ def get_graphs(self): def create_tgraph_dict(self, graph_list, list_of_tgraphs): """Function to create pyroot TGraph dict""" - # pylint: disable=no-self-use # Adding tgraphs into a dictionary y_values = [] @@ -100,7 +99,6 @@ def create_tgraph_dict(self, graph_list, list_of_tgraphs): def create_tgrapherrors_dict(self, graph_list): """Function to create pyroot TGraphErrors dict""" - # pylint: disable=no-self-use # Adding TGraphErrors into a dictionary y_values = [] @@ -135,7 +133,6 @@ def create_tgrapherrors_dict(self, graph_list): def create_tgrapherrors(self, x_value, y_value, dx_value, dy_value): """Function to create pyroot TGraphErrors object""" - # pylint: disable=no-self-use # Creating pyroot TGraphErrors object x_values = array('i') @@ -171,7 +168,6 @@ def create_tgrapherrors(self, x_value, y_value, dx_value, dy_value): def create_tgraph(self, x_value, y_value): """Function to create pyroot TGraph object""" - # pylint: disable=no-self-use # Creating pyroot TGraph object x_values = array('i') @@ -197,7 +193,6 @@ def create_tgraph(self, x_value, y_value): def check_for_comments(self, line): """Check line for comment""" - # pylint: disable=no-self-use _line = line ignoreline = 0 diff --git a/hepdata_lib/helpers.py b/hepdata_lib/helpers.py index 788fba04..ac0c7832 100644 --- a/hepdata_lib/helpers.py +++ b/hepdata_lib/helpers.py @@ -17,14 +17,14 @@ def execute_command(command): :type command: string """ - subprocess_args = dict( - args=command, - stdin=subprocess.PIPE, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, - shell=True, - universal_newlines=True - ) + subprocess_args = { + "args": command, + "stdin": subprocess.PIPE, + "stdout": subprocess.PIPE, + "stderr": subprocess.PIPE, + "shell": True, + "universal_newlines": True + } with subprocess.Popen(**subprocess_args) as proc: exit_code = proc.wait() if exit_code == 127: diff --git a/hepdata_lib/root_utils.py b/hepdata_lib/root_utils.py index 1192ae20..e1f37eb8 100644 --- a/hepdata_lib/root_utils.py +++ b/hepdata_lib/root_utils.py @@ -317,7 +317,7 @@ def get_hist_2d_points(hist, **kwargs): ixmax = hist.GetXaxis().FindBin(xlim[1]) if xlim[1] is not None else hist.GetNbinsX() + 1 iymin = hist.GetYaxis().FindBin(ylim[0]) if ylim[0] is not None else 1 iymax = hist.GetYaxis().FindBin(ylim[1]) if ylim[1] is not None else hist.GetNbinsY() + 1 - symmetric = (hist.GetBinErrorOption() == r.TH1.kNormal) + symmetric = hist.GetBinErrorOption() == r.TH1.kNormal if force_symmetric_errors: symmetric = True for x_bin in range(ixmin, ixmax): @@ -388,7 +388,7 @@ def get_hist_1d_points(hist, **kwargs): for key in ["x", "y", "x_edges", "x_labels", "dy"]: points[key] = [] - symmetric = (hist.GetBinErrorOption() == r.TH1.kNormal) + symmetric = hist.GetBinErrorOption() == r.TH1.kNormal if force_symmetric_errors: symmetric = True ixmin = hist.GetXaxis().FindBin(xlim[0]) if xlim[0] is not None else 1 diff --git a/pylintrc b/pylintrc index 5692e40a..76bd0bdf 100644 --- a/pylintrc +++ b/pylintrc @@ -1,290 +1,324 @@ -[MASTER] +[MAIN] + +# 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 + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= # A comma-separated list of package or module names from where C extensions may # be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist=math,array +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS,root +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# 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= # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). #init-hook= -# Use multiple processes to speed up Pylint. +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. jobs=1 -# List of plugins (as comma separated values of python modules names) to load, +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, # usually to register additional checkers. load-plugins= # Pickle collected data for later comparisons. persistent=yes -# Specify a configuration file. -#rcfile= +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.12 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= # When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages +# user-friendly hints instead of false-positive error messages. suggestion-mode=yes # Allow loading of arbitrary C extensions. Extensions are imported into the # active Python interpreter and may run arbitrary code. unsafe-load-any-extension=no +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= -[MESSAGES CONTROL] -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= +[BASIC] -# 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=print-statement, - parameter-unpacking, - unpacking-in-except, - old-raise-syntax, - backtick, - long-suffix, - old-ne-operator, - old-octal-literal, - import-star-module-level, - non-ascii-bytes-literal, - raw-checker-failed, - bad-inline-option, - locally-disabled, - locally-enabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - apply-builtin, - basestring-builtin, - buffer-builtin, - cmp-builtin, - coerce-builtin, - execfile-builtin, - file-builtin, - long-builtin, - raw_input-builtin, - reduce-builtin, - standarderror-builtin, - unicode-builtin, - xrange-builtin, - coerce-method, - delslice-method, - getslice-method, - setslice-method, - no-absolute-import, - old-division, - dict-iter-method, - dict-view-method, - next-method-called, - metaclass-assignment, - indexing-exception, - raising-string, - reload-builtin, - oct-method, - hex-method, - nonzero-method, - cmp-method, - input-builtin, - round-builtin, - intern-builtin, - unichr-builtin, - map-builtin-not-iterating, - zip-builtin-not-iterating, - range-builtin-not-iterating, - filter-builtin-not-iterating, - using-cmp-argument, - eq-without-hash, - div-method, - idiv-method, - rdiv-method, - exception-message-attribute, - invalid-str-codec, - sys-max-int, - bad-python3-import, - deprecated-string-function, - deprecated-str-translate-call, - deprecated-itertools-function, - deprecated-types-field, - next-method-defined, - dict-items-not-iterating, - dict-keys-not-iterating, - dict-values-not-iterating, - useless-object-inheritance, - consider-using-f-string +# Naming style matching correct argument names. +argument-naming-style=snake_case -# 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=c-extension-no-member +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= +# Naming style matching correct attribute names. +attr-naming-style=snake_case -[REPORTS] +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= -# 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) +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata -# 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= +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text +# Naming style matching correct class attribute names. +class-attribute-naming-style=any -# Tells whether to display a full report or only the messages -reports=no +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= -# Activate the evaluation score. -score=yes +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= -[REFACTORING] +# Naming style matching correct class names. +class-naming-style=PascalCase -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=optparse.Values,sys.exit +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= -[LOGGING] +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging +# Naming style matching correct function names. +function-naming-style=snake_case +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= -[SPELLING] +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ -# Limits count of emitted suggestions for spelling mistakes -max-spelling-suggestions=4 +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no -# List of comma separated words that should not be checked. -spelling-ignore-words= +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= -# 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 +# Naming style matching correct method names. +method-naming-style=snake_case +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= -[MISCELLANEOUS] +# Naming style matching correct module names. +module-naming-style=snake_case -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= -[TYPECHECK] +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ -# 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 +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty -# 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= +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= -# 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 +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes +# Naming style matching correct variable names. +variable-naming-style=snake_case -# 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 +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= -# 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=ROOT -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes +[CLASSES] -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit -[VARIABLES] +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls -# 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 valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes -# 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 +[DESIGN] -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= -# Tells whether we should check for unused import in __init__ files. -init-import=no +# Maximum number of arguments for function / method. +max-args=5 -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=past.builtins,future.builtins,builtins +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception [FORMAT] @@ -295,7 +329,7 @@ expected-line-ending-format= # Regexp for a line that is allowed to be longer than the limit. ignore-long-lines=^\s*(# )??$ -# Number of spaces of indent required inside a hanging or continued line. +# Number of spaces of indent required inside a hanging or continued line. indent-after-paren=4 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 @@ -305,16 +339,9 @@ indent-string=' ' # Maximum number of characters on a single line. max-line-length=100 -# Maximum number of lines in a module +# Maximum number of lines in a module. max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma, - dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -324,218 +351,292 @@ single-line-class-stmt=no single-line-if-stmt=no -[SIMILARITIES] +[IMPORTS] -# Ignore comments when computing similarities. -ignore-comments=yes +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= -# Ignore docstrings when computing similarities. -ignore-docstrings=yes +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no -# Ignore imports when computing similarities. -ignore-imports=no +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no -# Minimum lines number of a similarity. -min-similarity-lines=4 +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= -[BASIC] +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= -# Naming style matching correct argument names -argument-naming-style=snake_case +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= -# Regular expression matching correct argument names. Overrides argument- -# naming-style -#argument-rgx= +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= -# Naming style matching correct attribute names -attr-naming-style=snake_case +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant -# Regular expression matching correct attribute names. Overrides attr-naming- -# style -#attr-rgx= +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= -# Bad variable names which should always be refused, separated by a comma -bad-names=foo, - bar, - baz, - toto, - tutu, - tata -# Naming style matching correct class attribute names -class-attribute-naming-style=any +[LOGGING] -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style -#class-attribute-rgx= +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old -# Naming style matching correct class names -class-naming-style=PascalCase +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging -# Regular expression matching correct class names. Overrides class-naming-style -#class-rgx= -# Naming style matching correct constant names -const-naming-style=UPPER_CASE +[MESSAGES CONTROL] -# Regular expression matching correct constant names. Overrides const-naming- -# style -#const-rgx= +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 +# 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 re-enable 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=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero, + consider-using-f-string, + unspecified-encoding, + no-name-in-module -# Naming style matching correct function names -function-naming-style=snake_case +# 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= -# Regular expression matching correct function names. Overrides function- -# naming-style -#function-rgx= -# Good variable names which should always be accepted, separated by a comma -good-names=i, - j, - k, - ex, - Run, - _ +[METHOD_ARGS] -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request -# Naming style matching correct inline iteration names -inlinevar-naming-style=any -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style -#inlinevar-rgx= +[MISCELLANEOUS] -# Naming style matching correct method names -method-naming-style=snake_case +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO -# Regular expression matching correct method names. Overrides method-naming- -# style -#method-rgx= +# Regular expression of note tags to take in consideration. +notes-rgx= -# Naming style matching correct module names -module-naming-style=snake_case -# Regular expression matching correct module names. Overrides module-naming- -# style -#module-rgx= +[REFACTORING] -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error -# 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 +# Let 'consider-using-join' be raised when the separator to join on would be +# non-empty (resulting in expected fixes of the type: ``"- " + " - +# ".join(items)``) +suggest-join-with-non-empty-separator=yes -# Naming style matching correct variable names -variable-naming-style=snake_case -# Regular expression matching correct variable names. Overrides variable- -# naming-style -#variable-rgx= +[REPORTS] +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) -[IMPORTS] +# 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= -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= -# 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 +# Tells whether to display a full report or only the messages. +reports=no -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix +# Activate the evaluation score. +score=yes -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= +[SIMILARITIES] -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= +# Comments are removed from the similarity computation +ignore-comments=yes -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= +# Docstrings are removed from the similarity computation +ignore-docstrings=yes -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant +# Imports are removed from the similarity computation +ignore-imports=yes +# Signatures are removed from the similarity computation +ignore-signatures=yes -[CLASSES] +# Minimum lines number of a similarity. +min-similarity-lines=4 -# 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 +[SPELLING] -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. +spelling-dict= +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: -[DESIGN] +# List of comma separated words that should not be checked. +spelling-ignore-words= -# Maximum number of arguments for function / method -max-args=5 +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= -# Maximum number of attributes for a class (see R0902). -max-attributes=7 +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 -# Maximum number of branch for function / method body -max-branches=12 +[STRING] -# Maximum number of locals for function / method body -max-locals=15 +# 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=no -# Maximum number of parents for a class (see R0901). -max-parents=7 +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 -# Maximum number of return / yield for function / method body -max-returns=6 +[TYPECHECK] -# Maximum number of statements in function / method body -max-statements=50 +# 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 -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 +# 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= +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes -[EXCEPTIONS] +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# 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,argparse.Namespace,ROOT + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-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 + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/setup.py b/setup.py index c2699e17..088f89d6 100644 --- a/setup.py +++ b/setup.py @@ -33,6 +33,7 @@ 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', + 'Programming Language :: Python :: 3.11', ], keywords='HEPData physics OpenData', packages=find_packages(exclude=['contrib', 'docs', 'tests']), @@ -43,7 +44,7 @@ 'test': [ 'ipykernel', 'papermill', - 'pylint==2.9.6', + 'pylint', 'pytest', 'pytest-cov', ] diff --git a/tests/pylintrc b/tests/pylintrc index de04717a..1919bdf1 100644 --- a/tests/pylintrc +++ b/tests/pylintrc @@ -1,290 +1,324 @@ -[MASTER] +[MAIN] + +# 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 + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= # A comma-separated list of package or module names from where C extensions may # be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist=array +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10.0 -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS,root +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# 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= # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). #init-hook= -# Use multiple processes to speed up Pylint. +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. jobs=1 -# List of plugins (as comma separated values of python modules names) to load, +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, # usually to register additional checkers. load-plugins= # Pickle collected data for later comparisons. persistent=yes -# Specify a configuration file. -#rcfile= +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.12 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= # When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages +# user-friendly hints instead of false-positive error messages. suggestion-mode=yes # Allow loading of arbitrary C extensions. Extensions are imported into the # active Python interpreter and may run arbitrary code. unsafe-load-any-extension=no +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= -[MESSAGES CONTROL] -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= +[BASIC] -# 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=print-statement, - parameter-unpacking, - unpacking-in-except, - old-raise-syntax, - backtick, - long-suffix, - old-ne-operator, - old-octal-literal, - import-star-module-level, - non-ascii-bytes-literal, - raw-checker-failed, - bad-inline-option, - locally-disabled, - locally-enabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - apply-builtin, - basestring-builtin, - buffer-builtin, - cmp-builtin, - coerce-builtin, - execfile-builtin, - file-builtin, - long-builtin, - raw_input-builtin, - reduce-builtin, - standarderror-builtin, - unicode-builtin, - xrange-builtin, - coerce-method, - delslice-method, - getslice-method, - setslice-method, - no-absolute-import, - old-division, - dict-iter-method, - dict-view-method, - next-method-called, - metaclass-assignment, - indexing-exception, - raising-string, - reload-builtin, - oct-method, - hex-method, - nonzero-method, - cmp-method, - input-builtin, - round-builtin, - intern-builtin, - unichr-builtin, - map-builtin-not-iterating, - zip-builtin-not-iterating, - range-builtin-not-iterating, - filter-builtin-not-iterating, - using-cmp-argument, - eq-without-hash, - div-method, - idiv-method, - rdiv-method, - exception-message-attribute, - invalid-str-codec, - sys-max-int, - bad-python3-import, - deprecated-string-function, - deprecated-str-translate-call, - deprecated-itertools-function, - deprecated-types-field, - next-method-defined, - dict-items-not-iterating, - dict-keys-not-iterating, - dict-values-not-iterating, - useless-object-inheritance - consider-using-f-string +# Naming style matching correct argument names. +argument-naming-style=snake_case -# 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=c-extension-no-member +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= +# Naming style matching correct attribute names. +attr-naming-style=snake_case -[REPORTS] +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= -# 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) +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata -# 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= +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text +# Naming style matching correct class attribute names. +class-attribute-naming-style=any -# Tells whether to display a full report or only the messages -reports=no +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= -# Activate the evaluation score. -score=yes +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= -[REFACTORING] +# Naming style matching correct class names. +class-naming-style=PascalCase -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=optparse.Values,sys.exit +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= -[LOGGING] +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging +# Naming style matching correct function names. +function-naming-style=snake_case +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= -[SPELLING] +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ -# Limits count of emitted suggestions for spelling mistakes -max-spelling-suggestions=4 +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no -# List of comma separated words that should not be checked. -spelling-ignore-words= +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= -# 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 +# Naming style matching correct method names. +method-naming-style=snake_case +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= -[MISCELLANEOUS] +# Naming style matching correct module names. +module-naming-style=snake_case -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= -[TYPECHECK] +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ -# 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 +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty -# 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= +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= -# 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 +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes +# Naming style matching correct variable names. +variable-naming-style=snake_case -# 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 +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= -# 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=ROOT -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes +[CLASSES] -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit -[VARIABLES] +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls -# 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 valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes -# 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 +[DESIGN] -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= -# Tells whether we should check for unused import in __init__ files. -init-import=no +# Maximum number of arguments for function / method. +max-args=5 -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=past.builtins,future.builtins,builtins +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception [FORMAT] @@ -295,7 +329,7 @@ expected-line-ending-format= # Regexp for a line that is allowed to be longer than the limit. ignore-long-lines=^\s*(# )??$ -# Number of spaces of indent required inside a hanging or continued line. +# Number of spaces of indent required inside a hanging or continued line. indent-after-paren=4 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 @@ -305,16 +339,9 @@ indent-string=' ' # Maximum number of characters on a single line. max-line-length=100 -# Maximum number of lines in a module +# Maximum number of lines in a module. max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma, - dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -324,234 +351,292 @@ single-line-class-stmt=no single-line-if-stmt=no -[SIMILARITIES] +[IMPORTS] -# Ignore comments when computing similarities. -ignore-comments=yes +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= -# Ignore docstrings when computing similarities. -ignore-docstrings=yes +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no -# Ignore imports when computing similarities. -ignore-imports=no +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no -# Minimum lines number of a similarity. -min-similarity-lines=4 +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= -[BASIC] +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= -# Naming style matching correct argument names -argument-naming-style=snake_case +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= -# Regular expression matching correct argument names. Overrides argument- -# naming-style -#argument-rgx= +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= -# Naming style matching correct attribute names -attr-naming-style=snake_case +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant -# Regular expression matching correct attribute names. Overrides attr-naming- -# style -#attr-rgx= +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= -# Bad variable names which should always be refused, separated by a comma -bad-names=foo, - bar, - baz, - toto, - tutu, - tata -# Naming style matching correct class attribute names -class-attribute-naming-style=any +[LOGGING] -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style -#class-attribute-rgx= +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old -# Naming style matching correct class names -class-naming-style=PascalCase +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging -# Regular expression matching correct class names. Overrides class-naming-style -#class-rgx= -# Naming style matching correct constant names -const-naming-style=UPPER_CASE +[MESSAGES CONTROL] -# Regular expression matching correct constant names. Overrides const-naming- -# style -#const-rgx= +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 +# 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 re-enable 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=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero, + consider-using-f-string, + unspecified-encoding, + no-name-in-module -# Naming style matching correct function names -function-naming-style=snake_case +# 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= -# Regular expression matching correct function names. Overrides function- -# naming-style -#function-rgx= -# Good variable names which should always be accepted, separated by a comma -good-names=i, - j, - k, - ex, - Run, - _, - f, - N, - x, - y, - g, - z, - v, - iy, - ix, - dz, - NX, - NY, - n_fill, - dx, - dy, - n_bin - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no +[METHOD_ARGS] -# Naming style matching correct inline iteration names -inlinevar-naming-style=any +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style -#inlinevar-rgx= -# Naming style matching correct method names -method-naming-style=snake_case +[MISCELLANEOUS] -# Regular expression matching correct method names. Overrides method-naming- -# style -#method-rgx= +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO -# Naming style matching correct module names -module-naming-style=snake_case +# Regular expression of note tags to take in consideration. +notes-rgx= -# Regular expression matching correct module names. Overrides module-naming- -# style -#module-rgx= -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= +[REFACTORING] -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 -# 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 +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error -# Naming style matching correct variable names -variable-naming-style=snake_case +# Let 'consider-using-join' be raised when the separator to join on would be +# non-empty (resulting in expected fixes of the type: ``"- " + " - +# ".join(items)``) +suggest-join-with-non-empty-separator=yes -# Regular expression matching correct variable names. Overrides variable- -# naming-style -#variable-rgx= +[REPORTS] -[IMPORTS] +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=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= -# 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 +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix +# Tells whether to display a full report or only the messages. +reports=no -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= +# Activate the evaluation score. +score=yes -# 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 internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= +[SIMILARITIES] -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= +# Comments are removed from the similarity computation +ignore-comments=yes -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant +# Docstrings are removed from the similarity computation +ignore-docstrings=yes +# Imports are removed from the similarity computation +ignore-imports=yes -[CLASSES] +# Signatures are removed from the similarity computation +ignore-signatures=yes -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp +# Minimum lines number of a similarity. +min-similarity-lines=4 -# 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 +[SPELLING] -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. +spelling-dict= -[DESIGN] +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: -# Maximum number of arguments for function / method -max-args=5 +# List of comma separated words that should not be checked. +spelling-ignore-words= -# Maximum number of attributes for a class (see R0902). -max-attributes=7 +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no -# Maximum number of branch for function / method body -max-branches=12 -# Maximum number of locals for function / method body -max-locals=15 +[STRING] -# Maximum number of parents for a class (see R0901). -max-parents=7 +# 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=no -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no -# Maximum number of return / yield for function / method body -max-returns=6 -# Maximum number of statements in function / method body -max-statements=50 +[TYPECHECK] -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 +# 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 + +# 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= +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes -[EXCEPTIONS] +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# 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,argparse.Namespace,ROOT + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-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 + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/tests/test_cfilereader.py b/tests/test_cfilereader.py index a6660339..b8555854 100644 --- a/tests/test_cfilereader.py +++ b/tests/test_cfilereader.py @@ -165,7 +165,7 @@ def test_get_graphs(self): reader = CFileReader(test_file) tgraphs = reader.get_graphs() - self.assertTrue(set(tgraphs.keys()) == {"tgraph", "tgraph"}) + self.assertTrue(set(tgraphs.keys()) == {"tgraph"}) self.addCleanup(os.remove, test_file) self.doCleanups() diff --git a/tests/test_rootfilereader.py b/tests/test_rootfilereader.py index 7ede5f49..588b6fe5 100644 --- a/tests/test_rootfilereader.py +++ b/tests/test_rootfilereader.py @@ -57,11 +57,11 @@ def test_read_graph_tgraph(self): Test the behavior of the read_graph function when reading a TGraph from file. """ - N = 20 + n = 20 name = "testgraph" - x = np.random.uniform(-1e3, 1e3, N) - y = np.random.uniform(-1e3, 1e3, N) + x = np.random.uniform(-1e3, 1e3, n) + y = np.random.uniform(-1e3, 1e3, n) # Create a graph and write to file g = ROOT.TGraph() @@ -90,13 +90,13 @@ def test_read_graph_tgrapherrors(self): when reading a TGraphErrors from file. """ # pylint: disable-msg=too-many-locals - N = 20 + n = 20 name = "testgraph" - x = np.random.uniform(-1e3, 1e3, N) - dx = np.random.uniform(-1e3, 1e3, N) - y = np.random.uniform(-1e3, 1e3, N) - dy = np.random.uniform(-1e3, 1e3, N) + x = np.random.uniform(-1e3, 1e3, n) + dx = np.random.uniform(-1e3, 1e3, n) + y = np.random.uniform(-1e3, 1e3, n) + dy = np.random.uniform(-1e3, 1e3, n) # Create a graph and write to file g = ROOT.TGraphErrors() @@ -129,15 +129,15 @@ def test_read_graph_tgrapherrors2(self): when reading a TGraphAsymmErrors from file. """ # pylint: disable-msg=too-many-locals - N = 20 + n = 20 name = "testgraph" - x = np.random.uniform(-1e3, 1e3, N) - dx1 = np.random.uniform(0, 1e3, N) - dx2 = np.random.uniform(0, 1e3, N) - y = np.random.uniform(-1e3, 1e3, N) - dy1 = np.random.uniform(0, 1e3, N) - dy2 = np.random.uniform(0, 1e3, N) + x = np.random.uniform(-1e3, 1e3, n) + dx1 = np.random.uniform(0, 1e3, n) + dx2 = np.random.uniform(0, 1e3, n) + y = np.random.uniform(-1e3, 1e3, n) + dy1 = np.random.uniform(0, 1e3, n) + dy2 = np.random.uniform(0, 1e3, n) # Create a graph and write to file g = ROOT.TGraphAsymmErrors() @@ -172,12 +172,12 @@ def test_read_hist_1d_symmetric_errors(self): name = "test" # Create test histogram - N = 100 - x_values = [0.5 + x for x in range(N)] - y_values = list(np.random.uniform(-1e3, 1e3, N)) - dy_values = list(np.random.uniform(0, 1e3, N)) + n = 100 + x_values = [0.5 + x for x in range(n)] + y_values = list(np.random.uniform(-1e3, 1e3, n)) + dy_values = list(np.random.uniform(0, 1e3, n)) x_edges = [] - hist = ROOT.TH1D("test1d_symm", "test1d_symm", N, 0, N) + hist = ROOT.TH1D("test1d_symm", "test1d_symm", n, 0, n) for i in range(1, hist.GetNbinsX()+1): hist.SetBinContent(i, y_values[i-1]) hist.SetBinError(i, dy_values[i-1]) @@ -196,7 +196,7 @@ def test_read_hist_1d_symmetric_errors(self): # Check consistency for key in ["x", "y", "dy", "x_edges"]: - self.assertTrue(key in set(points.keys())) + self.assertTrue(key in set(points)) self.assertTrue(all(float_compare(*tup) for tup in zip(points["x"], x_values))) self.assertTrue(all(float_compare(*tup) for tup in zip(points["y"], y_values))) self.assertTrue(all(float_compare(*tup) for tup in zip(points["dy"], dy_values))) @@ -209,7 +209,7 @@ def test_read_hist_1d_range(self): """Test the read_hist_1d function for a histogram with symmetric errors.""" # Create test histogram - N = 100 + n = 100 xmin = 20 xmax = 80 x_values = [0.5 + x for x in range(xmin, xmax)] @@ -217,7 +217,7 @@ def test_read_hist_1d_range(self): dy_values = list(np.random.uniform(0, 1e3, xmax-xmin)) testname = "test1d_symm" - hist = ROOT.TH1D(testname, testname, N, 0, N) + hist = ROOT.TH1D(testname, testname, n, 0, n) for i in range(xmin, xmax): hist.SetBinContent(i+1, y_values[i-xmin]) hist.SetBinError(i+1, dy_values[i-xmin]) @@ -259,7 +259,7 @@ def test_read_hist_1d_range(self): # Check consistency for key in ["x", "y", "dy"]: - self.assertTrue(key in set(points.keys())) + self.assertTrue(key in set(points)) self.assertTrue(all(float_compare(*tup) for tup in zip(points["x"], x_values))) self.assertTrue(all(float_compare(*tup) for tup in zip(points["y"], y_values))) @@ -301,7 +301,7 @@ def test_read_hist_1d_asymmetric_errors(self): # Check consistency for key in ["x", "y", "dy"]: - self.assertTrue(key in set(points.keys())) + self.assertTrue(key in set(points)) self.assertTrue(all(float_compare(*tup) for tup in zip(points["x"], x_values))) self.assertTrue(all(float_compare(*tup) for tup in zip(points["y"], y_values))) @@ -347,7 +347,7 @@ def test_read_hist_1d_asymmetric_force_symmetric_errors(self): # Check consistency for key in ["x", "y", "dy"]: - self.assertTrue(key in set(points.keys())) + self.assertTrue(key in set(points)) self.assertTrue(all(float_compare(*tup) for tup in zip(points["x"], x_values))) self.assertTrue(all(float_compare(*tup) for tup in zip(points["y"], y_values))) @@ -362,12 +362,12 @@ def test_read_hist_1d_bin_labels(self): name = "test" # Create test histogram - N = 100 - y_values = list(np.random.uniform(-1e3, 1e3, N)) - dy_values = list(np.random.uniform(0, 1e3, N)) + n = 100 + y_values = list(np.random.uniform(-1e3, 1e3, n)) + dy_values = list(np.random.uniform(0, 1e3, n)) labels = list(map(str,dy_values)) - hist = ROOT.TH1D("test1d_labels", "test1d_labels", N, 0, N) + hist = ROOT.TH1D("test1d_labels", "test1d_labels", n, 0, n) for i in range(1, hist.GetNbinsX()+1): hist.SetBinContent(i, y_values[i-1]) hist.SetBinError(i, dy_values[i-1]) @@ -381,7 +381,7 @@ def test_read_hist_1d_bin_labels(self): reader = RootFileReader(testfile.GetName()) points = reader.read_hist_1d(name) - self.assertTrue("x_labels" in points.keys()) + self.assertTrue("x_labels" in points) self.assertTrue(all(tup[0]==tup[1] for tup in zip(points["x_labels"], labels))) @@ -393,15 +393,15 @@ def test_read_hist_2d_bin_labels(self): name = "test" # Create test histogram - NX = 13 - NY = 37 - y_values = np.random.uniform(-1e3, 1e3, (NX,NY)) - xlabels = [f"X{i}" for i in range(NX)] - ylabels = [f"Y{i}" for i in range(NY)] - - hist = ROOT.TH2D("test2d_labels", "test2d_labels", NX, 0, NX, NY, 0, NY) - for i in range(NX): - for j in range(NY): + nx = 13 + ny = 37 + y_values = np.random.uniform(-1e3, 1e3, (nx,ny)) + xlabels = [f"X{i}" for i in range(nx)] + ylabels = [f"Y{i}" for i in range(ny)] + + hist = ROOT.TH2D("test2d_labels", "test2d_labels", nx, 0, nx, ny, 0, ny) + for i in range(nx): + for j in range(ny): hist.Fill(i,j,y_values[i,j]) hist.GetXaxis().SetBinLabel(i+1, xlabels[i]) hist.GetYaxis().SetBinLabel(j+1, ylabels[j]) @@ -414,14 +414,14 @@ def test_read_hist_2d_bin_labels(self): reader = RootFileReader(testfile.GetName()) points = reader.read_hist_2d(name) - self.assertTrue("x_labels" in points.keys()) - self.assertTrue("y_labels" in points.keys()) + self.assertTrue("x_labels" in points) + self.assertTrue("y_labels" in points) # The output ordering is # [(x=0,y=0), (x=0,y=1), ...] - for i in range(NX): - for j in range(NY): - index = i*NY + j + for i in range(nx): + for j in range(ny): + index = i*ny + j self.assertTrue( points["x_labels"][index]==xlabels[i] ) @@ -435,15 +435,15 @@ def test_read_hist_2d_symmetric_errors(self): """Test the read_hist_2d function with symmetric errors.""" # pylint: disable-msg=too-many-locals # Create test histogram - NX = 100 - NY = 100 - x_values = [0.5 + x for x in range(NX)] - y_values = [0.5 + x for x in range(NY)] - z_values = np.random.uniform(-1e3, 1e3, (NX, NY)) - dz_values = np.random.uniform(0, 1e3, (NX, NY)) + nx = 100 + ny = 100 + x_values = [0.5 + x for x in range(nx)] + y_values = [0.5 + x for x in range(ny)] + z_values = np.random.uniform(-1e3, 1e3, (nx, ny)) + dz_values = np.random.uniform(0, 1e3, (nx, ny)) testname = "test2d_sym" - hist = ROOT.TH2D(testname, testname, NX, 0, NX, NY, 0, NY) + hist = ROOT.TH2D(testname, testname, nx, 0, nx, ny, 0, ny) for ix in range(1, hist.GetNbinsX()+1): for iy in range(1, hist.GetNbinsY()+1): @@ -465,11 +465,11 @@ def test_read_hist_2d_symmetric_errors(self): # Check keys for key in ["x", "y", "z", "dz"]: - self.assertTrue(key in points.keys()) + self.assertTrue(key in points) # Check length for v in points.values(): - self.assertTrue(len(v) == NX*NY) + self.assertTrue(len(v) == nx*ny) # Check unordered contents self.assertTrue(set(points["x"]) == set(x_values)) @@ -496,8 +496,8 @@ def test_read_hist_2d_range(self): # pylint: disable-msg=too-many-statements # pylint: disable-msg=too-many-locals # Create test histogram - NX = 100 - NY = 100 + nx = 100 + ny = 100 xmin = 20 xmax = 80 ymin = 30 @@ -508,7 +508,7 @@ def test_read_hist_2d_range(self): dz_values = np.random.uniform(0, 1e3, (xmax-xmin, ymax-ymin)) testname = "test2d_sym" - hist = ROOT.TH2D(testname, testname, NX, 0, NX, NY, 0, NY) + hist = ROOT.TH2D(testname, testname, nx, 0, nx, ny, 0, ny) for ix in range(xmin, xmax): for iy in range(ymin, ymax): @@ -554,7 +554,7 @@ def test_read_hist_2d_range(self): # Check keys for key in ["x", "y", "z", "dz"]: - self.assertTrue(key in points.keys()) + self.assertTrue(key in points) # Check length for v in points.values(): @@ -586,11 +586,11 @@ def test_read_hist_2d_asymmetric_errors(self): _fpath = "testfile.root" # Create test histogram - NX = 17 - NY = 17 + nx = 17 + ny = 17 n_fill = 1000 - hist = ROOT.TH2D("test2d_asym", "test2d_asym", NX, 0, 1, NY, 0, 1) + hist = ROOT.TH2D("test2d_asym", "test2d_asym", nx, 0, 1, ny, 0, 1) hist.SetBinErrorOption(ROOT.TH1.kPoisson) for val in np.random.normal(loc=0.5, scale=0.15, size=(n_fill, 2)): hist.Fill(*val) @@ -610,11 +610,11 @@ def test_read_hist_2d_asymmetric_errors(self): # Check keys for key in ["x", "y", "z", "dz"]: - self.assertTrue(key in points.keys()) + self.assertTrue(key in points) # Check length for v in points.values(): - self.assertTrue(len(v) == NX*NY) + self.assertTrue(len(v) == nx*ny) # Look up original bins and compare for x, y, z, dz in zip(points["x"], points["y"], points["z"], points["dz"]): @@ -640,11 +640,11 @@ def test_read_hist_2d_asymmetric_force_symmetric_errors(self): _fpath = "testfile.root" # Create test histogram - NX = 17 - NY = 17 + nx = 17 + ny = 17 n_fill = 1000 - hist = ROOT.TH2D("test2d_asym", "test2d_asym", NX, 0, 1, NY, 0, 1) + hist = ROOT.TH2D("test2d_asym", "test2d_asym", nx, 0, 1, ny, 0, 1) hist.SetBinErrorOption(ROOT.TH1.kPoisson) for val in np.random.normal(loc=0.5, scale=0.15, size=(n_fill, 2)): hist.Fill(*val) @@ -664,11 +664,11 @@ def test_read_hist_2d_asymmetric_force_symmetric_errors(self): # Check keys for key in ["x", "y", "z", "dz"]: - self.assertTrue(key in points.keys()) + self.assertTrue(key in points) # Check length for v in points.values(): - self.assertTrue(len(v) == NX*NY) + self.assertTrue(len(v) == nx*ny) # Look up original bins and compare for x, y, z, dz in zip(points["x"], points["y"], points["z"], points["dz"]): diff --git a/tests/test_table.py b/tests/test_table.py index 6989c7c7..44b25eba 100644 --- a/tests/test_table.py +++ b/tests/test_table.py @@ -173,7 +173,7 @@ def test_write_images_multiple_executions(self): - def test_add_additional_resource(self): # pylint: disable=no-self-use + def test_add_additional_resource(self): """Test the add_additional_resource function.""" test_table = Table("Some Table") test_table.add_additional_resource("some link","www.cern.ch") diff --git a/tests/test_variable.py b/tests/test_variable.py index db73d1b9..2918f3e4 100644 --- a/tests/test_variable.py +++ b/tests/test_variable.py @@ -94,10 +94,10 @@ def test_add_qualifier(self): var.add_qualifier("Some Name 3", "Some value 3") with self.assertRaises(RuntimeError): var.add_qualifier("Some Name 4", "Some value 4", "Some unit 4") - # pylint: disable=R0201 + def test_make_dict(self): """Test the make_dict function.""" - # pylint: disable=no-self-use + var = Variable("testvar") # With or without units From 3a0f1ea4a3dbeef7dfa8e0fc0d9fb0df568915c7 Mon Sep 17 00:00:00 2001 From: Graeme Watt Date: Thu, 4 Apr 2024 18:09:05 +0100 Subject: [PATCH 2/3] Remove pylintrc and tests/pylintrc config files * Just use default Pylint configuration making sure that checks pass. * Tweak code for "consider-using-f-string" and "unspecified-encoding". * Need to disable "no-name-in-module" and "no-member" checks for ROOT. --- .github/workflows/tests.yml | 2 +- README.md | 2 +- docs/dev.rst | 2 +- hepdata_lib/__init__.py | 20 +- hepdata_lib/c_file_reader.py | 4 +- hepdata_lib/helpers.py | 10 +- hepdata_lib/root_utils.py | 28 +- pylintrc | 642 ----------------------------------- tests/pylintrc | 642 ----------------------------------- tests/test_cfilereader.py | 46 +-- tests/test_output.py | 4 +- tests/test_rootfilereader.py | 54 +-- tests/test_submission.py | 6 +- tests/test_table.py | 8 +- tests/test_utilities.py | 2 +- 15 files changed, 92 insertions(+), 1380 deletions(-) delete mode 100644 pylintrc delete mode 100644 tests/pylintrc diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index f308fb38..251d2767 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -120,4 +120,4 @@ jobs: if: ${{ always() && !startsWith(matrix.python-version, '3.6') && !startsWith(matrix.python-version, '3.7') }} run: | python -m pylint hepdata_lib/*.py - python -m pylint tests/*.py --rcfile=tests/pylintrc + python -m pylint tests/*.py diff --git a/README.md b/README.md index cd89e6d1..6f9ba74e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Library for getting your data into HEPData - Documentation: https://hepdata-lib.readthedocs.io -This code works with Python 3.6, 3.7, 3.8, 3.9 or 3.10. +This code works with Python 3.6, 3.7, 3.8, 3.9, 3.10, 3.11 or 3.12. ## Installation diff --git a/docs/dev.rst b/docs/dev.rst index 2c4d8a53..86e1f5f9 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -119,7 +119,7 @@ Analysing the code :: pylint hepdata_lib/*.py - pylint tests/*.py --rcfile=tests/pylintrc + pylint tests/*.py These commands are run by GitHub Actions (for Python 3.8 or later), so you should first check locally that no issues are flagged. diff --git a/hepdata_lib/__init__.py b/hepdata_lib/__init__.py index 96769880..631cc613 100644 --- a/hepdata_lib/__init__.py +++ b/hepdata_lib/__init__.py @@ -278,7 +278,7 @@ def make_dict(self): elif self.uncertainties and self.zero_uncertainties_warning: print( "Warning: omitting 'errors' since all uncertainties " \ - "are zero for bin {} of variable '{}'.".format(i+1, self.name) + f"are zero for bin {i+1} of variable '{self.name}'." ) print( "Note that bins with zero content should preferably " \ @@ -389,7 +389,7 @@ def write_images(self, outdir): for image_file in self.image_files: if not os.path.isfile(image_file): - raise RuntimeError("File %s does not exist!" % image_file) + raise RuntimeError(f"File {image_file} does not exist!") if not os.path.exists(outdir): os.makedirs(outdir) @@ -408,16 +408,16 @@ def write_images(self, outdir): if helpers.file_is_outdated(png_output_path, image_file): helpers.convert_pdf_to_png(image_file, png_output_path) else: - print("Full-size PNG file %s is newer than its source file. \ + print(f"Full-size PNG file {png_output_path} is newer than its source file. \ Remove the thumbnail file or use create_files(remove_old=True)\ - to force recreation." % png_output_path) + to force recreation.") if helpers.file_is_outdated(thumbnail_output_path, png_output_path): helpers.convert_png_to_thumbnail(png_output_path, thumbnail_output_path) else: - print("Thumbnail PNG file %s is newer than its source file. \ + print("Thumbnail PNG file {thumbnail_output_path} is newer than its source file. \ Remove the thumbnail file or use create_files(remove_old=True)\ - to force recreation." % thumbnail_output_path) + to force recreation.") image = {} image["description"] = "Image file" @@ -461,12 +461,12 @@ def write_yaml(self, outdir="."): shortname = self.name.lower().replace(" ", "_") outfile_path = os.path.join( outdir, f'{shortname}.yaml') - with open(outfile_path, 'w') as outfile: + with open(outfile_path, 'w', encoding='utf-8') as outfile: yaml.dump(table, outfile, default_flow_style=False) # Add entry to central submission file submission_path = os.path.join(outdir, 'submission.yaml') - with open(submission_path, 'a+') as submissionfile: + with open(submission_path, 'a+', encoding='utf-8') as submissionfile: submission = {} submission["name"] = self.name submission["description"] = self.description @@ -574,7 +574,7 @@ def read_abstract(self, filepath): :param filepath: Path to text file containing abstract. :type filepath: string. """ - with open(filepath) as afile: + with open(filepath, encoding='utf-8') as afile: raw = str(afile.read()) raw = raw.replace("\r\n", "") raw = raw.replace("\n", "") @@ -619,7 +619,7 @@ def create_files(self, outdir=".", validate=True, remove_old=False): if self.record_ids: submission["record_ids"] = self.record_ids - with open(os.path.join(outdir, 'submission.yaml'), 'w') as outfile: + with open(os.path.join(outdir, 'submission.yaml'), 'w', encoding='utf-8') as outfile: yaml.dump( submission, outfile, diff --git a/hepdata_lib/c_file_reader.py b/hepdata_lib/c_file_reader.py index db664595..a07c7148 100644 --- a/hepdata_lib/c_file_reader.py +++ b/hepdata_lib/c_file_reader.py @@ -2,7 +2,7 @@ import io from array import array from future.utils import raise_from -from ROOT import TGraph, TGraphErrors +from ROOT import TGraph, TGraphErrors # pylint: disable=no-name-in-module import hepdata_lib.root_utils as ru from hepdata_lib.helpers import check_file_existence @@ -34,7 +34,7 @@ def cfile(self, cfile): "CFileReader: Input file is not a .C file (name does not end in .C)!" ) if check_file_existence(cfile): - self._cfile = open(cfile) # pylint: disable=consider-using-with + self._cfile = open(cfile, encoding='utf-8') # pylint: disable=consider-using-with else: if isinstance(cfile, io.TextIOBase): self._cfile = cfile diff --git a/hepdata_lib/helpers.py b/hepdata_lib/helpers.py index ac0c7832..e1df117e 100644 --- a/hepdata_lib/helpers.py +++ b/hepdata_lib/helpers.py @@ -294,10 +294,9 @@ def convert_pdf_to_png(source, target): :param target: Output file in PNG format. :type target: str """ - assert os.path.exists(source), "Source file does not exist: %s" % source + assert os.path.exists(source), f"Source file does not exist: {source}" - command = "convert -flatten -density 300 -fuzz 1% -trim +repage {} {}".format( - source, target) + command = f"convert -flatten -density 300 -fuzz 1% -trim +repage {source} {target}" command_ok = execute_command(command) if not command_ok: print("ImageMagick does not seem to be installed \ @@ -314,8 +313,7 @@ def convert_png_to_thumbnail(source, target): :type target: str """ - command = "convert -thumbnail 240x179 {} {}".format( - source, target) + command = f"convert -thumbnail 240x179 {source} {target}" command_ok = execute_command(command) if not command_ok: @@ -334,7 +332,7 @@ def file_is_outdated(file_path, reference_file_path): :type reference_file_path: str """ if not os.path.exists(reference_file_path): - raise RuntimeError("Reference file does not exist: %s" % reference_file_path) + raise RuntimeError(f"Reference file does not exist: {reference_file_path}") if not os.path.exists(file_path): return True diff --git a/hepdata_lib/root_utils.py b/hepdata_lib/root_utils.py index e1f37eb8..48e0bec4 100644 --- a/hepdata_lib/root_utils.py +++ b/hepdata_lib/root_utils.py @@ -37,8 +37,8 @@ def tfile(self, tfile): "RootFileReader: Input file is not a ROOT file (name does not end in .root)!" ) if check_file_existence(tfile): - self._tfile = r.TFile(tfile) - elif isinstance(tfile, r.TFile): + self._tfile = r.TFile(tfile) # pylint: disable=no-member + elif isinstance(tfile, r.TFile): # pylint: disable=no-member self._tfile = tfile else: raise ValueError( @@ -157,7 +157,7 @@ def read_hist_2d(self, path_to_hist, **kwargs): ylim = kwargs.pop('ylim', (None, None)) force_symmetric_errors = kwargs.pop('force_symmetric_errors', False) if kwargs: - raise TypeError('Unexpected **kwargs: %r' % kwargs) + raise TypeError(f'Unexpected **kwargs: {repr(kwargs)}') assert isinstance(xlim, (tuple, list)) assert isinstance(ylim, (tuple, list)) assert len(xlim) == 2 @@ -193,7 +193,7 @@ def read_hist_1d(self, path_to_hist, **kwargs): xlim = kwargs.pop('xlim', (None, None)) force_symmetric_errors = kwargs.pop('force_symmetric_errors', False) if kwargs: - raise TypeError('Unexpected **kwargs: %r' % kwargs) + raise TypeError(f'Unexpected **kwargs: {repr(kwargs)}') assert isinstance(xlim, (tuple, list)) assert len(xlim) == 2 if xlim[0] and xlim[1]: @@ -217,7 +217,7 @@ def read_tree(self, path_to_tree, branch_name): """ tree = self.tfile.Get(path_to_tree) - if not tree or not isinstance(tree, r.TTree): + if not tree or not isinstance(tree, r.TTree): # pylint: disable=no-member raise RuntimeError(f"No TTree found for path '{path_to_tree}'.") values = [] for event in tree: @@ -297,7 +297,7 @@ def get_hist_2d_points(hist, **kwargs): ylim = kwargs.pop('ylim', (None, None)) force_symmetric_errors = kwargs.pop('force_symmetric_errors', False) if kwargs: - raise TypeError('Unexpected **kwargs: %r' % kwargs) + raise TypeError(f'Unexpected **kwargs: {repr(kwargs)}') assert isinstance(xlim, (tuple, list)) assert isinstance(ylim, (tuple, list)) assert len(xlim) == 2 @@ -317,7 +317,7 @@ def get_hist_2d_points(hist, **kwargs): ixmax = hist.GetXaxis().FindBin(xlim[1]) if xlim[1] is not None else hist.GetNbinsX() + 1 iymin = hist.GetYaxis().FindBin(ylim[0]) if ylim[0] is not None else 1 iymax = hist.GetYaxis().FindBin(ylim[1]) if ylim[1] is not None else hist.GetNbinsY() + 1 - symmetric = hist.GetBinErrorOption() == r.TH1.kNormal + symmetric = hist.GetBinErrorOption() == r.TH1.kNormal # pylint: disable=no-member if force_symmetric_errors: symmetric = True for x_bin in range(ixmin, ixmax): @@ -377,7 +377,7 @@ def get_hist_1d_points(hist, **kwargs): xlim = kwargs.pop('xlim', (None, None)) force_symmetric_errors = kwargs.pop('force_symmetric_errors', False) if kwargs: - raise TypeError('Unexpected **kwargs: %r' % kwargs) + raise TypeError(f'Unexpected **kwargs: {repr(kwargs)}') assert isinstance(xlim, (tuple, list)) assert len(xlim) == 2 if xlim[0] and xlim[1]: @@ -388,7 +388,7 @@ def get_hist_1d_points(hist, **kwargs): for key in ["x", "y", "x_edges", "x_labels", "dy"]: points[key] = [] - symmetric = hist.GetBinErrorOption() == r.TH1.kNormal + symmetric = hist.GetBinErrorOption() == r.TH1.kNormal # pylint: disable=no-member if force_symmetric_errors: symmetric = True ixmin = hist.GetXaxis().FindBin(xlim[0]) if xlim[0] is not None else 1 @@ -430,10 +430,8 @@ def get_graph_points(graph): """ # Check input - if not isinstance(graph, (r.TGraph, r.TGraphErrors, r.TGraphAsymmErrors)): - raise TypeError( - "Expected to input to be TGraph or similar, instead got '{0}'". - format(type(graph))) + if not isinstance(graph, (r.TGraph, r.TGraphErrors, r.TGraphAsymmErrors)): # pylint: disable=no-member + raise TypeError(f"Expected to input to be TGraph or similar, instead got '{type(graph)}'") # Extract points points = defaultdict(list) @@ -444,10 +442,10 @@ def get_graph_points(graph): graph.GetPoint(i, x_val, y_val) points["x"].append(float(x_val.value)) points["y"].append(float(y_val.value)) - if isinstance(graph, r.TGraphErrors): + if isinstance(graph, r.TGraphErrors): # pylint: disable=no-member points["dx"].append(graph.GetErrorX(i)) points["dy"].append(graph.GetErrorY(i)) - elif isinstance(graph, r.TGraphAsymmErrors): + elif isinstance(graph, r.TGraphAsymmErrors): # pylint: disable=no-member points["dx"].append((-graph.GetErrorXlow(i), graph.GetErrorXhigh(i))) points["dy"].append((-graph.GetErrorYlow(i), diff --git a/pylintrc b/pylintrc deleted file mode 100644 index 76bd0bdf..00000000 --- a/pylintrc +++ /dev/null @@ -1,642 +0,0 @@ -[MAIN] - -# 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 - -# Clear in-memory caches upon conclusion of linting. Useful if running pylint -# in a server-like mode. -clear-cache-post-run=no - -# Load and enable all available extensions. Use --list-extensions to see a list -# all available extensions. -#enable-all-extensions= - -# In error mode, messages with a category besides ERROR or FATAL are -# suppressed, and no reports are done by default. Error mode is compatible with -# disabling specific errors. -#errors-only= - -# Always return a 0 (non-error) status code, even if lint errors are found. -# This is primarily useful in continuous integration scripts. -#exit-zero= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. -extension-pkg-allow-list= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. (This is an alternative name to extension-pkg-allow-list -# for backward compatibility.) -extension-pkg-whitelist= - -# Return non-zero exit code if any of these messages/categories are detected, -# even if score is above --fail-under value. Syntax same as enable. Messages -# specified are enabled, while categories only check already-enabled messages. -fail-on= - -# Specify a score threshold under which the program will exit with error. -fail-under=10 - -# Interpret the stdin as a python script, whose filename needs to be passed as -# the module_or_package argument. -#from-stdin= - -# Files or directories to be skipped. They should be base names, not paths. -ignore=CVS - -# Add files or directories matching the regular expressions patterns to the -# ignore-list. The regex matches against paths and can be in Posix or Windows -# format. Because '\\' represents the directory delimiter on Windows systems, -# it can't be used as an escape character. -ignore-paths= - -# Files or directories matching the regular expression patterns are skipped. -# The regex matches against base names, not paths. The default value ignores -# Emacs file locks -ignore-patterns=^\.# - -# 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= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the -# number of processors available to use, and will cap the count on Windows to -# avoid hangs. -jobs=1 - -# Control the amount of potential inferred values when inferring a single -# object. This can help the performance when dealing with large functions or -# complex, nested conditions. -limit-inference-results=100 - -# List of plugins (as comma separated values of python module names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Minimum Python version to use for version dependent checks. Will default to -# the version used to run pylint. -py-version=3.12 - -# Discover python modules and packages in the file system subtree. -recursive=no - -# Add paths to the list of the source roots. Supports globbing patterns. The -# source root is an absolute path or a path relative to the current working -# directory used to determine a package namespace for modules located under the -# source root. -source-roots= - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages. -suggestion-mode=yes - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - -# In verbose mode, extra non-checker-related info will be displayed. -#verbose= - - -[BASIC] - -# Naming style matching correct argument names. -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# naming-style. If left empty, argument names will be checked with the set -# naming style. -#argument-rgx= - -# Naming style matching correct attribute names. -attr-naming-style=snake_case - -# Regular expression matching correct attribute names. Overrides attr-naming- -# style. If left empty, attribute names will be checked with the set naming -# style. -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Bad variable names regexes, separated by a comma. If names match any regex, -# they will always be refused -bad-names-rgxs= - -# Naming style matching correct class attribute names. -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. If left empty, class attribute names will be checked -# with the set naming style. -#class-attribute-rgx= - -# Naming style matching correct class constant names. -class-const-naming-style=UPPER_CASE - -# Regular expression matching correct class constant names. Overrides class- -# const-naming-style. If left empty, class constant names will be checked with -# the set naming style. -#class-const-rgx= - -# Naming style matching correct class names. -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-naming- -# style. If left empty, class names will be checked with the set naming style. -#class-rgx= - -# Naming style matching correct constant names. -const-naming-style=UPPER_CASE - -# Regular expression matching correct constant names. Overrides const-naming- -# style. If left empty, constant names will be checked with the set naming -# style. -#const-rgx= - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming style matching correct function names. -function-naming-style=snake_case - -# Regular expression matching correct function names. Overrides function- -# naming-style. If left empty, function names will be checked with the set -# naming style. -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - ex, - Run, - _ - -# Good variable names regexes, separated by a comma. If names match any regex, -# they will always be accepted -good-names-rgxs= - -# Include a hint for the correct naming format with invalid-name. -include-naming-hint=no - -# Naming style matching correct inline iteration names. -inlinevar-naming-style=any - -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. If left empty, inline iteration names will be checked -# with the set naming style. -#inlinevar-rgx= - -# Naming style matching correct method names. -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-naming- -# style. If left empty, method names will be checked with the set naming style. -#method-rgx= - -# Naming style matching correct module names. -module-naming-style=snake_case - -# Regular expression matching correct module names. Overrides module-naming- -# style. If left empty, module names will be checked with the set naming style. -#module-rgx= - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -# These decorators are taken in consideration only for invalid-name. -property-classes=abc.abstractproperty - -# Regular expression matching correct type alias names. If left empty, type -# alias names will be checked with the set naming style. -#typealias-rgx= - -# Regular expression matching correct type variable names. If left empty, type -# variable names will be checked with the set naming style. -#typevar-rgx= - -# Naming style matching correct variable names. -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style. If left empty, variable names will be checked with the set -# naming style. -#variable-rgx= - - -[CLASSES] - -# Warn about protected attribute access inside special methods -check-protected-access-in-special-methods=no - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - asyncSetUp, - __post_init__ - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit - -# 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 - - -[DESIGN] - -# List of regular expressions of class ancestor names to ignore when counting -# public methods (see R0903) -exclude-too-few-public-methods= - -# List of qualified class names to ignore when counting class parents (see -# R0901) -ignored-parents= - -# Maximum number of arguments for function / method. -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=5 - -# Maximum number of branch for function / method body. -max-branches=12 - -# Maximum number of locals for function / method body. -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body. -max-returns=6 - -# Maximum number of statements in function / method body. -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when caught. -overgeneral-exceptions=builtins.BaseException,builtins.Exception - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module. -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# 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 - - -[IMPORTS] - -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= - -# Allow explicit reexports by alias from a package __init__. -allow-reexport-from-package=no - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules= - -# Output a graph (.gv or any supported image format) of external dependencies -# to the given file (report RP0402 must not be disabled). -ext-import-graph= - -# Output a graph (.gv or any supported image format) of all (i.e. internal and -# external) dependencies to the given file (report RP0402 must not be -# disabled). -import-graph= - -# Output a graph (.gv or any supported image format) of internal dependencies -# to 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 - -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= - - -[LOGGING] - -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old - -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, -# UNDEFINED. -confidence=HIGH, - CONTROL_FLOW, - INFERENCE, - INFERENCE_FAILURE, - UNDEFINED - -# 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 re-enable 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=raw-checker-failed, - bad-inline-option, - locally-disabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - use-symbolic-message-instead, - use-implicit-booleaness-not-comparison-to-string, - use-implicit-booleaness-not-comparison-to-zero, - consider-using-f-string, - unspecified-encoding, - no-name-in-module - -# 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= - - -[METHOD_ARGS] - -# List of qualified names (i.e., library.method) which require a timeout -# parameter e.g. 'requests.api.get,requests.api.post' -timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - -# Regular expression of note tags to take in consideration. -notes-rgx= - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=sys.exit,argparse.parse_error - -# Let 'consider-using-join' be raised when the separator to join on would be -# non-empty (resulting in expected fixes of the type: ``"- " + " - -# ".join(items)``) -suggest-join-with-non-empty-separator=yes - - -[REPORTS] - -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'fatal', 'error', 'warning', 'refactor', -# 'convention', and 'info' which contain the number of messages in each -# category, as well as 'statement' which is the total number of statements -# analyzed. This score is used by the global evaluation report (RP0004). -evaluation=max(0, 0 if fatal else 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= - -# Set the output format. Available formats are: text, parseable, colorized, -# json2 (improved json format), json (old json format) and msvs (visual -# studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -#output-format= - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[SIMILARITIES] - -# Comments are removed from the similarity computation -ignore-comments=yes - -# Docstrings are removed from the similarity computation -ignore-docstrings=yes - -# Imports are removed from the similarity computation -ignore-imports=yes - -# Signatures are removed from the similarity computation -ignore-signatures=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[SPELLING] - -# Limits count of emitted suggestions for spelling mistakes. -max-spelling-suggestions=4 - -# Spelling dictionary name. No available dictionaries : You need to install -# both the python package and the system dependency for enchant to work. -spelling-dict= - -# List of comma separated words that should be considered directives if they -# appear at the beginning of a comment and should not be checked. -spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains the private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to the private dictionary (see the -# --spelling-private-dict-file option) instead of raising a message. -spelling-store-unknown-words=no - - -[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=no - -# This flag controls whether the implicit-str-concat should generate a warning -# on implicit string concatenation in sequences defined over several lines. -check-str-concat-over-line-jumps=no - - -[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 - -# 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= - -# Tells whether to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of symbolic message names to ignore for Mixin members. -ignored-checks-for-mixins=no-member, - not-async-context-manager, - not-context-manager, - attribute-defined-outside-init - -# 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,argparse.Namespace,ROOT - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - -# Regex pattern to define which classes are considered mixins. -mixin-class-rgx=.*[Mm]ixin - -# List of decorators that change the signature of a decorated function. -signature-mutators= - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of names allowed to shadow builtins -allowed-redefined-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 - -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/tests/pylintrc b/tests/pylintrc deleted file mode 100644 index 1919bdf1..00000000 --- a/tests/pylintrc +++ /dev/null @@ -1,642 +0,0 @@ -[MAIN] - -# 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 - -# Clear in-memory caches upon conclusion of linting. Useful if running pylint -# in a server-like mode. -clear-cache-post-run=no - -# Load and enable all available extensions. Use --list-extensions to see a list -# all available extensions. -#enable-all-extensions= - -# In error mode, messages with a category besides ERROR or FATAL are -# suppressed, and no reports are done by default. Error mode is compatible with -# disabling specific errors. -#errors-only= - -# Always return a 0 (non-error) status code, even if lint errors are found. -# This is primarily useful in continuous integration scripts. -#exit-zero= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. -extension-pkg-allow-list= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. (This is an alternative name to extension-pkg-allow-list -# for backward compatibility.) -extension-pkg-whitelist= - -# Return non-zero exit code if any of these messages/categories are detected, -# even if score is above --fail-under value. Syntax same as enable. Messages -# specified are enabled, while categories only check already-enabled messages. -fail-on= - -# Specify a score threshold under which the program will exit with error. -fail-under=10.0 - -# Interpret the stdin as a python script, whose filename needs to be passed as -# the module_or_package argument. -#from-stdin= - -# Files or directories to be skipped. They should be base names, not paths. -ignore=CVS - -# Add files or directories matching the regular expressions patterns to the -# ignore-list. The regex matches against paths and can be in Posix or Windows -# format. Because '\\' represents the directory delimiter on Windows systems, -# it can't be used as an escape character. -ignore-paths= - -# Files or directories matching the regular expression patterns are skipped. -# The regex matches against base names, not paths. The default value ignores -# Emacs file locks -ignore-patterns=^\.# - -# 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= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the -# number of processors available to use, and will cap the count on Windows to -# avoid hangs. -jobs=1 - -# Control the amount of potential inferred values when inferring a single -# object. This can help the performance when dealing with large functions or -# complex, nested conditions. -limit-inference-results=100 - -# List of plugins (as comma separated values of python module names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Minimum Python version to use for version dependent checks. Will default to -# the version used to run pylint. -py-version=3.12 - -# Discover python modules and packages in the file system subtree. -recursive=no - -# Add paths to the list of the source roots. Supports globbing patterns. The -# source root is an absolute path or a path relative to the current working -# directory used to determine a package namespace for modules located under the -# source root. -source-roots= - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages. -suggestion-mode=yes - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - -# In verbose mode, extra non-checker-related info will be displayed. -#verbose= - - -[BASIC] - -# Naming style matching correct argument names. -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# naming-style. If left empty, argument names will be checked with the set -# naming style. -#argument-rgx= - -# Naming style matching correct attribute names. -attr-naming-style=snake_case - -# Regular expression matching correct attribute names. Overrides attr-naming- -# style. If left empty, attribute names will be checked with the set naming -# style. -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Bad variable names regexes, separated by a comma. If names match any regex, -# they will always be refused -bad-names-rgxs= - -# Naming style matching correct class attribute names. -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. If left empty, class attribute names will be checked -# with the set naming style. -#class-attribute-rgx= - -# Naming style matching correct class constant names. -class-const-naming-style=UPPER_CASE - -# Regular expression matching correct class constant names. Overrides class- -# const-naming-style. If left empty, class constant names will be checked with -# the set naming style. -#class-const-rgx= - -# Naming style matching correct class names. -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-naming- -# style. If left empty, class names will be checked with the set naming style. -#class-rgx= - -# Naming style matching correct constant names. -const-naming-style=UPPER_CASE - -# Regular expression matching correct constant names. Overrides const-naming- -# style. If left empty, constant names will be checked with the set naming -# style. -#const-rgx= - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming style matching correct function names. -function-naming-style=snake_case - -# Regular expression matching correct function names. Overrides function- -# naming-style. If left empty, function names will be checked with the set -# naming style. -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - ex, - Run, - _ - -# Good variable names regexes, separated by a comma. If names match any regex, -# they will always be accepted -good-names-rgxs= - -# Include a hint for the correct naming format with invalid-name. -include-naming-hint=no - -# Naming style matching correct inline iteration names. -inlinevar-naming-style=any - -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. If left empty, inline iteration names will be checked -# with the set naming style. -#inlinevar-rgx= - -# Naming style matching correct method names. -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-naming- -# style. If left empty, method names will be checked with the set naming style. -#method-rgx= - -# Naming style matching correct module names. -module-naming-style=snake_case - -# Regular expression matching correct module names. Overrides module-naming- -# style. If left empty, module names will be checked with the set naming style. -#module-rgx= - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -# These decorators are taken in consideration only for invalid-name. -property-classes=abc.abstractproperty - -# Regular expression matching correct type alias names. If left empty, type -# alias names will be checked with the set naming style. -#typealias-rgx= - -# Regular expression matching correct type variable names. If left empty, type -# variable names will be checked with the set naming style. -#typevar-rgx= - -# Naming style matching correct variable names. -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style. If left empty, variable names will be checked with the set -# naming style. -#variable-rgx= - - -[CLASSES] - -# Warn about protected attribute access inside special methods -check-protected-access-in-special-methods=no - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - asyncSetUp, - __post_init__ - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit - -# 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 - - -[DESIGN] - -# List of regular expressions of class ancestor names to ignore when counting -# public methods (see R0903) -exclude-too-few-public-methods= - -# List of qualified class names to ignore when counting class parents (see -# R0901) -ignored-parents= - -# Maximum number of arguments for function / method. -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=5 - -# Maximum number of branch for function / method body. -max-branches=12 - -# Maximum number of locals for function / method body. -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body. -max-returns=6 - -# Maximum number of statements in function / method body. -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when caught. -overgeneral-exceptions=builtins.BaseException,builtins.Exception - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module. -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# 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 - - -[IMPORTS] - -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= - -# Allow explicit reexports by alias from a package __init__. -allow-reexport-from-package=no - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules= - -# Output a graph (.gv or any supported image format) of external dependencies -# to the given file (report RP0402 must not be disabled). -ext-import-graph= - -# Output a graph (.gv or any supported image format) of all (i.e. internal and -# external) dependencies to the given file (report RP0402 must not be -# disabled). -import-graph= - -# Output a graph (.gv or any supported image format) of internal dependencies -# to 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 - -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= - - -[LOGGING] - -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old - -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, -# UNDEFINED. -confidence=HIGH, - CONTROL_FLOW, - INFERENCE, - INFERENCE_FAILURE, - UNDEFINED - -# 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 re-enable 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=raw-checker-failed, - bad-inline-option, - locally-disabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - use-symbolic-message-instead, - use-implicit-booleaness-not-comparison-to-string, - use-implicit-booleaness-not-comparison-to-zero, - consider-using-f-string, - unspecified-encoding, - no-name-in-module - -# 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= - - -[METHOD_ARGS] - -# List of qualified names (i.e., library.method) which require a timeout -# parameter e.g. 'requests.api.get,requests.api.post' -timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - -# Regular expression of note tags to take in consideration. -notes-rgx= - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=sys.exit,argparse.parse_error - -# Let 'consider-using-join' be raised when the separator to join on would be -# non-empty (resulting in expected fixes of the type: ``"- " + " - -# ".join(items)``) -suggest-join-with-non-empty-separator=yes - - -[REPORTS] - -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'fatal', 'error', 'warning', 'refactor', -# 'convention', and 'info' which contain the number of messages in each -# category, as well as 'statement' which is the total number of statements -# analyzed. This score is used by the global evaluation report (RP0004). -evaluation=max(0, 0 if fatal else 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= - -# Set the output format. Available formats are: text, parseable, colorized, -# json2 (improved json format), json (old json format) and msvs (visual -# studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -#output-format= - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[SIMILARITIES] - -# Comments are removed from the similarity computation -ignore-comments=yes - -# Docstrings are removed from the similarity computation -ignore-docstrings=yes - -# Imports are removed from the similarity computation -ignore-imports=yes - -# Signatures are removed from the similarity computation -ignore-signatures=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[SPELLING] - -# Limits count of emitted suggestions for spelling mistakes. -max-spelling-suggestions=4 - -# Spelling dictionary name. No available dictionaries : You need to install -# both the python package and the system dependency for enchant to work. -spelling-dict= - -# List of comma separated words that should be considered directives if they -# appear at the beginning of a comment and should not be checked. -spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains the private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to the private dictionary (see the -# --spelling-private-dict-file option) instead of raising a message. -spelling-store-unknown-words=no - - -[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=no - -# This flag controls whether the implicit-str-concat should generate a warning -# on implicit string concatenation in sequences defined over several lines. -check-str-concat-over-line-jumps=no - - -[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 - -# 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= - -# Tells whether to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of symbolic message names to ignore for Mixin members. -ignored-checks-for-mixins=no-member, - not-async-context-manager, - not-context-manager, - attribute-defined-outside-init - -# 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,argparse.Namespace,ROOT - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - -# Regex pattern to define which classes are considered mixins. -mixin-class-rgx=.*[Mm]ixin - -# List of decorators that change the signature of a decorated function. -signature-mutators= - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of names allowed to shadow builtins -allowed-redefined-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 - -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/tests/test_cfilereader.py b/tests/test_cfilereader.py index b8555854..b77511f6 100644 --- a/tests/test_cfilereader.py +++ b/tests/test_cfilereader.py @@ -22,7 +22,7 @@ def test_cfile_setter(self): # Check with existent file that does not end in .C _file = "text.txt" - with open(_file, "w") as testfile: + with open(_file, "w", encoding="utf-8") as testfile: testfile.write("TEST CONTENT") self.addCleanup(os.remove, _file) @@ -39,7 +39,7 @@ def test_cfile_setter(self): # Finally, try with good calls _cfile = "test.C" - with open(_cfile, "w") as testfile: + with open(_cfile, "w", encoding="utf-8") as testfile: testfile.write("TGraph* c = new TGraph(60, x_values, y_values)") self.addCleanup(os.remove, _cfile) @@ -54,7 +54,7 @@ def test_cfile_setter(self): # Use opened file (io.TextIOBase) try: - with open(_cfile) as testfile: + with open(_cfile, encoding="utf-8") as testfile: _reader = CFileReader(testfile) # pylint: disable=W0702 except: @@ -70,7 +70,7 @@ def test_get_graphs(self): # Test create a valid dictionary of TGraphs test_file = "test.C" - with open(test_file, "w") as testfile: + with open(test_file, "w", encoding="utf-8") as testfile: testfile.write( 'void test() {\n' 'Double_t Graph0_fx1[2] = {1,2};\n' + @@ -112,7 +112,7 @@ def test_get_graphs(self): self.assertTrue(tgraphs["Graph2"]["dy"] == graph2_dy) # Testing with invalid x and y values - with open(test_file, "w") as testfile: + with open(test_file, "w", encoding="utf-8") as testfile: testfile.write( 'void test() {\n' + 'Double_t Graph0_fx1[2] = {test,test};\n' + @@ -125,7 +125,7 @@ def test_get_graphs(self): reader.get_graphs() # Testing graphs with half float falf int values - with open(test_file, "w") as testfile: + with open(test_file, "w", encoding="utf-8") as testfile: testfile.write( 'void test() {\n' + 'Double_t Graph0_fx1[2] = {1,2};\n' + @@ -150,7 +150,7 @@ def test_get_graphs(self): self.assertTrue(tgraphs["Graph2"]["dy"] == [0, 0]) # Testing graphs without name - with open(test_file, "w") as testfile: + with open(test_file, "w", encoding="utf-8") as testfile: testfile.write( 'void test() {\n' + 'Double_t Graph0_fx2[5] ={ 1.2, 2.2 };\n' + @@ -181,7 +181,7 @@ def test_create_tgrapherrors(self): dy_value = np.random.uniform(0, 0, _length) c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('test') reader = CFileReader(c_file) graph = reader.create_tgrapherrors(x_value, y_value, dx_value, dy_value) @@ -210,7 +210,7 @@ def test_create_tgraph(self): x_value = np.random.uniform(-1e3, 1e3, _length) y_value = np.random.uniform(-1e3, 1e3, _length) c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('test') reader = CFileReader(c_file) graph = reader.create_tgraph(x_value, y_value) @@ -226,7 +226,7 @@ def test_find_graphs(self): # Test normal TGraph object c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'TGraph *graph = new TGraph(5,Graph0_fx1,Graph0_fy1);' + '\ngraph->SetName("Graph0");}') @@ -240,7 +240,7 @@ def test_find_graphs(self): self.assertTrue(test2 == graphs) # Test with whole line in comment - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + '//TGraph *graph = new TGraph(5,Graph0_fx1,Graph0_fy1);' + '\n//graph->SetName("Graph0");}') @@ -252,7 +252,7 @@ def test_find_graphs(self): self.assertFalse(test2 == graphs) # Test with comment block - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'TGraph *graph = new TGraph(5,Graph0_fx1,Graph0_fy1);' + '\n/*graph->SetName("Graph0"*/);}') @@ -268,7 +268,7 @@ def test_find_graphs(self): self.doCleanups() # Test with whitespaces - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'TGraph *graph = new TGraph(5 ,Graph0_fx1 ,Graph0_fy1);' + '\ngraph->SetName("Graph0" );}') @@ -280,7 +280,7 @@ def test_find_graphs(self): self.assertTrue(test2 == graphs) # Test with line breaks - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'TGraph *graph = new TGraph(5,\n Graph0_fx1, Graph0_fy1);' + '\ngraph->SetName(\n"Graph0");}') @@ -294,7 +294,7 @@ def test_read_graph(self): # Testing with a good .C file graph_names = ["Graph0_fx1", "Graph0_fy1"] c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'Double_t Graph0_fx1[5] = { ' + '\n1.2,\n1.3};\n' + @@ -309,7 +309,7 @@ def test_read_graph(self): self.assertListEqual(test_yvalues, y_values) # Testing with invalid values - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'Double_t Graph0_fx1[5] = { ' + '\ntest,\n%&/};\n' + @@ -321,7 +321,7 @@ def test_read_graph(self): reader.read_graph(graph_names[1]) # Testing lines that end in comment - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'Double_t Graph0_fx1[5] = { //Comment ' + '\n1.2,//Comment\n1.3};\n' + @@ -333,7 +333,7 @@ def test_read_graph(self): self.assertListEqual(test_yvalues, y_values) # Testing lines that start with comment - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + 'Double_t Graph0_fx1[5] = { ' + '\n//1.2,\n1.3};\n' + @@ -347,7 +347,7 @@ def test_read_graph(self): self.assertListEqual(test_yvalues, y_values) # Testing lines with comment block - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('void test() {\n' + '/*Double_t Graph0_fx1[5] = { ' + '\n1.2,\n1.3*/};\n' + @@ -368,7 +368,7 @@ def test_check_for_comments(self): # Test with a clean line test_line = "This is just a test" c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('test') reader = CFileReader(c_file) line_test = reader.check_for_comments(test_line) @@ -380,7 +380,7 @@ def test_check_for_comments(self): # Test with a comment block starting in the middle test_line = "This is /*just a test" c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('test') reader = CFileReader(c_file) line_test = reader.check_for_comments(test_line) @@ -391,7 +391,7 @@ def test_check_for_comments(self): # Test with a comment block that ends in mid line test_line = "This is */ just a test" c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('test') reader = CFileReader(c_file) line_test = reader.check_for_comments(test_line) @@ -403,7 +403,7 @@ def test_check_for_comments(self): # Test with whole line in a comment test_line = "//This is just a test" c_file = "test.C" - with open(c_file, "w") as testfile: + with open(c_file, "w", encoding="utf-8") as testfile: testfile.write('test') reader = CFileReader(c_file) line_test = reader.check_for_comments(test_line) diff --git a/tests/test_output.py b/tests/test_output.py index 37eec651..79ea9303 100644 --- a/tests/test_output.py +++ b/tests/test_output.py @@ -36,7 +36,7 @@ def test_yaml_output(self): # Test read yaml file table_file = os.path.join(tmp_dir, "testtable.yaml") try: - with open(table_file) as testfile: + with open(table_file, encoding="utf-8") as testfile: testyaml = yaml.safe_load(testfile) except yaml.YAMLError as exc: print(exc) @@ -45,7 +45,7 @@ def test_yaml_output(self): testtxt = ("dependent_variables:\n- header:\n name: Y\n values:\n" + " - value: 0.12\n - value: 0.22\nindependent_variables:\n" + "- header:\n name: X\n values:\n - value: 1.2\n - value: 2.2\n") - with open(table_file) as testfile: + with open(table_file, encoding="utf-8") as testfile: testyaml = testfile.read() self.assertEqual(str(testyaml), testtxt) diff --git a/tests/test_rootfilereader.py b/tests/test_rootfilereader.py index 588b6fe5..1c6209ca 100644 --- a/tests/test_rootfilereader.py +++ b/tests/test_rootfilereader.py @@ -26,7 +26,7 @@ def test_tfile_setter(self): path_to_file = "test.txt" self.addCleanup(os.remove, path_to_file) - with open(path_to_file, "w") as testfile: + with open(path_to_file, "w", encoding="utf-8") as testfile: testfile.write("TEST CONTENT") with self.assertRaises(RuntimeError): @@ -64,7 +64,7 @@ def test_read_graph_tgraph(self): y = np.random.uniform(-1e3, 1e3, n) # Create a graph and write to file - g = ROOT.TGraph() + g = ROOT.TGraph() # pylint: disable=no-member for i, (ix, iy) in enumerate(zip(x, y)): g.SetPoint(i, ix, iy) @@ -99,7 +99,7 @@ def test_read_graph_tgrapherrors(self): dy = np.random.uniform(-1e3, 1e3, n) # Create a graph and write to file - g = ROOT.TGraphErrors() + g = ROOT.TGraphErrors() # pylint: disable=no-member for i, (ix, iy, idx, idy) in enumerate(zip(x, y, dx, dy)): g.SetPoint(i, ix, iy) g.SetPointError(i, idx, idy) @@ -140,7 +140,7 @@ def test_read_graph_tgrapherrors2(self): dy2 = np.random.uniform(0, 1e3, n) # Create a graph and write to file - g = ROOT.TGraphAsymmErrors() + g = ROOT.TGraphAsymmErrors() # pylint: disable=no-member for i, (ix, iy, idx1, idx2, idy1, idy2) in enumerate(zip(x, y, dx1, dx2, dy1, dy2)): g.SetPoint(i, ix, iy) g.SetPointError(i, idx1, idx2, idy1, idy2) @@ -177,7 +177,7 @@ def test_read_hist_1d_symmetric_errors(self): y_values = list(np.random.uniform(-1e3, 1e3, n)) dy_values = list(np.random.uniform(0, 1e3, n)) x_edges = [] - hist = ROOT.TH1D("test1d_symm", "test1d_symm", n, 0, n) + hist = ROOT.TH1D("test1d_symm", "test1d_symm", n, 0, n) # pylint: disable=no-member for i in range(1, hist.GetNbinsX()+1): hist.SetBinContent(i, y_values[i-1]) hist.SetBinError(i, dy_values[i-1]) @@ -217,7 +217,7 @@ def test_read_hist_1d_range(self): dy_values = list(np.random.uniform(0, 1e3, xmax-xmin)) testname = "test1d_symm" - hist = ROOT.TH1D(testname, testname, n, 0, n) + hist = ROOT.TH1D(testname, testname, n, 0, n) # pylint: disable=no-member for i in range(xmin, xmax): hist.SetBinContent(i+1, y_values[i-xmin]) hist.SetBinError(i+1, dy_values[i-xmin]) @@ -274,8 +274,8 @@ def test_read_hist_1d_asymmetric_errors(self): n_bin = 17 n_fill = 1000 testname = "test1d_asymm" - hist = ROOT.TH1D(testname, testname, n_bin, 0, 1) - hist.SetBinErrorOption(ROOT.TH1.kPoisson) + hist = ROOT.TH1D(testname, testname, n_bin, 0, 1) # pylint: disable=no-member + hist.SetBinErrorOption(ROOT.TH1.kPoisson) # pylint: disable=no-member for val in np.random.normal(loc=0.5, scale=0.15, size=n_fill): hist.Fill(val) @@ -320,8 +320,8 @@ def test_read_hist_1d_asymmetric_force_symmetric_errors(self): n_bin = 17 n_fill = 1000 testname = "test1d_asymm" - hist = ROOT.TH1D(testname, testname, n_bin, 0, 1) - hist.SetBinErrorOption(ROOT.TH1.kPoisson) + hist = ROOT.TH1D(testname, testname, n_bin, 0, 1) # pylint: disable=no-member + hist.SetBinErrorOption(ROOT.TH1.kPoisson) # pylint: disable=no-member for val in np.random.normal(loc=0.5, scale=0.15, size=n_fill): hist.Fill(val) @@ -367,7 +367,7 @@ def test_read_hist_1d_bin_labels(self): dy_values = list(np.random.uniform(0, 1e3, n)) labels = list(map(str,dy_values)) - hist = ROOT.TH1D("test1d_labels", "test1d_labels", n, 0, n) + hist = ROOT.TH1D("test1d_labels", "test1d_labels", n, 0, n) # pylint: disable=no-member for i in range(1, hist.GetNbinsX()+1): hist.SetBinContent(i, y_values[i-1]) hist.SetBinError(i, dy_values[i-1]) @@ -399,7 +399,7 @@ def test_read_hist_2d_bin_labels(self): xlabels = [f"X{i}" for i in range(nx)] ylabels = [f"Y{i}" for i in range(ny)] - hist = ROOT.TH2D("test2d_labels", "test2d_labels", nx, 0, nx, ny, 0, ny) + hist = ROOT.TH2D("test2d_labels", "test2d_labels", nx, 0, nx, ny, 0, ny) # pylint: disable=no-member for i in range(nx): for j in range(ny): hist.Fill(i,j,y_values[i,j]) @@ -439,11 +439,11 @@ def test_read_hist_2d_symmetric_errors(self): ny = 100 x_values = [0.5 + x for x in range(nx)] y_values = [0.5 + x for x in range(ny)] - z_values = np.random.uniform(-1e3, 1e3, (nx, ny)) + z_values = np.random.uniform(-1e3, 1e3, (nx, ny)) # pylint: disable=no-member dz_values = np.random.uniform(0, 1e3, (nx, ny)) testname = "test2d_sym" - hist = ROOT.TH2D(testname, testname, nx, 0, nx, ny, 0, ny) + hist = ROOT.TH2D(testname, testname, nx, 0, nx, ny, 0, ny) # pylint: disable=no-member for ix in range(1, hist.GetNbinsX()+1): for iy in range(1, hist.GetNbinsY()+1): @@ -508,7 +508,7 @@ def test_read_hist_2d_range(self): dz_values = np.random.uniform(0, 1e3, (xmax-xmin, ymax-ymin)) testname = "test2d_sym" - hist = ROOT.TH2D(testname, testname, nx, 0, nx, ny, 0, ny) + hist = ROOT.TH2D(testname, testname, nx, 0, nx, ny, 0, ny) # pylint: disable=no-member for ix in range(xmin, xmax): for iy in range(ymin, ymax): @@ -590,8 +590,8 @@ def test_read_hist_2d_asymmetric_errors(self): ny = 17 n_fill = 1000 - hist = ROOT.TH2D("test2d_asym", "test2d_asym", nx, 0, 1, ny, 0, 1) - hist.SetBinErrorOption(ROOT.TH1.kPoisson) + hist = ROOT.TH2D("test2d_asym", "test2d_asym", nx, 0, 1, ny, 0, 1) # pylint: disable=no-member + hist.SetBinErrorOption(ROOT.TH1.kPoisson) # pylint: disable=no-member for val in np.random.normal(loc=0.5, scale=0.15, size=(n_fill, 2)): hist.Fill(*val) @@ -644,8 +644,8 @@ def test_read_hist_2d_asymmetric_force_symmetric_errors(self): ny = 17 n_fill = 1000 - hist = ROOT.TH2D("test2d_asym", "test2d_asym", nx, 0, 1, ny, 0, 1) - hist.SetBinErrorOption(ROOT.TH1.kPoisson) + hist = ROOT.TH2D("test2d_asym", "test2d_asym", nx, 0, 1, ny, 0, 1) # pylint: disable=no-member + hist.SetBinErrorOption(ROOT.TH1.kPoisson) # pylint: disable=no-member for val in np.random.normal(loc=0.5, scale=0.15, size=(n_fill, 2)): hist.Fill(*val) @@ -697,7 +697,7 @@ def test_read_tree(self): data = np.random.normal(loc=0.5, scale=0.15, size=n_fill) number = array("f", [0]) - tree = ROOT.TTree() + tree = ROOT.TTree() # pylint: disable=no-member tree.Branch(branchname, number, "test/F") for inumber in data: number[0] = inumber @@ -744,14 +744,14 @@ def test_retrieve_object_failure(self): def test_retrieve_object_canvas(self): '''Check that retrieve_object correctly reads from canvas.''' # Disable graphical output - ROOT.gROOT.SetBatch(ROOT.kTRUE) + ROOT.gROOT.SetBatch(ROOT.kTRUE) # pylint: disable=no-member # Create test histogram, plot on canvas, save to file tfile = make_tmp_root_file(testcase=self) - histogram = ROOT.TH1D("testhist", "testhist", 10, 0, 1) + histogram = ROOT.TH1D("testhist", "testhist", 10, 0, 1) # pylint: disable=no-member path_to_file = tfile.GetName() - canvas = ROOT.TCanvas() + canvas = ROOT.TCanvas() # pylint: disable=no-member histogram.Draw("HIST") canvas.Write("canvas") @@ -779,15 +779,15 @@ def test_retrieve_object_canvas(self): def test_retrieve_object_canvas_tpad(self): '''Check that retrieve_object correctly reads from canvas.''' # Disable graphical output - ROOT.gROOT.SetBatch(ROOT.kTRUE) + ROOT.gROOT.SetBatch(ROOT.kTRUE) # pylint: disable=no-member # Create test histogram, plot on canvas, save to file tfile = make_tmp_root_file(testcase=self) - histogram = ROOT.TH1D("testhist", "testhist", 10, 0, 1) + histogram = ROOT.TH1D("testhist", "testhist", 10, 0, 1) # pylint: disable=no-member path_to_file = tfile.GetName() - canvas = ROOT.TCanvas() - pad1 = ROOT.TPad("pad1","pad1",0,0,1,1) + canvas = ROOT.TCanvas() # pylint: disable=no-member + pad1 = ROOT.TPad("pad1","pad1",0,0,1,1) # pylint: disable=no-member pad1.Draw() pad1.cd() histogram.Draw("HIST") diff --git a/tests/test_submission.py b/tests/test_submission.py index f86b05be..39b063bc 100644 --- a/tests/test_submission.py +++ b/tests/test_submission.py @@ -87,7 +87,7 @@ def test_create_files_with_removal(self): os.makedirs(testdir) self.addCleanup(shutil.rmtree, testdir) testfile = os.path.join(testdir, "test.txt") - with open(testfile, "w") as f: + with open(testfile, "w", encoding="utf-8") as f: f.write("test") self.assertTrue(os.path.isfile(testfile)) @@ -115,7 +115,7 @@ def test_read_abstract(self): testfile = "testfile.txt" self.addCleanup(os.remove, testfile) - with open(testfile, "w") as f: + with open(testfile, "w", encoding="utf-8") as f: f.write(some_string) test_submission = Submission() @@ -129,7 +129,7 @@ def test_nested_files_to_copy(self): """Test that file copying works when tables have files.""" # Create random test file testfile = "testfile.txt" - with open(testfile, "w") as f: + with open(testfile, "w", encoding="utf-8") as f: f.write("test") self.addCleanup(os.remove, testfile) diff --git a/tests/test_table.py b/tests/test_table.py index 44b25eba..026d5251 100644 --- a/tests/test_table.py +++ b/tests/test_table.py @@ -74,7 +74,7 @@ def test_write_yaml(self): def test_add_image(self): """Get test PDF""" # Get test PDF - some_pdf = "%s/minimal.pdf" % os.path.dirname(__file__) + some_pdf = f"{os.path.dirname(__file__)}/minimal.pdf" test_table = Table("Some Table") @@ -106,7 +106,7 @@ def test_write_images(self): test_table = Table("Some Table") # Get test PDF - some_pdf = "%s/minimal.pdf" % os.path.dirname(__file__) + some_pdf = f"{os.path.dirname(__file__)}/minimal.pdf" # This should work fine test_table.add_image(some_pdf) @@ -136,7 +136,7 @@ def test_write_images_multiple_executions(self): """ test_table = Table("Some Table") - some_pdf = "%s/minimal.pdf" % os.path.dirname(__file__) + some_pdf = f"{os.path.dirname(__file__)}/minimal.pdf" test_table.add_image(some_pdf) testdir = "test_output" self.addCleanup(shutil.rmtree, testdir) @@ -181,7 +181,7 @@ def test_add_additional_resource(self): def test_copy_files(self): """Test the copy_files function.""" test_table = Table("Some Table") - some_pdf = "%s/minimal.pdf" % os.path.dirname(__file__) + some_pdf = f"{os.path.dirname(__file__)}/minimal.pdf" testdir = tmp_directory_name() self.addCleanup(shutil.rmtree, testdir) os.makedirs(testdir) diff --git a/tests/test_utilities.py b/tests/test_utilities.py index b7a5ccb5..eee8d9d4 100644 --- a/tests/test_utilities.py +++ b/tests/test_utilities.py @@ -101,7 +101,7 @@ def make_tmp_root_file(path_to_file='tmp_{RANDID}.root', mode="RECREATE", raise_from(IOError("String substitution failed. Your input path should not \ have any braces except possibly for the {RANDID} token!"), err) - rfile = ROOT.TFile(path_to_file, mode) + rfile = ROOT.TFile(path_to_file, mode) # pylint: disable=no-member if not rfile: raise RuntimeError(f"Failed to create temporary file: {path_to_file}") From 4baa23f10d81e0df958ef42050eef79d157261eb Mon Sep 17 00:00:00 2001 From: Graeme Watt Date: Thu, 4 Apr 2024 19:36:45 +0100 Subject: [PATCH 3/3] Improve test coverage to avoid Codecov failure --- hepdata_lib/root_utils.py | 6 +++--- tests/test_helpers.py | 6 ++++++ tests/test_rootfilereader.py | 25 ++++++++++++++++++++++--- tests/test_submission.py | 1 + tests/test_table.py | 4 ++++ 5 files changed, 36 insertions(+), 6 deletions(-) diff --git a/hepdata_lib/root_utils.py b/hepdata_lib/root_utils.py index 48e0bec4..c6d0269a 100644 --- a/hepdata_lib/root_utils.py +++ b/hepdata_lib/root_utils.py @@ -36,13 +36,13 @@ def tfile(self, tfile): raise RuntimeError( "RootFileReader: Input file is not a ROOT file (name does not end in .root)!" ) - if check_file_existence(tfile): - self._tfile = r.TFile(tfile) # pylint: disable=no-member + check_file_existence(tfile) + self._tfile = r.TFile(tfile) # pylint: disable=no-member elif isinstance(tfile, r.TFile): # pylint: disable=no-member self._tfile = tfile else: raise ValueError( - "RootReader: Encountered unkonown type of variable passed as tfile argument: " + "RootReader: Encountered unknown type of variable passed as tfile argument: " + str(type(tfile))) if not self._tfile: diff --git a/tests/test_helpers.py b/tests/test_helpers.py index d3857f71..d04e99d1 100644 --- a/tests/test_helpers.py +++ b/tests/test_helpers.py @@ -8,6 +8,7 @@ from hepdata_lib.helpers import get_number_precision from hepdata_lib.helpers import get_value_precision_wrt_reference from hepdata_lib.helpers import round_value_and_uncertainty +from hepdata_lib.helpers import file_is_outdated class TestHelpers(TestCase): @@ -116,3 +117,8 @@ def test_round_value_and_uncertainty(self): round_value_and_uncertainty(cont_asymm_err, "val", "unc", 2) self.assertTrue(cont_asymm_err["val"] == cont_asymm_err["val_round"]) self.assertTrue(cont_asymm_err["unc"] == cont_asymm_err["unc_round"]) + + def test_file_is_outdated(self): + '''Test behavior of file_is_outdated function''' + with self.assertRaises(RuntimeError): + file_is_outdated(None, 'non_existing_file.png') diff --git a/tests/test_rootfilereader.py b/tests/test_rootfilereader.py index 1c6209ca..4cd0c52c 100644 --- a/tests/test_rootfilereader.py +++ b/tests/test_rootfilereader.py @@ -6,7 +6,8 @@ import ctypes import numpy as np import ROOT -from hepdata_lib.root_utils import RootFileReader +from hepdata_lib.root_utils import (RootFileReader, get_graph_points, + get_hist_1d_points, get_hist_2d_points) from .test_utilities import float_compare, tuple_compare, histogram_compare_1d, make_tmp_root_file @@ -18,11 +19,11 @@ def test_tfile_setter(self): Test the behavior of the RootFileReader member setters. """ - # Check with nonexistant file that ends in .root + # Check with nonexistent file that ends in .root with self.assertRaises(RuntimeError): _reader = RootFileReader("/path/to/nowhere/butEndsIn.root") - # Check with existant file that does not end in .root + # Check with existing file that does not end in .root path_to_file = "test.txt" self.addCleanup(os.remove, path_to_file) @@ -42,9 +43,11 @@ def test_tfile_setter(self): # Finally, try a good call path_to_file = make_tmp_root_file(close=True, testcase=self) + tfile = make_tmp_root_file(testcase=self) try: _reader = RootFileReader(path_to_file) + _reader = RootFileReader(tfile) # pylint: disable=W0702 except: self.fail("RootFileReader raised an unexpected exception.") @@ -817,3 +820,19 @@ def test_retrieve_object_canvas_tpad(self): # Clean up self.doCleanups() + + def test_get_graph_points(self): + '''Check that get_graph_points with input not a TGraph (or similar) gives an exception.''' + with self.assertRaises(TypeError): + get_graph_points(100) + + def test_get_hist_1d_and_2d_points(self): + '''Check that get_hist_2d_points with wrong kwargs gives an exception.''' + testname = "test2d_sym" + xmin = 20 + xmax = 80 + # pass non-existing axis limit/parameter + with self.assertRaises(TypeError): + get_hist_1d_points(testname, zlim=(xmin, xmax)) + with self.assertRaises(TypeError): + get_hist_2d_points(testname, zlim=(xmin, xmax)) diff --git a/tests/test_submission.py b/tests/test_submission.py index 39b063bc..d750e931 100644 --- a/tests/test_submission.py +++ b/tests/test_submission.py @@ -73,6 +73,7 @@ def test_create_files(self): testdir = tmp_directory_name() test_submission = Submission() + test_submission.add_record_id(1657397, "inspire") tab = Table("test") test_submission.add_table(tab) test_submission.create_files(testdir) diff --git a/tests/test_table.py b/tests/test_table.py index 026d5251..3fb95d41 100644 --- a/tests/test_table.py +++ b/tests/test_table.py @@ -121,6 +121,10 @@ def test_write_images(self): expected_file = os.path.join(testdir, "minimal.png") self.assertTrue(os.path.exists(expected_file)) + test_table.image_files = {"non_existing_file.pdf"} + with self.assertRaises(RuntimeError): + test_table.write_images(testdir) + # Try wrong type of input argument bad_arguments = [None, 5, {}, []] for argument in bad_arguments: