adafruit-circuitpython-pcf8575 1.0.9__tar.gz → 1.0.11__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. adafruit_circuitpython_pcf8575-1.0.11/.gitattributes +11 -0
  2. adafruit_circuitpython_pcf8575-1.0.11/.pre-commit-config.yaml +21 -0
  3. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.readthedocs.yaml +1 -1
  4. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/PKG-INFO +6 -5
  5. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/README.rst +3 -3
  6. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/adafruit_circuitpython_pcf8575.egg-info/PKG-INFO +6 -5
  7. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/adafruit_circuitpython_pcf8575.egg-info/SOURCES.txt +2 -1
  8. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/adafruit_pcf8575.py +6 -13
  9. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/api.rst +3 -0
  10. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/conf.py +2 -6
  11. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/examples/pcf8575_blink16outputs.py +2 -0
  12. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/examples/pcf8575_buttonled.py +2 -0
  13. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/examples/pcf8575_read16inputs.py +2 -0
  14. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/examples/pcf8575_simpletest.py +2 -0
  15. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/pyproject.toml +1 -1
  16. adafruit_circuitpython_pcf8575-1.0.11/ruff.toml +105 -0
  17. adafruit_circuitpython_pcf8575-1.0.9/.pre-commit-config.yaml +0 -42
  18. adafruit_circuitpython_pcf8575-1.0.9/.pylintrc +0 -399
  19. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +0 -0
  20. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.github/workflows/build.yml +0 -0
  21. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.github/workflows/failure-help-text.yml +0 -0
  22. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.github/workflows/release_gh.yml +0 -0
  23. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.github/workflows/release_pypi.yml +0 -0
  24. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/.gitignore +0 -0
  25. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/CODE_OF_CONDUCT.md +0 -0
  26. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/LICENSE +0 -0
  27. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/LICENSES/CC-BY-4.0.txt +0 -0
  28. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/LICENSES/MIT.txt +0 -0
  29. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/LICENSES/Unlicense.txt +0 -0
  30. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/README.rst.license +0 -0
  31. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/adafruit_circuitpython_pcf8575.egg-info/dependency_links.txt +0 -0
  32. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/adafruit_circuitpython_pcf8575.egg-info/requires.txt +0 -0
  33. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/adafruit_circuitpython_pcf8575.egg-info/top_level.txt +0 -0
  34. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/_static/favicon.ico +0 -0
  35. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/_static/favicon.ico.license +0 -0
  36. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/api.rst.license +0 -0
  37. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/examples.rst +0 -0
  38. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/examples.rst.license +0 -0
  39. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/index.rst +0 -0
  40. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/index.rst.license +0 -0
  41. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/docs/requirements.txt +0 -0
  42. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/optional_requirements.txt +0 -0
  43. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/requirements.txt +0 -0
  44. {adafruit_circuitpython_pcf8575-1.0.9 → adafruit_circuitpython_pcf8575-1.0.11}/setup.cfg +0 -0
@@ -0,0 +1,11 @@
1
+ # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: Unlicense
4
+
5
+ .py text eol=lf
6
+ .rst text eol=lf
7
+ .txt text eol=lf
8
+ .yaml text eol=lf
9
+ .toml text eol=lf
10
+ .license text eol=lf
11
+ .md text eol=lf
@@ -0,0 +1,21 @@
1
+ # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: Unlicense
4
+
5
+ repos:
6
+ - repo: https://github.com/pre-commit/pre-commit-hooks
7
+ rev: v4.5.0
8
+ hooks:
9
+ - id: check-yaml
10
+ - id: end-of-file-fixer
11
+ - id: trailing-whitespace
12
+ - repo: https://github.com/astral-sh/ruff-pre-commit
13
+ rev: v0.3.4
14
+ hooks:
15
+ - id: ruff-format
16
+ - id: ruff
17
+ args: ["--fix"]
18
+ - repo: https://github.com/fsfe/reuse-tool
19
+ rev: v3.0.1
20
+ hooks:
21
+ - id: reuse
@@ -12,7 +12,7 @@ sphinx:
12
12
  configuration: docs/conf.py
