diff --git a/.github/workflows/python-lint.yml b/.github/workflows/python-lint.yml index 32c0773..643bd12 100644 --- a/.github/workflows/python-lint.yml +++ b/.github/workflows/python-lint.yml @@ -3,16 +3,16 @@ name: Lint check -on: [pull_request, push] +on: [pull_request] jobs: test: runs-on: ubuntu-latest steps: - - name: Set up Python 3.7 + - name: Set up Python 3.9 uses: actions/setup-python@v1 with: - python-version: 3.7 + python-version: 3.9 - name: Checkout Current Repo uses: actions/checkout@v2 - name: Install dependencies @@ -25,7 +25,7 @@ jobs: run: git describe --dirty --always --tags - name: Format check with black run: | - black --check -l 80 . + black --check -l 100 . - name: Lint with PyLint run: | pylint py_src/**/*.py diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index dd8b186..0000000 --- a/.pylintrc +++ /dev/null @@ -1,584 +0,0 @@ -[MASTER] - -# 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= - -# Add files or directories to the blacklist. 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= - -# 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. -jobs=0 - -# 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= - -# 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 - - -[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, - missing-class-docstring, - invalid-name, - bad-continuation - -# 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 - - -[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= - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format=LF - -# 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=80 - -# 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 - -# 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 - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - - -[LOGGING] - -# Format style used to check logging format string. `old` means using % -# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings. -logging-format-style=old - -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[BASIC] - -# Naming style matching correct argument names. -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# 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. -#attr-rgx= - -# 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 - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. -#class-attribute-rgx= - -# Naming style matching correct class names. -class-naming-style=snake_case - -# Regular expression matching correct class names. Overrides class-naming- -# style. -#class-rgx= - -# Naming style matching correct constant names. -const-naming-style=any - -# Regular expression matching correct constant names. Overrides const-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. -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - ex, - Run, - _ - -# 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. -#inlinevar-rgx= - -# Naming style matching correct method names. -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-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. -#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 - -# Naming style matching correct variable names. -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style. -#variable-rgx= - - -[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 - - -[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-dict= - -# 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 the implicit-str-concat-in-sequence should -# generate a warning on implicit string concatenation in sequences defined over -# several lines. -check-str-concat-over-line-jumps=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 - -# 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 - - -[IMPORTS] - -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# 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 - -# 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= - -# 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= - -# 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= - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - __post_init__ - -# 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 - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=cls - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "BaseException, Exception". -overgeneral-exceptions=BaseException, - Exception diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..f061d0e --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +python 3.9.16 diff --git a/py_src/gpiod/__init__.py b/py_src/gpiod/__init__.py index 112a1ee..7032e65 100644 --- a/py_src/gpiod/__init__.py +++ b/py_src/gpiod/__init__.py @@ -79,7 +79,7 @@ def make_chip_iter() -> chip_iter: for c in make_chip_iter(): print(c.label) """ - return chip_iter().__iter__() + return iter(chip_iter()) class line_iter(libgpiodcxx.line_iter): diff --git a/py_src/gpiod/kernel/gpio_h.py b/py_src/gpiod/kernel/gpio_h.py index e42e681..350ba36 100644 --- a/py_src/gpiod/kernel/gpio_h.py +++ b/py_src/gpiod/kernel/gpio_h.py @@ -21,7 +21,8 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ -from ctypes import c_char, c_uint8, c_uint32, c_uint64, c_int, Structure +from ctypes import Structure, c_char, c_int, c_uint8, c_uint32, c_uint64 + from .ioctl_h import _IOR, _IOWR # Ref: linux/include/uapi/linux/gpio.h @@ -103,9 +104,7 @@ class gpiohandle_data(Structure): GPIOEVENT_REQUEST_RISING_EDGE = 1 << 0 GPIOEVENT_REQUEST_FALLING_EDGE = 1 << 1 -GPIOEVENT_REQUEST_BOTH_EDGES = ( - GPIOEVENT_REQUEST_RISING_EDGE | GPIOEVENT_REQUEST_FALLING_EDGE -) +GPIOEVENT_REQUEST_BOTH_EDGES = GPIOEVENT_REQUEST_RISING_EDGE | GPIOEVENT_REQUEST_FALLING_EDGE class gpioevent_request(Structure): diff --git a/py_src/gpiod/libgpiod/__init__.py b/py_src/gpiod/libgpiod/__init__.py index 9152b48..209a0a4 100644 --- a/py_src/gpiod/libgpiod/__init__.py +++ b/py_src/gpiod/libgpiod/__init__.py @@ -21,31 +21,24 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ +import select from ctypes import memmove, memset, pointer, set_errno, sizeof from datetime import datetime, timedelta from errno import EBUSY, EINVAL, EIO, ENODEV, ENOENT, ENOTTY, EPERM from fcntl import ioctl -from os import ( - access, - close as os_close, - lstat, - major, - minor, - open as os_open, - O_CLOEXEC, - O_RDWR, - read as os_read, - R_OK, - scandir, -) +from os import O_CLOEXEC, O_RDWR, R_OK, access +from os import close as os_close +from os import lstat, major, minor +from os import open as os_open +from os import read as os_read +from os import scandir from os.path import basename -import select from select import POLLIN, POLLNVAL, POLLPRI from stat import S_ISCHR from typing import Iterator, List, Optional, Union -from .gpiod_h import * from ..kernel import * +from .gpiod_h import * # core.c @@ -71,7 +64,7 @@ def _is_gpiochip_cdev(path: str) -> bool: # Do we have a corresponding sysfs attribute? name = basename(path) - sysfsp = "/sys/bus/gpio/devices/{}/dev".format(name) + sysfsp = f"/sys/bus/gpio/devices/{name}/dev" if not access(sysfsp, R_OK): # This is a character device but not the one we're after. # Before the introduction of this function, we'd fail with @@ -83,10 +76,10 @@ def _is_gpiochip_cdev(path: str) -> bool: # Make sure the major and minor numbers of the character device # correspond to the ones in the dev attribute in sysfs. - devstr = "{}:{}".format(major(statbuf.st_rdev), minor(statbuf.st_rdev)) + devstr = f"{major(statbuf.st_rdev)}:{minor(statbuf.st_rdev)}" try: - with open(sysfsp, "r") as fd: + with open(sysfsp, "r", encoding="utf-8") as fd: sysfsdev = fd.read(len(devstr)) except FileNotFoundError: return False @@ -129,9 +122,7 @@ def gpiod_chip_open(path: str) -> Optional[gpiod_chip]: else: label = info.label.decode() - return gpiod_chip( - num_lines=info.lines, fd=fd, name=info.name.decode(), label=label - ) + return gpiod_chip(num_lines=info.lines, fd=fd, name=info.name.decode(), label=label) def gpiod_chip_close(chip: gpiod_chip) -> None: @@ -316,10 +307,10 @@ def _line_bulk_all_free(bulk: gpiod_line_bulk) -> bool: def _line_request_direction_is_valid(direction: int) -> bool: - if ( - direction == GPIOD_LINE_REQUEST_DIRECTION_AS_IS - or direction == GPIOD_LINE_REQUEST_DIRECTION_INPUT - or direction == GPIOD_LINE_REQUEST_DIRECTION_OUTPUT + if direction in ( + GPIOD_LINE_REQUEST_DIRECTION_AS_IS, + GPIOD_LINE_REQUEST_DIRECTION_INPUT, + GPIOD_LINE_REQUEST_DIRECTION_OUTPUT, ): return True @@ -361,11 +352,7 @@ def _line_request_values( default_vals: List[int], ) -> int: if config.request_type != GPIOD_LINE_REQUEST_DIRECTION_OUTPUT and ( - config.flags - & ( - GPIOD_LINE_REQUEST_FLAG_OPEN_DRAIN - | GPIOD_LINE_REQUEST_FLAG_OPEN_SOURCE - ) + config.flags & (GPIOD_LINE_REQUEST_FLAG_OPEN_DRAIN | GPIOD_LINE_REQUEST_FLAG_OPEN_SOURCE) ): set_errno(EINVAL) return -1 @@ -389,10 +376,7 @@ def _line_request_values( for i in range(bulk.num_lines): req.lineoffsets[i] = bulk[i].offset - if ( - config.request_type == GPIOD_LINE_REQUEST_DIRECTION_OUTPUT - and default_vals - ): + if config.request_type == GPIOD_LINE_REQUEST_DIRECTION_OUTPUT and default_vals: req.default_values[i] = 1 if default_vals[i] else 0 if config.consumer: @@ -423,9 +407,7 @@ def _line_request_values( return 0 -def _line_request_event_single( - line: gpiod_line, config: gpiod_line_request_config -) -> int: +def _line_request_event_single(line: gpiod_line, config: gpiod_line_request_config) -> int: # pylint: disable=no-member req = gpioevent_request() if config.consumer: @@ -461,9 +443,7 @@ def _line_request_event_single( return 0 -def _line_request_events( - bulk: gpiod_line_bulk, config: gpiod_line_request_config -) -> int: +def _line_request_events(bulk: gpiod_line_bulk, config: gpiod_line_request_config) -> int: for i in range(bulk.num_lines): status = _line_request_event_single(bulk[i], config) if status < 0: @@ -583,10 +563,7 @@ def gpiod_line_is_requested(line: gpiod_line) -> bool: @return True if given line was requested, false otherwise. """ - return ( - line.state == _LINE_REQUESTED_VALUES - or line.state == _LINE_REQUESTED_EVENTS - ) + return line.state in (_LINE_REQUESTED_VALUES, _LINE_REQUESTED_EVENTS) def gpiod_line_is_free(line: gpiod_line) -> bool: @@ -670,9 +647,7 @@ def gpiod_line_set_value(line: gpiod_line, value: int) -> int: return gpiod_line_set_value_bulk(bulk, [value]) -def gpiod_line_set_value_bulk( - bulk: gpiod_line_bulk, values: Optional[List[int]] = None -) -> int: +def gpiod_line_set_value_bulk(bulk: gpiod_line_bulk, values: Optional[List[int]] = None) -> int: """ @brief Set the values of a set of GPIO lines. @@ -708,9 +683,7 @@ def gpiod_line_set_value_bulk( return 0 -def gpiod_line_set_config( - line: gpiod_line, direction: int, flags: int, value: int -) -> int: +def gpiod_line_set_config(line: gpiod_line, direction: int, flags: int, value: int) -> int: """ @brief Update the configuration of a single GPIO line. @@ -848,9 +821,7 @@ def gpiod_line_set_direction_input(line: gpiod_line) -> int: @return 0 is the operation succeeds. In case of an error this routine returns -1 and sets the last error number. """ - return gpiod_line_set_config( - line, GPIOD_LINE_REQUEST_DIRECTION_INPUT, line.req_flags, 0 - ) + return gpiod_line_set_config(line, GPIOD_LINE_REQUEST_DIRECTION_INPUT, line.req_flags, 0) def gpiod_line_set_direction_input_bulk(bulk: gpiod_line_bulk) -> int: @@ -882,14 +853,10 @@ def gpiod_line_set_direction_output(line: gpiod_line, value: int) -> int: @return 0 is the operation succeeds. In case of an error this routine returns -1 and sets the last error number. """ - return gpiod_line_set_config( - line, GPIOD_LINE_REQUEST_DIRECTION_OUTPUT, line.req_flags, value - ) + return gpiod_line_set_config(line, GPIOD_LINE_REQUEST_DIRECTION_OUTPUT, line.req_flags, value) -def gpiod_line_set_direction_output_bulk( - bulk: gpiod_line_bulk, values: Optional[List[int]] -) -> int: +def gpiod_line_set_direction_output_bulk(bulk: gpiod_line_bulk, values: Optional[List[int]]) -> int: """ @brief Set the direction of a set of GPIO lines to output. @@ -954,9 +921,7 @@ def gpiod_line_event_wait_bulk( fd_to_line[it.fd_handle.fd] = it timeout_ms = ( - (timeout.days * 86_400_000) - + (timeout.seconds * 1_000) - + (timeout.microseconds / 1000.0) + (timeout.days * 86_400_000) + (timeout.seconds * 1_000) + (timeout.microseconds / 1000.0) ) revents = poll.poll(timeout_ms) diff --git a/py_src/gpiod/libgpiodcxx/__init__.py b/py_src/gpiod/libgpiodcxx/__init__.py index 24d0bce..0c92194 100644 --- a/py_src/gpiod/libgpiodcxx/__init__.py +++ b/py_src/gpiod/libgpiodcxx/__init__.py @@ -62,9 +62,7 @@ def chip_deleter(chip_struct: libgpiod.gpiod_chip) -> None: class shared_chip: # pylint: disable=missing-function-docstring - def __init__( - self, chip_struct: Optional[libgpiod.gpiod_chip] = None - ) -> None: + def __init__(self, chip_struct: Optional[libgpiod.gpiod_chip] = None) -> None: self._chip_struct = chip_struct def get(self) -> Optional[libgpiod.gpiod_chip]: @@ -114,9 +112,7 @@ def __del__(self) -> None: del chip """ - def open( - self, device: Union[int, str], how: int = _CHIP_OPEN_LOOKUP - ) -> None: + def open(self, device: Union[int, str], how: int = _CHIP_OPEN_LOOKUP) -> None: """ @brief Open a GPIO chip. @@ -139,7 +135,7 @@ def open( raise OSError( errno, strerror(errno), - "cannot open GPIO device {}".format(device), + f"cannot open GPIO device {device}", ) self._m_chip = shared_chip(chip_struct) @@ -204,14 +200,10 @@ def get_line(self, offset: int) -> line: if offset >= self.num_lines or offset < 0: raise IndexError("line offset out of range") - line_struct = libgpiod.gpiod_chip_get_line( - self._throw_if_noref_and_get_m_chip(), offset - ) + line_struct = libgpiod.gpiod_chip_get_line(self._throw_if_noref_and_get_m_chip(), offset) if line_struct is None: errno = get_errno() - raise OSError( - errno, strerror(errno), "error getting GPIO line from chip" - ) + raise OSError(errno, strerror(errno), "error getting GPIO line from chip") return line(line_struct, copy(self)) @@ -226,14 +218,10 @@ def find_line(self, name: str) -> line: Usage: l = chip.find_line("PIN_0") """ - line_struct = libgpiod.gpiod_chip_find_line( - self._throw_if_noref_and_get_m_chip(), name - ) + line_struct = libgpiod.gpiod_chip_find_line(self._throw_if_noref_and_get_m_chip(), name) errno = get_errno() if line_struct is None and errno != ENOENT: - raise OSError( - errno, strerror(errno), "error looking up GPIO line by name" - ) + raise OSError(errno, strerror(errno), "error looking up GPIO line by name") return line(line_struct, copy(self)) if bool(line_struct) else line() @@ -469,8 +457,7 @@ def direction(self) -> int: """ return ( self.DIRECTION_INPUT - if self._throw_if_null_and_get_m_line().direction - == libgpiod.GPIOD_LINE_DIRECTION_INPUT + if self._throw_if_null_and_get_m_line().direction == libgpiod.GPIOD_LINE_DIRECTION_INPUT else self.DIRECTION_OUTPUT ) @@ -501,9 +488,7 @@ def bias(self) -> int: Usage: print(line.bias == line.BIAS_PULL_UP) """ - return bias_mapping[ - libgpiod.gpiod_line_bias(self._throw_if_null_and_get_m_line()) - ] + return bias_mapping[libgpiod.gpiod_line_bias(self._throw_if_null_and_get_m_line())] def is_used(self) -> bool: """ @@ -526,9 +511,7 @@ def is_open_drain(self) -> bool: Usage: print(line.is_open_drain()) """ - return libgpiod.gpiod_line_is_open_drain( - self._throw_if_null_and_get_m_line() - ) + return libgpiod.gpiod_line_is_open_drain(self._throw_if_null_and_get_m_line()) def is_open_source(self) -> bool: """ @@ -539,9 +522,7 @@ def is_open_source(self) -> bool: Usage: print(line.is_open_source()) """ - return libgpiod.gpiod_line_is_open_source( - self._throw_if_null_and_get_m_line() - ) + return libgpiod.gpiod_line_is_open_source(self._throw_if_null_and_get_m_line()) def request(self, config: line_request, default_val: int = 0) -> None: """ @@ -592,9 +573,7 @@ def is_requested(self) -> bool: Usage: print(line.is_requested()) """ - return libgpiod.gpiod_line_is_requested( - self._throw_if_null_and_get_m_line() - ) + return libgpiod.gpiod_line_is_requested(self._throw_if_null_and_get_m_line()) def get_value(self) -> int: """ @@ -608,9 +587,7 @@ def get_value(self) -> int: rv = libgpiod.gpiod_line_get_value(self._throw_if_null_and_get_m_line()) if rv == -1: errno = get_errno() - raise OSError( - errno, strerror(errno), "error reading GPIO line value" - ) + raise OSError(errno, strerror(errno), "error reading GPIO line value") return rv @@ -623,14 +600,10 @@ def set_value(self, val: int) -> None: Usage: line.set_value(1) """ - rv = libgpiod.gpiod_line_set_value( - self._throw_if_null_and_get_m_line(), val - ) + rv = libgpiod.gpiod_line_set_value(self._throw_if_null_and_get_m_line(), val) if rv: errno = get_errno() - raise OSError( - errno, strerror(errno), "error setting GPIO line value" - ) + raise OSError(errno, strerror(errno), "error setting GPIO line value") def set_config(self, direction: int, flags: int, value: int = 0) -> None: """ @@ -696,9 +669,7 @@ def event_wait(self, timeout: timedelta) -> bool: else: print("Timeout") """ - rv = libgpiod.gpiod_line_event_wait( - self._throw_if_null_and_get_m_line(), timeout - ) + rv = libgpiod.gpiod_line_event_wait(self._throw_if_null_and_get_m_line(), timeout) if rv < 0: errno = get_errno() raise OSError(errno, strerror(errno), "error polling for events") @@ -749,9 +720,7 @@ def event_get_fd(self) -> int: Usage: fd = line.event_get_fd() """ - ret = libgpiod.gpiod_line_event_get_fd( - self._throw_if_null_and_get_m_line() - ) + ret = libgpiod.gpiod_line_event_get_fd(self._throw_if_null_and_get_m_line()) if ret < 0: errno = get_errno() @@ -785,9 +754,7 @@ def update(self) -> None: if ret < 0: errno = get_errno() - raise OSError( - errno, strerror(errno), "unable to update the line info" - ) + raise OSError(errno, strerror(errno), "unable to update the line info") def reset(self) -> None: """ @@ -917,13 +884,8 @@ def append(self, new_line: line) -> None: if len(self._m_bulk) >= self.MAX_LINES: raise IndexError("maximum number of lines reached") - if ( - len(self._m_bulk) >= 1 - and self._m_bulk[0].get_chip() != new_line.get_chip() - ): - raise ValueError( - "line_bulk cannot hold GPIO lines from different chips" - ) + if len(self._m_bulk) >= 1 and self._m_bulk[0].get_chip() != new_line.get_chip(): + raise ValueError("line_bulk cannot hold GPIO lines from different chips") self._m_bulk.append(new_line) @@ -997,9 +959,7 @@ def clear(self) -> None: """ self._m_bulk.clear() - def request( - self, config: line_request, default_vals: Optional[List[int]] = None - ) -> None: + def request(self, config: line_request, default_vals: Optional[List[int]] = None) -> None: """ @brief Request all lines held by this object. @@ -1021,10 +981,7 @@ def request( default_vals = [0] * self.size if self.size != len(default_vals): - raise ValueError( - "the number of default values must correspond " - "to the number of lines" - ) + raise ValueError("the number of default values must correspond to the number of lines") try: for i in range(self.size): @@ -1076,17 +1033,12 @@ def set_values(self, values: List[int]) -> None: self._throw_if_empty() if self.size != len(values): - raise ValueError( - "the size of values array must correspond to " - "the number of lines" - ) + raise ValueError("the size of values array must correspond to the number of lines") for i in range(self.size): self._m_bulk[i].set_value(values[i]) - def set_config( - self, direction: int, flags: int, values: Optional[List[int]] = None - ) -> None: + def set_config(self, direction: int, flags: int, values: Optional[List[int]] = None) -> None: """ @brief Set configuration of all lines held by this object. @@ -1100,10 +1052,7 @@ def set_config( self._throw_if_empty() if values is not None and self.size != len(values): - raise ValueError( - "the size of values array must correspond to " - "the number of lines" - ) + raise ValueError("the size of values array must correspond to the number of lines") gflags = 0 @@ -1115,14 +1064,10 @@ def set_config( self._to_line_bulk(bulk) - rv = libgpiod.gpiod_line_set_config_bulk( - bulk, direction, gflags, values - ) + rv = libgpiod.gpiod_line_set_config_bulk(bulk, direction, gflags, values) if rv < 0: errno = get_errno() - raise OSError( - errno, strerror(errno), "error setting GPIO line config" - ) + raise OSError(errno, strerror(errno), "error setting GPIO line config") def set_flags(self, flags: int) -> None: """ @@ -1145,9 +1090,7 @@ def set_flags(self, flags: int) -> None: rv = libgpiod.gpiod_line_set_flags_bulk(bulk, gflags) if rv < 0: errno = get_errno() - raise OSError( - errno, strerror(errno), "error setting GPIO line flags" - ) + raise OSError(errno, strerror(errno), "error setting GPIO line flags") def set_direction_input(self) -> None: """ @@ -1178,10 +1121,7 @@ def set_direction_output(self, values: Optional[List[int]] = None) -> None: self._throw_if_empty() if values is not None and self.size != len(values): - raise ValueError( - "the size of values array must correspond to " - "the number of lines" - ) + raise ValueError("the size of values array must correspond to the number of lines") bulk = libgpiod.gpiod_line_bulk() @@ -1285,9 +1225,7 @@ def __iter__(self: CI) -> CI: self._iter = libgpiod.gpiod_chip_iter().__iter__() if self._iter is None: errno = get_errno() - raise OSError( - errno, strerror(errno), "error creating GPIO chip iterator" - ) + raise OSError(errno, strerror(errno), "error creating GPIO chip iterator") return self @@ -1319,9 +1257,7 @@ def __iter__(self: LI) -> LI: self._iter = iter(libgpiod.gpiod_line_iter(self._chip._m_chip.get())) if self._iter is None: errno = get_errno() - raise OSError( - errno, strerror(errno), "error creating GPIO line iterator" - ) + raise OSError(errno, strerror(errno), "error creating GPIO line iterator") return self diff --git a/py_src/gpiod/test/blink.py b/py_src/gpiod/test/blink.py index 10f2d60..aa7a7f1 100644 --- a/py_src/gpiod/test/blink.py +++ b/py_src/gpiod/test/blink.py @@ -1,6 +1,7 @@ # pylint: disable=missing-docstring import sys import time + from .. import chip, line, line_request try: diff --git a/py_src/gpiod/test/bulk_blink.py b/py_src/gpiod/test/bulk_blink.py index db4ec2b..4c4f1f9 100644 --- a/py_src/gpiod/test/bulk_blink.py +++ b/py_src/gpiod/test/bulk_blink.py @@ -1,6 +1,7 @@ # pylint: disable=missing-docstring import sys import time + from .. import chip, line_request try: diff --git a/py_src/gpiod/test/bulk_button.py b/py_src/gpiod/test/bulk_button.py index bb03901..8009c78 100644 --- a/py_src/gpiod/test/bulk_button.py +++ b/py_src/gpiod/test/bulk_button.py @@ -1,7 +1,8 @@ # pylint: disable=missing-docstring import sys from datetime import timedelta -from .. import chip, line_request, line_event + +from .. import chip, line_event, line_request try: if len(sys.argv) > 3: @@ -35,7 +36,7 @@ config.request_type = BUTTON_EDGE for i in range(buttons.size): - config.consumer = "Button {}".format(i) + config.consumer = f"Button {i}" buttons[i].request(config) diff --git a/py_src/gpiod/test/button.py b/py_src/gpiod/test/button.py index 1dad586..d6eb066 100644 --- a/py_src/gpiod/test/button.py +++ b/py_src/gpiod/test/button.py @@ -1,7 +1,8 @@ # pylint: disable=missing-docstring import sys from datetime import timedelta -from .. import chip, line_request, line_event + +from .. import chip, line_event, line_request try: if len(sys.argv) > 2: diff --git a/py_src/gpiod/test/sequential_blink.py b/py_src/gpiod/test/sequential_blink.py index cb49cc5..e5658c0 100644 --- a/py_src/gpiod/test/sequential_blink.py +++ b/py_src/gpiod/test/sequential_blink.py @@ -1,6 +1,7 @@ # pylint: disable=missing-docstring import sys import time + from .. import chip, line_request try: @@ -27,7 +28,7 @@ config.request_type = line_request.DIRECTION_OUTPUT for i in range(leds.size): - config.consumer = "Blink{}".format(i) + config.consumer = f"Blink {i}" leds.get(i).request(config) print("line: ", leds[i].offset, ", consumer: ", leds[i].consumer) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..38b13f6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,559 @@ +[tool.pylint.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 = + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint in +# a server-like mode. +# clear-cache-post-run = + +# 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 = + +# 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 = true + +# Minimum Python version to use for version dependent checks. Will default to the +# version used to run pylint. +py-version = "3.10" + +# Discover python modules and packages in the file system subtree. +# recursive = + +# 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 = true + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +# unsafe-load-any-extension = + +[tool.pylint.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 = "snake_case" + +# 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 = "any" + +# 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 = + +# 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 = + +[tool.pylint.classes] +# Warn about protected attribute access inside special methods +# check-protected-access-in-special-methods = + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods = ["__init__", "__new__", "setUp", "__post_init__"] + +# 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"] + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg = ["cls"] + +[tool.pylint.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 + +[tool.pylint.exceptions] +# Exceptions that will emit a warning when caught. +overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"] + +[tool.pylint.format] +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format = "LF" + +# 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 = 2000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +# single-line-class-stmt = + +# Allow the body of an if to be on the same line as the test if there is no else. +# single-line-if-stmt = + +[tool.pylint.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 = + +# Allow wildcard imports from modules that define __all__. +# allow-wildcard-with-all = + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules = ["optparse", "tkinter.tix"] + +# 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 = + +[tool.pylint.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"] + +[tool.pylint."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", + "missing-class-docstring", + "invalid-name", + "broad-exception-raised", + "too-many-public-methods", + "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"] + +[tool.pylint.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", +] + +[tool.pylint.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 = + +[tool.pylint.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"] + +[tool.pylint.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 = "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 = + +# Tells whether to display a full report or only the messages. +# reports = + +# Activate the evaluation score. +score = true + +[tool.pylint.similarities] +# Comments are removed from the similarity computation +ignore-comments = true + +# Docstrings are removed from the similarity computation +ignore-docstrings = true + +# Imports are removed from the similarity computation +# ignore-imports = + +# Signatures are removed from the similarity computation +ignore-signatures = true + +# Minimum lines number of a similarity. +min-similarity-lines = 4 + +[tool.pylint.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 = + +[tool.pylint.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 +# class is considered mixin if its name matches the mixin-class-rgx option. +# Tells whether to warn about missing members when the owner of the attribute is +# inferred to be None. +ignore-none = true + +# 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 = true + +# 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"] + +# 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 = true + +# 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 = + +[tool.pylint.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 = true + +# 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 = + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules = ["six.moves", "past.builtins", "future.builtins", "builtins", "io"]