From e97c8a58271f86cbe4150f632f14eabd3e76b76e Mon Sep 17 00:00:00 2001 From: Tobias Haase Date: Thu, 4 Apr 2024 18:57:08 +0200 Subject: [PATCH 1/4] Fix invalid escape sequence --- pybotvac/robot.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pybotvac/robot.py b/pybotvac/robot.py index 8a1e51f..65cd043 100644 --- a/pybotvac/robot.py +++ b/pybotvac/robot.py @@ -138,7 +138,7 @@ def __init__( # pylint: disable=anomalous-backslash-in-string self._url = "{endpoint}/vendors/{vendor_name}/robots/{serial}/messages".format( - endpoint=re.sub(":\d+", "", endpoint), # noqa: W605, Remove port number + endpoint=re.sub(r":\d+", "", endpoint), # Remove port number vendor_name=vendor.name, serial=self.serial, ) From 4a6c203450a464de9204feea0abb5a013f2e2bb6 Mon Sep 17 00:00:00 2001 From: Tobias Haase Date: Thu, 4 Apr 2024 18:59:14 +0200 Subject: [PATCH 2/4] make black happy --- pybotvac/session.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pybotvac/session.py b/pybotvac/session.py index 079d805..e471da7 100644 --- a/pybotvac/session.py +++ b/pybotvac/session.py @@ -1,4 +1,5 @@ """Sessionhandling for beehive endpoint.""" + import binascii import json import os From 9260b5e1638605bffd29ccdfbcca7790bbf11be5 Mon Sep 17 00:00:00 2001 From: Tobias Haase Date: Thu, 4 Apr 2024 19:10:18 +0200 Subject: [PATCH 3/4] make pylint happy --- .pylintrc | 773 +++++++++++++++++++++++--------------------- pybotvac/robot.py | 5 +- pybotvac/session.py | 7 + 3 files changed, 423 insertions(+), 362 deletions(-) diff --git a/.pylintrc b/.pylintrc index b84e5b5..14d412f 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,27 +1,77 @@ -[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-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= -# Specify a score threshold to be exceeded before program exits with error. -fail-under=10.0 +# 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= -# Add files or directories to the blacklist. They should be base names, not -# paths. +# 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 regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= +# 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. +# 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 @@ -36,6 +86,19 @@ 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.11 + +# 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 @@ -44,248 +107,8 @@ suggestion-mode=yes # active Python interpreter and may run arbitrary code. unsafe-load-any-extension=no - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. -confidence= - -# 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, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - use-symbolic-message-instead, - 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, - deprecated-operator-function, - deprecated-urllib-function, - xreadlines-attribute, - deprecated-sys-function, - exception-escape, - comprehension-escape, - too-few-public-methods, - too-many-arguments, - too-many-instance-attributes, - too-many-public-methods, - missing-class-docstring, - missing-function-docstring, - missing-module-docstring, - duplicate-code - -# 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 - - -[REPORTS] - -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'error', 'warning', 'refactor', and 'convention' -# 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=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, json -# and msvs (visual studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[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 - - -[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 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. Default to name -# with leading underscore. -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 - - -[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= - - -[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 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 - -# 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 class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of 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= - -# 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 - -# List of decorators that change the signature of a decorated function. -signature-mutators= +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= [BASIC] @@ -294,13 +117,15 @@ signature-mutators= argument-naming-style=snake_case # Regular expression matching correct argument names. Overrides argument- -# naming-style. +# 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= @@ -320,20 +145,30 @@ bad-names-rgxs= class-attribute-naming-style=any # Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. +# 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. +# 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= @@ -345,7 +180,8 @@ docstring-min-length=-1 function-naming-style=snake_case # Regular expression matching correct function names. Overrides function- -# naming-style. +# 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. @@ -367,21 +203,22 @@ include-naming-hint=no inlinevar-naming-style=any # Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. +# 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. +# 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. +# 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 @@ -397,49 +234,91 @@ no-docstring-rgx=^_ # 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. +# naming-style. If left empty, variable names will be checked with the set +# naming style. #variable-rgx= -[SIMILARITIES] +[CLASSES] -# Ignore comments when computing similarities. -ignore-comments=yes +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no -# Ignore docstrings when computing similarities. -ignore-docstrings=yes +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ -# Ignore imports when computing similarities. -ignore-imports=no +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit -# Minimum lines number of a similarity. -min-similarity-lines=4 +# 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 -[LOGGING] -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old +[DESIGN] -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging +# 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= -[STRING] +# Maximum number of arguments for function / method. +max-args=5 -# 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 attributes for a class (see R0902). +max-attributes=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 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] @@ -472,15 +351,194 @@ single-line-class-stmt=no 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, + too-few-public-methods, + too-many-arguments, + too-many-instance-attributes, + too-many-public-methods, + missing-class-docstring, + missing-function-docstring, + missing-module-docstring, + duplicate-code + +# 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. Available dictionaries: none. To make it work, -# install the python-enchant package. +# 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= @@ -492,105 +550,98 @@ spelling-private-dict-file= spelling-store-unknown-words=no -[DESIGN] - -# 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 +[STRING] -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 +# 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 return / yield for function / method body. -max-returns=6 +# 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 statements in function / method body. -max-statements=50 -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 +[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 -[CLASSES] +# 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= -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - __post_init__ +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make +# 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 valid names for the first argument in a class method. -valid-classmethod-first-arg=cls +# 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 valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=cls +# 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 +# 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 -[IMPORTS] +# 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 -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= +# 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 -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin -# 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 +# List of decorators that change the signature of a decorated function. +signature-mutators= -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules=optparse,tkinter.tix -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled). -ext-import-graph= +[VARIABLES] -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled). -import-graph= +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled). -int-import-graph= +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= +# List of names allowed to shadow builtins +allowed-redefined-builtins= -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant +# 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 -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= +# 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_ -[EXCEPTIONS] +# Tells whether we should check for unused import in __init__ files. +init-import=no -# Exceptions that will emit a warning when being caught. Defaults to -# "BaseException, Exception". -overgeneral-exceptions=BaseException, - Exception +# 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/pybotvac/robot.py b/pybotvac/robot.py index 65cd043..432456a 100644 --- a/pybotvac/robot.py +++ b/pybotvac/robot.py @@ -22,6 +22,7 @@ from .neato import Neato # For default Vendor argument # Disable warning due to SubjectAltNameWarning in certificate +# pylint: disable=no-member urllib3.disable_warnings(urllib3.exceptions.SubjectAltNameWarning) _LOGGER = logging.getLogger(__name__) @@ -136,7 +137,7 @@ def __init__( self.traits = traits self.has_persistent_maps = has_persistent_maps - # pylint: disable=anomalous-backslash-in-string + # pylint: disable=consider-using-f-string self._url = "{endpoint}/vendors/{vendor_name}/robots/{serial}/messages".format( endpoint=re.sub(r":\d+", "", endpoint), # Remove port number vendor_name=vendor.name, @@ -157,6 +158,7 @@ def __init__( ) def __str__(self): + # pylint: disable=consider-using-f-string return "Name: %s, Serial: %s, Secret: %s Traits: %s" % ( self.name, self.serial, @@ -172,6 +174,7 @@ def _message(self, json: dict, schema: Schema): """ try: + # pylint: disable=missing-timeout response = requests.post( self._url, json=json, diff --git a/pybotvac/session.py b/pybotvac/session.py index e471da7..60fac5f 100644 --- a/pybotvac/session.py +++ b/pybotvac/session.py @@ -59,6 +59,7 @@ def _login(self, email: str, password: str): """ try: + # pylint: disable=missing-timeout response = requests.post( urljoin(self.endpoint, "sessions"), json={ @@ -73,6 +74,7 @@ def _login(self, email: str, password: str): response.raise_for_status() access_token = response.json()["access_token"] + # pylint: disable=consider-using-f-string self.headers["Authorization"] = "Token token=%s" % access_token except ( requests.exceptions.ConnectionError, @@ -92,6 +94,7 @@ def get(self, path, **kwargs): url = self.urljoin(path) headers = self.generate_headers(kwargs.pop("headers", None)) try: + # pylint: disable=missing-timeout response = requests.get(url, headers=headers, **kwargs) response.raise_for_status() except ( @@ -205,6 +208,7 @@ def __init__( def send_email_otp(self, email: str): """Request an authorization code via email.""" + # pylint: disable=missing-timeout response = requests.post( self.vendor.passwordless_endpoint, data=json.dumps( @@ -221,6 +225,7 @@ def send_email_otp(self, email: str): def fetch_token_passwordless(self, email: str, code: str): """Fetch an access token using the emailed code.""" + # pylint: disable=missing-timeout response = requests.post( self.vendor.token_endpoint, data=json.dumps( @@ -248,9 +253,11 @@ def get(self, path: str, **kwargs) -> requests.Response: """Make a get request.""" url = self.urljoin(path) headers = self.generate_headers(kwargs.pop("headers", None)) + # pylint: disable=consider-using-f-string headers["Authorization"] = "Auth0Bearer {}".format(self._token.get("id_token")) try: + # pylint: disable=missing-timeout response = requests.get(url, headers=headers) response.raise_for_status() except ( From d6e836511dfb6d29980641fed0f4ddfc75b5fd35 Mon Sep 17 00:00:00 2001 From: Tobias Haase Date: Thu, 4 Apr 2024 19:16:18 +0200 Subject: [PATCH 4/4] fix bandit and flake --- pybotvac/robot.py | 2 +- pybotvac/session.py | 12 +++++------- setup.cfg | 3 ++- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/pybotvac/robot.py b/pybotvac/robot.py index 432456a..8954d36 100644 --- a/pybotvac/robot.py +++ b/pybotvac/robot.py @@ -174,13 +174,13 @@ def _message(self, json: dict, schema: Schema): """ try: - # pylint: disable=missing-timeout response = requests.post( self._url, json=json, verify=self._vendor.cert_path, auth=Auth(self.serial, self.secret), headers=self._headers, + timeout=10, ) response.raise_for_status() schema(response.json()) diff --git a/pybotvac/session.py b/pybotvac/session.py index 60fac5f..97fbdc1 100644 --- a/pybotvac/session.py +++ b/pybotvac/session.py @@ -59,7 +59,6 @@ def _login(self, email: str, password: str): """ try: - # pylint: disable=missing-timeout response = requests.post( urljoin(self.endpoint, "sessions"), json={ @@ -69,6 +68,7 @@ def _login(self, email: str, password: str): "token": binascii.hexlify(os.urandom(64)).decode("utf8"), }, headers=self.headers, + timeout=10, ) response.raise_for_status() @@ -94,8 +94,7 @@ def get(self, path, **kwargs): url = self.urljoin(path) headers = self.generate_headers(kwargs.pop("headers", None)) try: - # pylint: disable=missing-timeout - response = requests.get(url, headers=headers, **kwargs) + response = requests.get(url, headers=headers, timeout=10, **kwargs) response.raise_for_status() except ( requests.exceptions.ConnectionError, @@ -208,7 +207,6 @@ def __init__( def send_email_otp(self, email: str): """Request an authorization code via email.""" - # pylint: disable=missing-timeout response = requests.post( self.vendor.passwordless_endpoint, data=json.dumps( @@ -220,12 +218,12 @@ def send_email_otp(self, email: str): } ), headers={"Content-Type": "application/json"}, + timeout=10, ) response.raise_for_status() def fetch_token_passwordless(self, email: str, code: str): """Fetch an access token using the emailed code.""" - # pylint: disable=missing-timeout response = requests.post( self.vendor.token_endpoint, data=json.dumps( @@ -245,6 +243,7 @@ def fetch_token_passwordless(self, email: str, code: str): } ), headers={"Content-Type": "application/json"}, + timeout=10, ) response.raise_for_status() self._token = response.json() @@ -257,8 +256,7 @@ def get(self, path: str, **kwargs) -> requests.Response: headers["Authorization"] = "Auth0Bearer {}".format(self._token.get("id_token")) try: - # pylint: disable=missing-timeout - response = requests.get(url, headers=headers) + response = requests.get(url, headers=headers, timeout=10) response.raise_for_status() except ( requests.exceptions.ConnectionError, diff --git a/setup.cfg b/setup.cfg index 211a3a7..457e051 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,8 @@ skip = ./.git,./.mypy_cache,./.vscode,./venv exclude = .vscode,venv max-line-length = 88 ignore = - F401, # Import error, pylint covers this + # Import error, pylint covers this + F401, # Formatting errors that are covered by black D202, E203,