13
13
 
14
14
  build:
15
- os: ubuntu-20.04
15
+ os: ubuntu-lts-latest
16
16
  tools:
17
17
  python: "3"
18
18
 
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.2
1
+ Metadata-Version: 2.4
2
2
  Name: adafruit-circuitpython-pcf8575
3
- Version: 1.0.9
3
+ Version: 1.0.11
4
4
  Summary: CircuitPython library for Adafruit PCF8575 GPIO expander
5
5
  Author-email: Adafruit Industries <circuitpython@adafruit.com>
6
6
  License: MIT
@@ -17,6 +17,7 @@ License-File: LICENSE
17
17
  Requires-Dist: Adafruit-Blinka
18
18
  Requires-Dist: adafruit-circuitpython-busdevice
19
19
  Provides-Extra: optional
20
+ Dynamic: license-file
20
21
 
21
22
  Introduction
22
23
  ============
@@ -37,9 +38,9 @@ Introduction
37
38
  :alt: Build Status
38
39
 
39
40
 
40
- .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
41
- :target: https://github.com/psf/black
42
- :alt: Code Style: Black
41
+ .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
42
+ :target: https://github.com/astral-sh/ruff
43
+ :alt: Code Style: Ruff
43
44
 
44
45
  CircuitPython library for Adafruit PCF8575 GPIO expander
45
46
 
@@ -17,9 +17,9 @@ Introduction
17
17
  :alt: Build Status
18
18
 
19
19
 
20
- .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
21
- :target: https://github.com/psf/black
22
- :alt: Code Style: Black
20
+ .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
21
+ :target: https://github.com/astral-sh/ruff
22
+ :alt: Code Style: Ruff
23
23
 
24
24
  CircuitPython library for Adafruit PCF8575 GPIO expander
25
25
 
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.2
1
+ Metadata-Version: 2.4
2
2
  Name: adafruit-circuitpython-pcf8575
3
- Version: 1.0.9
3
+ Version: 1.0.11
4
4
  Summary: CircuitPython library for Adafruit PCF8575 GPIO expander
5
5
  Author-email: Adafruit Industries <circuitpython@adafruit.com>
6
6
  License: MIT
@@ -17,6 +17,7 @@ License-File: LICENSE
17
17
  Requires-Dist: Adafruit-Blinka
18
18
  Requires-Dist: adafruit-circuitpython-busdevice
19
19
  Provides-Extra: optional
20
+ Dynamic: license-file
20
21
 
21
22
  Introduction
22
23
  ============
@@ -37,9 +38,9 @@ Introduction
37
38
  :alt: Build Status
38
39
 
39
40
 
40
- .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
41
- :target: https://github.com/psf/black
42
- :alt: Code Style: Black
41
+ .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
42
+ :target: https://github.com/astral-sh/ruff
43
+ :alt: Code Style: Ruff
43
44
 
44
45
  CircuitPython library for Adafruit PCF8575 GPIO expander
45
46
 
@@ -1,6 +1,6 @@
1
+ .gitattributes
1
2
  .gitignore
2
3
  .pre-commit-config.yaml
3
- .pylintrc
4
4
  .readthedocs.yaml
5
5
  CODE_OF_CONDUCT.md
6
6
  LICENSE
@@ -10,6 +10,7 @@ adafruit_pcf8575.py
10
10
  optional_requirements.txt
11
11
  pyproject.toml
12
12
  requirements.txt
13
+ ruff.toml
13
14
  .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
14
15
  .github/workflows/build.yml
15
16
  .github/workflows/failure-help-text.yml
@@ -28,16 +28,17 @@ Implementation Notes
28
28
 
29
29
  try:
30
30
  from typing import Optional
31
+
31
32
  import busio
32
33
  except ImportError:
33
34
  pass
34
35
 
35
36
 
37
+ import digitalio
36
38
  from adafruit_bus_device.i2c_device import I2CDevice
37
39
  from micropython import const
38
- import digitalio
39
40
 
40
- __version__ = "1.0.9"
41
+ __version__ = "1.0.11"
41
42
  __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PCF8575.git"
42
43
 
43
44
  PCF8575_I2CADDR_DEFAULT: int = const(0x20) # Default I2C address
@@ -50,9 +51,7 @@ class PCF8575:
50
51
  :param int address: The I2C device address. Default is :const:`0x20`
51
52
  """
52
53
 
53
- def __init__(
54
- self, i2c_bus: busio.I2C, address: int = PCF8575_I2CADDR_DEFAULT
55
- ) -> None:
54
+ def __init__(self, i2c_bus: busio.I2C, address: int = PCF8575_I2CADDR_DEFAULT) -> None:
56
55
  self.i2c_device = I2CDevice(i2c_bus, address)
57
56
  self._writebuf = bytearray([0, 0])
58
57
  self._readbuf = bytearray([0, 0])
@@ -136,15 +135,11 @@ class DigitalInOut:
136
135
 
137
136
  self._pin = pin_number
138
137
  self._pcf = pcf
139
- self._dir = (
140
- digitalio.Direction.INPUT
141
- ) # this is meaningless but we need something!
138
+ self._dir = digitalio.Direction.INPUT # this is meaningless but we need something!
142
139
 
143
140
  # kwargs in switch functions below are _necessary_ for compatibility
144
141
  # with DigitalInout class (which allows specifying pull, etc. which
145
- # is unused by this class). Do not remove them, instead turn off pylint
146
- # in this case.
147
- # pylint: disable=unused-argument
142
+ # is unused by this class).
148
143
  def switch_to_output(self, value: bool = False, **kwargs) -> None:
149
144
  """Switch the pin state to a digital output with the provided starting
150
145
  value (True/False for high or low, default is False/low).
@@ -170,8 +165,6 @@ class DigitalInOut:
170
165
  self.direction = digitalio.Direction.INPUT
171
166
  self.pull = pull
172
167
 
173
- # pylint: enable=unused-argument
174
-
175
168
  @property
176
169
  def value(self) -> bool:
177
170
  """The value of the pin, either ``True`` for high/pulled-up or
@@ -4,5 +4,8 @@
4
4
  .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
5
5
  .. use this format as the module name: "adafruit_foo.foo"
6
6
 
7
+ API Reference
8
+ #############
9
+
7
10
  .. automodule:: adafruit_pcf8575
8
11
  :members:
@@ -1,12 +1,10 @@
1
- # -*- coding: utf-8 -*-
2
-
3
1
  # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
4
2
  #
5
3
  # SPDX-License-Identifier: MIT
6
4
 
5
+ import datetime
7
6
  import os
8
7
  import sys
9
- import datetime
10
8
 
11
9
  sys.path.insert(0, os.path.abspath(".."))
12
10
 
@@ -52,9 +50,7 @@ project = "Adafruit CircuitPython PCF8575 Library"
52
50
  creation_year = "2022"
53
51
  current_year = str(datetime.datetime.now().year)
54
52
  year_duration = (
55
- current_year
56
- if current_year == creation_year
57
- else creation_year + " - " + current_year
53
+ current_year if current_year == creation_year else creation_year + " - " + current_year
58
54
  )
59
55
  copyright = year_duration + " ladyada"
60
56
  author = "ladyada"
@@ -3,7 +3,9 @@
3
3
  # SPDX-License-Identifier: Unlicense
4
4
 
5
5
  import time
6
+
6
7
  import board
8
+
7
9
  import adafruit_pcf8575
8
10
 
9
11
  print("PCF8575 16 output LED blink test")
@@ -3,8 +3,10 @@
3
3
  # SPDX-License-Identifier: Unlicense
4
4
 
5
5
  import time
6
+
6
7
  import board
7
8
  import digitalio
9
+
8
10
  import adafruit_pcf8575
9
11
 
10
12
  print("PCF8575 digitalio LED + button test")
@@ -3,7 +3,9 @@
3
3
  # SPDX-License-Identifier: Unlicense
4
4
 
5
5
  import time
6
+
6
7
  import board
8
+
7
9
  import adafruit_pcf8575
8
10
 
9
11
  print("PCF8575 16 input button test")
@@ -3,7 +3,9 @@
3
3
  # SPDX-License-Identifier: Unlicense
4
4
 
5
5
  import time
6
+
6
7
  import board
8
+
7
9
  import adafruit_pcf8575
8
10
 
9
11
  print("PCF8575 digitalio LED blink test")
@@ -13,7 +13,7 @@ requires = [
13
13
  [project]
14
14
  name = "adafruit-circuitpython-pcf8575"
15
15
  description = "CircuitPython library for Adafruit PCF8575 GPIO expander"
16
- version = "1.0.9"
16
+ version = "1.0.11"
17
17
  readme = "README.rst"
18
18
  authors = [
19
19
  {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}
@@ -0,0 +1,105 @@
1
+ # SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ target-version = "py38"
6
+ line-length = 100
7
+
8
+ [lint]
9
+ preview = true
10
+ select = ["I", "PL", "UP"]
11
+
12
+ extend-select = [
13
+ "D419", # empty-docstring
14
+ "E501", # line-too-long
15
+ "W291", # trailing-whitespace
16
+ "PLC0414", # useless-import-alias
17
+ "PLC2401", # non-ascii-name
18
+ "PLC2801", # unnecessary-dunder-call
19
+ "PLC3002", # unnecessary-direct-lambda-call
20
+ "E999", # syntax-error
21
+ "PLE0101", # return-in-init
22
+ "F706", # return-outside-function
23
+ "F704", # yield-outside-function
24
+ "PLE0116", # continue-in-finally
25
+ "PLE0117", # nonlocal-without-binding
26
+ "PLE0241", # duplicate-bases
27
+ "PLE0302", # unexpected-special-method-signature
28
+ "PLE0604", # invalid-all-object
29
+ "PLE0605", # invalid-all-format
30
+ "PLE0643", # potential-index-error
31
+ "PLE0704", # misplaced-bare-raise
32
+ "PLE1141", # dict-iter-missing-items
33
+ "PLE1142", # await-outside-async
34
+ "PLE1205", # logging-too-many-args
35
+ "PLE1206", # logging-too-few-args
36
+ "PLE1307", # bad-string-format-type
37
+ "PLE1310", # bad-str-strip-call
38
+ "PLE1507", # invalid-envvar-value
39
+ "PLE2502", # bidirectional-unicode
40
+ "PLE2510", # invalid-character-backspace
41
+ "PLE2512", # invalid-character-sub
42
+ "PLE2513", # invalid-character-esc
43
+ "PLE2514", # invalid-character-nul
44
+ "PLE2515", # invalid-character-zero-width-space
45
+ "PLR0124", # comparison-with-itself
46
+ "PLR0202", # no-classmethod-decorator
47
+ "PLR0203", # no-staticmethod-decorator
48
+ "UP004", # useless-object-inheritance
49
+ "PLR0206", # property-with-parameters
50
+ "PLR0904", # too-many-public-methods
51
+ "PLR0911", # too-many-return-statements
52
+ "PLR0912", # too-many-branches
53
+ "PLR0913", # too-many-arguments
54
+ "PLR0914", # too-many-locals
55
+ "PLR0915", # too-many-statements
56
+ "PLR0916", # too-many-boolean-expressions
57
+ "PLR1702", # too-many-nested-blocks
58
+ "PLR1704", # redefined-argument-from-local
59
+ "PLR1711", # useless-return
60
+ "C416", # unnecessary-comprehension
61
+ "PLR1733", # unnecessary-dict-index-lookup
62
+ "PLR1736", # unnecessary-list-index-lookup
63
+
64
+ # ruff reports this rule is unstable
65
+ #"PLR6301", # no-self-use
66
+
67
+ "PLW0108", # unnecessary-lambda
68
+ "PLW0120", # useless-else-on-loop
69
+ "PLW0127", # self-assigning-variable
70
+ "PLW0129", # assert-on-string-literal
71
+ "B033", # duplicate-value
72
+ "PLW0131", # named-expr-without-context
73
+ "PLW0245", # super-without-brackets
74
+ "PLW0406", # import-self
75
+ "PLW0602", # global-variable-not-assigned
76
+ "PLW0603", # global-statement
77
+ "PLW0604", # global-at-module-level
78
+
79
+ # fails on the try: import typing used by libraries
80
+ #"F401", # unused-import
81
+
82
+ "F841", # unused-variable
83
+ "E722", # bare-except
84
+ "PLW0711", # binary-op-exception
85
+ "PLW1501", # bad-open-mode
86
+ "PLW1508", # invalid-envvar-default
87
+ "PLW1509", # subprocess-popen-preexec-fn
88
+ "PLW2101", # useless-with-lock
89
+ "PLW3301", # nested-min-max
90
+ ]
91
+
92
+ ignore = [
93
+ "PLR2004", # magic-value-comparison
94
+ "UP030", # format literals
95
+ "PLW1514", # unspecified-encoding
96
+ "PLR0913", # too-many-arguments
97
+ "PLR0915", # too-many-statements
98
+ "PLR0917", # too-many-positional-arguments
99
+ "PLR0904", # too-many-public-methods
100
+ "PLR0912", # too-many-branches
101
+ "PLR0916", # too-many-boolean-expressions
102
+ ]
103
+
104
+ [format]
105
+ line-ending = "lf"
@@ -1,42 +0,0 @@
1
- # SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
2
- #
3
- # SPDX-License-Identifier: Unlicense
4
-
5
- repos:
6
- - repo: https://github.com/python/black
7
- rev: 23.3.0
8
- hooks:
9
- - id: black
10
- - repo: https://github.com/fsfe/reuse-tool
11
- rev: v1.1.2
12
- hooks:
13
- - id: reuse
14
- - repo: https://github.com/pre-commit/pre-commit-hooks
15
- rev: v4.4.0
16
- hooks:
17
- - id: check-yaml
18
- - id: end-of-file-fixer
19
- - id: trailing-whitespace
20
- - repo: https://github.com/pycqa/pylint
21
- rev: v2.17.4
22
- hooks:
23
- - id: pylint
24
- name: pylint (library code)
25
- types: [python]
26
- args:
27
- - --disable=consider-using-f-string,duplicate-code
28
- exclude: "^(docs/|examples/|tests/|setup.py$)"
29
- - id: pylint
30
- name: pylint (example code)
31
- description: Run pylint rules on "examples/*.py" files
32
- types: [python]
33
- files: "^examples/"
34
- args:
35
- - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
36
- - id: pylint
37
- name: pylint (test code)
38
- description: Run pylint rules on "tests/*.py" files
39
- types: [python]
40
- files: "^tests/"
41
- args:
42
- - --disable=missing-docstring,consider-using-f-string,duplicate-code
@@ -1,399 +0,0 @@
1
- # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
2
- #
3
- # SPDX-License-Identifier: Unlicense
4
-
5
- [MASTER]
6
-
7
- # A comma-separated list of package or module names from where C extensions may
8
- # be loaded. Extensions are loading into the active Python interpreter and may
9
- # run arbitrary code
10
- extension-pkg-whitelist=
11
-
12
- # Add files or directories to the ignore-list. They should be base names, not
13
- # paths.
14
- ignore=CVS
15
-
16
- # Add files or directories matching the regex patterns to the ignore-list. The
17
- # regex matches against base names, not paths.
18
- ignore-patterns=
19
-
20
- # Python code to execute, usually for sys.path manipulation such as
21
- # pygtk.require().
22
- #init-hook=
23
-
24
- # Use multiple processes to speed up Pylint.
25
- jobs=1
26
-
27
- # List of plugins (as comma separated values of python modules names) to load,
28
- # usually to register additional checkers.
29
- load-plugins=pylint.extensions.no_self_use
30
-
31
- # Pickle collected data for later comparisons.
32
- persistent=yes
33
-
34
- # Specify a configuration file.
35
- #rcfile=
36
-
37
- # Allow loading of arbitrary C extensions. Extensions are imported into the
38
- # active Python interpreter and may run arbitrary code.
39
- unsafe-load-any-extension=no
40
-
41
-
42
- [MESSAGES CONTROL]
43
-
44
- # Only show warnings with the listed confidence levels. Leave empty to show
45
- # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
46
- confidence=
47
-
48
- # Disable the message, report, category or checker with the given id(s). You
49
- # can either give multiple identifiers separated by comma (,) or put this
50
- # option multiple times (only on the command line, not in the configuration
51
- # file where it should appear only once).You can also use "--disable=all" to
52
- # disable everything first and then reenable specific checks. For example, if
53
- # you want to run only the similarities checker, you can use "--disable=all
54
- # --enable=similarities". If you want to run only the classes checker, but have
55
- # no Warning level messages displayed, use"--disable=all --enable=classes
56
- # --disable=W"
57
- # disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
58
- disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
59
-
60
- # Enable the message, report, category or checker with the given id(s). You can
61
- # either give multiple identifier separated by comma (,) or put this option
62
- # multiple time (only on the command line, not in the configuration file where
63
- # it should appear only once). See also the "--disable" option for examples.
64
- enable=
65
-
66
-
67
- [REPORTS]
68
-
69
- # Python expression which should return a note less than 10 (10 is the highest
70
- # note). You have access to the variables errors warning, statement which
71
- # respectively contain the number of errors / warnings messages and the total
72
- # number of statements analyzed. This is used by the global evaluation report
73
- # (RP0004).
74
- evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
75
-
76
- # Template used to display messages. This is a python new-style format string
77
- # used to format the message information. See doc for all details
78
- #msg-template=
79
-
80
- # Set the output format. Available formats are text, parseable, colorized, json
81
- # and msvs (visual studio).You can also give a reporter class, eg
82
- # mypackage.mymodule.MyReporterClass.
83
- output-format=text
84
-
85
- # Tells whether to display a full report or only the messages
86
- reports=no
87
-
88
- # Activate the evaluation score.
89
- score=yes
90
-
91
-
92
- [REFACTORING]
93
-
94
- # Maximum number of nested blocks for function / method body
95
- max-nested-blocks=5
96
-
97
-
98
- [LOGGING]
99
-
100
- # Logging modules to check that the string format arguments are in logging
101
- # function parameter format
102
- logging-modules=logging
103
-
104
-
105
- [SPELLING]
106
-
107
- # Spelling dictionary name. Available dictionaries: none. To make it working
108
- # install python-enchant package.
109
- spelling-dict=
110
-
111
- # List of comma separated words that should not be checked.
112
- spelling-ignore-words=
113
-
114
- # A path to a file that contains private dictionary; one word per line.
115
- spelling-private-dict-file=
116
-
117
- # Tells whether to store unknown words to indicated private dictionary in
118
- # --spelling-private-dict-file option instead of raising a message.
119
- spelling-store-unknown-words=no
120
-
121
-
122
- [MISCELLANEOUS]
123
-
124
- # List of note tags to take in consideration, separated by a comma.
125
- # notes=FIXME,XXX,TODO
126
- notes=FIXME,XXX
127
-
128
-
129
- [TYPECHECK]
130
-
131
- # List of decorators that produce context managers, such as
132
- # contextlib.contextmanager. Add to this list to register other decorators that
133
- # produce valid context managers.
134
- contextmanager-decorators=contextlib.contextmanager
135
-
136
- # List of members which are set dynamically and missed by pylint inference
137
- # system, and so shouldn't trigger E1101 when accessed. Python regular
138
- # expressions are accepted.
139
- generated-members=
140
-
141
- # Tells whether missing members accessed in mixin class should be ignored. A
142
- # mixin class is detected if its name ends with "mixin" (case insensitive).
143
- ignore-mixin-members=yes
144
-
145
- # This flag controls whether pylint should warn about no-member and similar
146
- # checks whenever an opaque object is returned when inferring. The inference
147
- # can return multiple potential results while evaluating a Python object, but
148
- # some branches might not be evaluated, which results in partial inference. In
149
- # that case, it might be useful to still emit no-member and other checks for
150
- # the rest of the inferred objects.
151
- ignore-on-opaque-inference=yes
152
-
153
- # List of class names for which member attributes should not be checked (useful
154
- # for classes with dynamically set attributes). This supports the use of
155
- # qualified names.
156
- ignored-classes=optparse.Values,thread._local,_thread._local
157
-
158
- # List of module names for which member attributes should not be checked
159
- # (useful for modules/projects where namespaces are manipulated during runtime
160
- # and thus existing member attributes cannot be deduced by static analysis. It
161
- # supports qualified module names, as well as Unix pattern matching.
162
- ignored-modules=board
163
-
164
- # Show a hint with possible names when a member name was not found. The aspect
165
- # of finding the hint is based on edit distance.
166
- missing-member-hint=yes
167
-
168
- # The minimum edit distance a name should have in order to be considered a
169
- # similar match for a missing member name.
170
- missing-member-hint-distance=1
171
-
172
- # The total number of similar names that should be taken in consideration when
173
- # showing a hint for a missing member.
174
- missing-member-max-choices=1
175
-
176
-
177
- [VARIABLES]
178
-
179
- # List of additional names supposed to be defined in builtins. Remember that
180
- # you should avoid to define new builtins when possible.
181
- additional-builtins=
182
-
183
- # Tells whether unused global variables should be treated as a violation.
184
- allow-global-unused-variables=yes
185
-
186
- # List of strings which can identify a callback function by name. A callback
187
- # name must start or end with one of those strings.
188
- callbacks=cb_,_cb
189
-
190
- # A regular expression matching the name of dummy variables (i.e. expectedly
191
- # not used).
192
- dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
193
-
194
- # Argument names that match this expression will be ignored. Default to name
195
- # with leading underscore
196
- ignored-argument-names=_.*|^ignored_|^unused_
197
-
198
- # Tells whether we should check for unused import in __init__ files.
199
- init-import=no
200
-
201
- # List of qualified module names which can have objects that can redefine
202
- # builtins.
203
- redefining-builtins-modules=six.moves,future.builtins
204
-
205
-
206
- [FORMAT]
207
-
208
- # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
209
- # expected-line-ending-format=
210
- expected-line-ending-format=LF
211
-
212
- # Regexp for a line that is allowed to be longer than the limit.
213
- ignore-long-lines=^\s*(# )?<?https?://\S+>?$
214
-
215
- # Number of spaces of indent required inside a hanging or continued line.
216
- indent-after-paren=4
217
-
218
- # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
219
- # tab).
220
- indent-string=' '
221
-
222
- # Maximum number of characters on a single line.
223
- max-line-length=100
224
-
225
- # Maximum number of lines in a module
226
- max-module-lines=1000
227
-
228
- # Allow the body of a class to be on the same line as the declaration if body
229
- # contains single statement.
230
- single-line-class-stmt=no
231
-
232
- # Allow the body of an if to be on the same line as the test if there is no
233
- # else.
234
- single-line-if-stmt=no
235
-
236
-
237
- [SIMILARITIES]
238
-
239
- # Ignore comments when computing similarities.
240
- ignore-comments=yes
241
-
242
- # Ignore docstrings when computing similarities.
243
- ignore-docstrings=yes
244
-
245
- # Ignore imports when computing similarities.
246
- ignore-imports=yes
247
-
248
- # Minimum lines number of a similarity.
249
- min-similarity-lines=12
250
-
251
-
252
- [BASIC]
253
-
254
- # Regular expression matching correct argument names
255
- argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
256
-
257
- # Regular expression matching correct attribute names
258
- attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
259
-
260
- # Bad variable names which should always be refused, separated by a comma
261
- bad-names=foo,bar,baz,toto,tutu,tata
262
-
263
- # Regular expression matching correct class attribute names
264
- class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
265
-
266
- # Regular expression matching correct class names
267
- # class-rgx=[A-Z_][a-zA-Z0-9]+$
268
- class-rgx=[A-Z_][a-zA-Z0-9_]+$
269
-
270
- # Regular expression matching correct constant names
271
- const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
272
-
273
- # Minimum line length for functions/classes that require docstrings, shorter
274
- # ones are exempt.
275
- docstring-min-length=-1
276
-
277
- # Regular expression matching correct function names
278
- function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
279
-
280
- # Good variable names which should always be accepted, separated by a comma
281
- # good-names=i,j,k,ex,Run,_
282
- good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
283
-
284
- # Include a hint for the correct naming format with invalid-name
285
- include-naming-hint=no
286
-
287
- # Regular expression matching correct inline iteration names
288
- inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
289
-
290
- # Regular expression matching correct method names
291
- method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
292
-
293
- # Regular expression matching correct module names
294
- module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
295
-
296
- # Colon-delimited sets of names that determine each other's naming style when
297
- # the name regexes allow several styles.
298
- name-group=
299
-
300
- # Regular expression which should only match function or class names that do
301
- # not require a docstring.
302
- no-docstring-rgx=^_
303
-
304
- # List of decorators that produce properties, such as abc.abstractproperty. Add
305
- # to this list to register other decorators that produce valid properties.
306
- property-classes=abc.abstractproperty
307
-
308
- # Regular expression matching correct variable names
309
- variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
310
-
311
-
312
- [IMPORTS]
313
-
314
- # Allow wildcard imports from modules that define __all__.
315
- allow-wildcard-with-all=no
316
-
317
- # Analyse import fallback blocks. This can be used to support both Python 2 and
318
- # 3 compatible code, which means that the block might have code that exists
319
- # only in one or another interpreter, leading to false positives when analysed.
320
- analyse-fallback-blocks=no
321
-
322
- # Deprecated modules which should not be used, separated by a comma
323
- deprecated-modules=optparse,tkinter.tix
324
-
325
- # Create a graph of external dependencies in the given file (report RP0402 must
326
- # not be disabled)
327
- ext-import-graph=
328
-
329
- # Create a graph of every (i.e. internal and external) dependencies in the
330
- # given file (report RP0402 must not be disabled)
331
- import-graph=
332
-
333
- # Create a graph of internal dependencies in the given file (report RP0402 must
334
- # not be disabled)
335
- int-import-graph=
336
-
337
- # Force import order to recognize a module as part of the standard
338
- # compatibility libraries.
339
- known-standard-library=
340
-
341
- # Force import order to recognize a module as part of a third party library.
342
- known-third-party=enchant
343
-
344
-
345
- [CLASSES]
346
-
347
- # List of method names used to declare (i.e. assign) instance attributes.
348
- defining-attr-methods=__init__,__new__,setUp
349
-
350
- # List of member names, which should be excluded from the protected access
351
- # warning.
352
- exclude-protected=_asdict,_fields,_replace,_source,_make
353
-
354
- # List of valid names for the first argument in a class method.
355
- valid-classmethod-first-arg=cls
356
-
357
- # List of valid names for the first argument in a metaclass class method.
358
- valid-metaclass-classmethod-first-arg=mcs
359
-
360
-
361
- [DESIGN]
362
-
363
- # Maximum number of arguments for function / method
364
- max-args=5
365
-
366
- # Maximum number of attributes for a class (see R0902).
367
- # max-attributes=7
368
- max-attributes=11
369
-
370
- # Maximum number of boolean expressions in a if statement
371
- max-bool-expr=5
372
-
373
- # Maximum number of branch for function / method body
374
- max-branches=12
375
-
376
- # Maximum number of locals for function / method body
377
- max-locals=15
378
-
379
- # Maximum number of parents for a class (see R0901).
380
- max-parents=7
381
-
382
- # Maximum number of public methods for a class (see R0904).
383
- max-public-methods=20
384
-
385
- # Maximum number of return / yield for function / method body
386
- max-returns=6
387
-
388
- # Maximum number of statements in function / method body
389
- max-statements=50
390
-
391
- # Minimum number of public methods for a class (see R0903).
392
- min-public-methods=1
393
-
394
-
395
- [EXCEPTIONS]
396
-
397
- # Exceptions that will emit a warning when being caught. Defaults to
398
- # "Exception"
399
- overgeneral-exceptions=builtins.Exception