panda-python 0.0.0__tar.gz → 0.5.1__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 (75) hide show
  1. panda-python-0.5.1/.github/workflows/build.yml +98 -0
  2. panda-python-0.5.1/.gitignore +2 -0
  3. panda-python-0.5.1/.pylintrc +586 -0
  4. panda-python-0.5.1/.readthedocs.yml +13 -0
  5. panda-python-0.5.1/.vscode/c_cpp_properties.json +18 -0
  6. panda-python-0.5.1/.vscode/generate_docs_api.sh +14 -0
  7. panda-python-0.5.1/.vscode/settings.json +81 -0
  8. panda-python-0.5.1/.vscode/tasks.json +32 -0
  9. panda-python-0.5.1/CMakeLists.txt +68 -0
  10. panda-python-0.5.1/LICENSE +201 -0
  11. panda-python-0.5.1/PKG-INFO +243 -0
  12. panda-python-0.5.1/README.md +15 -0
  13. panda-python-0.5.1/bin/before_install.sh +45 -0
  14. panda-python-0.5.1/bin/build_all.sh +56 -0
  15. panda-python-0.5.1/docs/Makefile +20 -0
  16. panda-python-0.5.1/docs/conf.py +44 -0
  17. panda-python-0.5.1/docs/index.rst +20 -0
  18. panda-python-0.5.1/docs/make.bat +35 -0
  19. panda-python-0.5.1/docs/panda_py.cli.rst +7 -0
  20. panda-python-0.5.1/docs/panda_py.constants.rst +7 -0
  21. panda-python-0.5.1/docs/panda_py.controllers.rst +7 -0
  22. panda-python-0.5.1/docs/panda_py.libfranka.rst +7 -0
  23. panda-python-0.5.1/docs/panda_py.motion.rst +7 -0
  24. panda-python-0.5.1/docs/panda_py.rst +19 -0
  25. panda-python-0.5.1/docs/requirements.txt +3 -0
  26. panda-python-0.5.1/examples/cartesian_impedance.py +24 -0
  27. panda-python-0.5.1/examples/communication_test.py +69 -0
  28. panda-python-0.5.1/examples/mmc.py +80 -0
  29. panda-python-0.5.1/examples/notebooks/benchmark.ipynb +173 -0
  30. panda-python-0.5.1/examples/notebooks/motion.ipynb +156 -0
  31. panda-python-0.5.1/examples/notebooks/paper.ipynb +365 -0
  32. panda-python-0.5.1/include/constants.h +46 -0
  33. panda-python-0.5.1/include/controllers/applied_force.h +37 -0
  34. panda-python-0.5.1/include/controllers/applied_torque.h +35 -0
  35. panda-python-0.5.1/include/controllers/cartesian_impedance.h +52 -0
  36. panda-python-0.5.1/include/controllers/controller.h +23 -0
  37. panda-python-0.5.1/include/controllers/force.h +47 -0
  38. panda-python-0.5.1/include/controllers/integrated_velocity.h +31 -0
  39. panda-python-0.5.1/include/controllers/joint_limits/virtual_wall.h +45 -0
  40. panda-python-0.5.1/include/controllers/joint_limits/virtual_wall_controller.h +52 -0
  41. panda-python-0.5.1/include/controllers/joint_position.h +37 -0
  42. panda-python-0.5.1/include/controllers/trajectory.h +27 -0
  43. panda-python-0.5.1/include/kinematics/fk.h +317 -0
  44. panda-python-0.5.1/include/kinematics/ik.h +422 -0
  45. panda-python-0.5.1/include/motion/generators.h +116 -0
  46. panda-python-0.5.1/include/motion/time_optimal/path.h +96 -0
  47. panda-python-0.5.1/include/motion/time_optimal/trajectory.h +131 -0
  48. panda-python-0.5.1/include/panda.h +140 -0
  49. panda-python-0.5.1/include/utils.h +118 -0
  50. panda-python-0.5.1/logo.jpg +0 -0
  51. panda-python-0.5.1/pyproject.toml +57 -0
  52. panda-python-0.5.1/src/_core.cpp +398 -0
  53. panda-python-0.5.1/src/controllers/applied_force.cpp +72 -0
  54. panda-python-0.5.1/src/controllers/applied_torque.cpp +67 -0
  55. panda-python-0.5.1/src/controllers/cartesian_impedance.cpp +175 -0
  56. panda-python-0.5.1/src/controllers/force.cpp +141 -0
  57. panda-python-0.5.1/src/controllers/integrated_velocity.cpp +71 -0
  58. panda-python-0.5.1/src/controllers/joint_limits/virtual_wall.cpp +158 -0
  59. panda-python-0.5.1/src/controllers/joint_position.cpp +93 -0
  60. panda-python-0.5.1/src/controllers/trajectory.cpp +38 -0
  61. panda-python-0.5.1/src/libfranka.cpp +486 -0
  62. panda-python-0.5.1/src/motion/generators.cpp +193 -0
  63. panda-python-0.5.1/src/motion/time_optimal/path.cpp +285 -0
  64. panda-python-0.5.1/src/motion/time_optimal/trajectory.cpp +616 -0
  65. panda-python-0.5.1/src/panda.cpp +401 -0
  66. panda-python-0.5.1/src/panda_py/__init__.py +307 -0
  67. panda-python-0.5.1/src/panda_py/__init__.pyi +112 -0
  68. panda-python-0.5.1/src/panda_py/_core/__init__.pyi +258 -0
  69. panda-python-0.5.1/src/panda_py/cli.py +81 -0
  70. panda-python-0.5.1/src/panda_py/constants.py +24 -0
  71. panda-python-0.5.1/src/panda_py/controllers.py +16 -0
  72. panda-python-0.5.1/src/panda_py/libfranka/__init__.pyi +844 -0
  73. panda-python-0.5.1/src/panda_py/motion.py +9 -0
  74. panda_python-0.0.0/PKG-INFO +0 -6
  75. panda_python-0.0.0/pyproject.toml +0 -14
@@ -0,0 +1,98 @@
1
+ name: build
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+ release:
9
+ types: [published]
10
+
11
+ env:
12
+ VERSION: 0.5.1
13
+
14
+ permissions: write-all
15
+
16
+ jobs:
17
+ build_wheels:
18
+ name: Build wheels on ubuntu-latest
19
+ runs-on: ubuntu-latest
20
+ steps:
21
+ - uses: actions/checkout@v3
22
+ - uses: actions/setup-python@v3
23
+ - name: Install cibuildwheel
24
+ run: python -m pip install cibuildwheel==2.12.0
25
+ - name: Build wheels
26
+ run: ./bin/build_all.sh
27
+ - uses: actions/upload-artifact@v3
28
+ with:
29
+ path: ./dist/*.whl
30
+ name: dist
31
+ - uses: actions/upload-artifact@v3
32
+ with:
33
+ path: ./archive/*.zip
34
+ name: archive
35
+
36
+ build_sdist:
37
+ name: Build source distribution
38
+ runs-on: ubuntu-latest
39
+ steps:
40
+ - uses: actions/checkout@v3
41
+ - uses: actions/setup-python@v3
42
+ - name: Build sdist
43
+ run: pipx run build --sdist
44
+ - uses: actions/upload-artifact@v3
45
+ with:
46
+ path: dist/*.tar.gz
47
+ name: dist
48
+
49
+ upload:
50
+ name: "Upload wheels"
51
+ needs: [build_wheels, build_sdist]
52
+ runs-on: ubuntu-latest
53
+ if: github.event_name == 'release' && github.event.action == 'published'
54
+ steps:
55
+ - uses: actions/download-artifact@v3
56
+ with:
57
+ name: archive
58
+ path: archive
59
+ - uses: actions/upload-release-asset@v1
60
+ with:
61
+ upload_url: ${{ github.event.release.upload_url }}
62
+ asset_path: ./archive/panda_py_${{ env.VERSION }}_libfranka_0.7.1.zip
63
+ asset_name: panda_py_${{ env.VERSION }}_libfranka_0.7.1.zip
64
+ asset_content_type: application/zip
65
+ env:
66
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
67
+ - uses: actions/upload-release-asset@v1
68
+ with:
69
+ upload_url: ${{ github.event.release.upload_url }}
70
+ asset_path: ./archive/panda_py_${{ env.VERSION }}_libfranka_0.8.0.zip
71
+ asset_name: panda_py_${{ env.VERSION }}_libfranka_0.8.0.zip
72
+ asset_content_type: application/zip
73
+ env:
74
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
75
+ - uses: actions/upload-release-asset@v1
76
+ with:
77
+ upload_url: ${{ github.event.release.upload_url }}
78
+ asset_path: ./archive/panda_py_${{ env.VERSION }}_libfranka_0.9.2.zip
79
+ asset_name: panda_py_${{ env.VERSION }}_libfranka_0.9.2.zip
80
+ asset_content_type: application/zip
81
+ env:
82
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
83
+ - uses: actions/upload-release-asset@v1
84
+ with:
85
+ upload_url: ${{ github.event.release.upload_url }}
86
+ asset_path: ./archive/panda_py_${{ env.VERSION }}_libfranka_0.10.0.zip
87
+ asset_name: panda_py_${{ env.VERSION }}_libfranka_0.10.0.zip
88
+ asset_content_type: application/zip
89
+ env:
90
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
91
+ - uses: actions/download-artifact@v3
92
+ with:
93
+ name: dist
94
+ path: dist
95
+ - uses: pypa/gh-action-pypi-publish@v1.5.0
96
+ with:
97
+ user: __token__
98
+ password: ${{ secrets.PYPI_API_TOKEN }}
@@ -0,0 +1,2 @@
1
+ _build
2
+ __pycache__
@@ -0,0 +1,586 @@
1
+ [MASTER]
2
+
3
+ # A comma-separated list of package or module names from where C extensions may
4
+ # be loaded. Extensions are loading into the active Python interpreter and may
5
+ # run arbitrary code.
6
+ extension-pkg-allow-list=
7
+
8
+ # A comma-separated list of package or module names from where C extensions may
9
+ # be loaded. Extensions are loading into the active Python interpreter and may
10
+ # run arbitrary code. (This is an alternative name to extension-pkg-allow-list
11
+ # for backward compatibility.)
12
+ extension-pkg-whitelist=
13
+
14
+ # Return non-zero exit code if any of these messages/categories are detected,
15
+ # even if score is above --fail-under value. Syntax same as enable. Messages
16
+ # specified are enabled, while categories only check already-enabled messages.
17
+ fail-on=
18
+
19
+ # Specify a score threshold to be exceeded before program exits with error.
20
+ fail-under=10.0
21
+
22
+ # Files or directories to be skipped. They should be base names, not paths.
23
+ ignore=CVS
24
+
25
+ # Add files or directories matching the regex patterns to the ignore-list. The
26
+ # regex matches against paths and can be in Posix or Windows format.
27
+ ignore-paths=
28
+
29
+ # Files or directories matching the regex patterns are skipped. The regex
30
+ # matches against base names, not paths. The default value ignores emacs file
31
+ # locks
32
+ ignore-patterns=^\.#
33
+
34
+ # Python code to execute, usually for sys.path manipulation such as
35
+ # pygtk.require().
36
+ #init-hook=
37
+
38
+ # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
39
+ # number of processors available to use.
40
+ jobs=1
41
+
42
+ # Control the amount of potential inferred values when inferring a single
43
+ # object. This can help the performance when dealing with large functions or
44
+ # complex, nested conditions.
45
+ limit-inference-results=100
46
+
47
+ # List of plugins (as comma separated values of python module names) to load,
48
+ # usually to register additional checkers.
49
+ load-plugins=
50
+
51
+ # Pickle collected data for later comparisons.
52
+ persistent=yes
53
+
54
+ # Minimum Python version to use for version dependent checks. Will default to
55
+ # the version used to run pylint.
56
+ py-version=3.10
57
+
58
+ # Discover python modules and packages in the file system subtree.
59
+ recursive=no
60
+
61
+ # When enabled, pylint would attempt to guess common misconfiguration and emit
62
+ # user-friendly hints instead of false-positive error messages.
63
+ suggestion-mode=yes
64
+
65
+ # Allow loading of arbitrary C extensions. Extensions are imported into the
66
+ # active Python interpreter and may run arbitrary code.
67
+ unsafe-load-any-extension=no
68
+
69
+
70
+ [MESSAGES CONTROL]
71
+
72
+ # Only show warnings with the listed confidence levels. Leave empty to show
73
+ # all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
74
+ # UNDEFINED.
75
+ confidence=
76
+
77
+ # Disable the message, report, category or checker with the given id(s). You
78
+ # can either give multiple identifiers separated by comma (,) or put this
79
+ # option multiple times (only on the command line, not in the configuration
80
+ # file where it should appear only once). You can also use "--disable=all" to
81
+ # disable everything first and then re-enable specific checks. For example, if
82
+ # you want to run only the similarities checker, you can use "--disable=all
83
+ # --enable=similarities". If you want to run only the classes checker, but have
84
+ # no Warning level messages displayed, use "--disable=all --enable=classes
85
+ # --disable=W".
86
+ disable=raw-checker-failed,
87
+ bad-inline-option,
88
+ locally-disabled,
89
+ file-ignored,
90
+ suppressed-message,
91
+ useless-suppression,
92
+ deprecated-pragma,
93
+ use-symbolic-message-instead
94
+
95
+ # Enable the message, report, category or checker with the given id(s). You can
96
+ # either give multiple identifier separated by comma (,) or put this option
97
+ # multiple time (only on the command line, not in the configuration file where
98
+ # it should appear only once). See also the "--disable" option for examples.
99
+ enable=c-extension-no-member
100
+
101
+
102
+ [REPORTS]
103
+
104
+ # Python expression which should return a score less than or equal to 10. You
105
+ # have access to the variables 'fatal', 'error', 'warning', 'refactor',
106
+ # 'convention', and 'info' which contain the number of messages in each
107
+ # category, as well as 'statement' which is the total number of statements
108
+ # analyzed. This score is used by the global evaluation report (RP0004).
109
+ evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
110
+
111
+ # Template used to display messages. This is a python new-style format string
112
+ # used to format the message information. See doc for all details.
113
+ #msg-template=
114
+
115
+ # Set the output format. Available formats are text, parseable, colorized, json
116
+ # and msvs (visual studio). You can also give a reporter class, e.g.
117
+ # mypackage.mymodule.MyReporterClass.
118
+ output-format=text
119
+
120
+ # Tells whether to display a full report or only the messages.
121
+ reports=no
122
+
123
+ # Activate the evaluation score.
124
+ score=yes
125
+
126
+
127
+ [REFACTORING]
128
+
129
+ # Maximum number of nested blocks for function / method body
130
+ max-nested-blocks=5
131
+
132
+ # Complete name of functions that never returns. When checking for
133
+ # inconsistent-return-statements if a never returning function is called then
134
+ # it will be considered as an explicit return statement and no message will be
135
+ # printed.
136
+ never-returning-functions=sys.exit,argparse.parse_error
137
+
138
+
139
+ [BASIC]
140
+
141
+ # Naming style matching correct argument names.
142
+ argument-naming-style=snake_case
143
+
144
+ # Regular expression matching correct argument names. Overrides argument-
145
+ # naming-style. If left empty, argument names will be checked with the set
146
+ # naming style.
147
+ #argument-rgx=
148
+
149
+ # Naming style matching correct attribute names.
150
+ attr-naming-style=snake_case
151
+
152
+ # Regular expression matching correct attribute names. Overrides attr-naming-
153
+ # style. If left empty, attribute names will be checked with the set naming
154
+ # style.
155
+ #attr-rgx=
156
+
157
+ # Bad variable names which should always be refused, separated by a comma.
158
+ bad-names=foo,
159
+ bar,
160
+ baz,
161
+ toto,
162
+ tutu,
163
+ tata
164
+
165
+ # Bad variable names regexes, separated by a comma. If names match any regex,
166
+ # they will always be refused
167
+ bad-names-rgxs=
168
+
169
+ # Naming style matching correct class attribute names.
170
+ class-attribute-naming-style=any
171
+
172
+ # Regular expression matching correct class attribute names. Overrides class-
173
+ # attribute-naming-style. If left empty, class attribute names will be checked
174
+ # with the set naming style.
175
+ #class-attribute-rgx=
176
+
177
+ # Naming style matching correct class constant names.
178
+ class-const-naming-style=UPPER_CASE
179
+
180
+ # Regular expression matching correct class constant names. Overrides class-
181
+ # const-naming-style. If left empty, class constant names will be checked with
182
+ # the set naming style.
183
+ #class-const-rgx=
184
+
185
+ # Naming style matching correct class names.
186
+ class-naming-style=PascalCase
187
+
188
+ # Regular expression matching correct class names. Overrides class-naming-
189
+ # style. If left empty, class names will be checked with the set naming style.
190
+ #class-rgx=
191
+
192
+ # Naming style matching correct constant names.
193
+ const-naming-style=UPPER_CASE
194
+
195
+ # Regular expression matching correct constant names. Overrides const-naming-
196
+ # style. If left empty, constant names will be checked with the set naming
197
+ # style.
198
+ #const-rgx=
199
+
200
+ # Minimum line length for functions/classes that require docstrings, shorter
201
+ # ones are exempt.
202
+ docstring-min-length=-1
203
+
204
+ # Naming style matching correct function names.
205
+ function-naming-style=snake_case
206
+
207
+ # Regular expression matching correct function names. Overrides function-
208
+ # naming-style. If left empty, function names will be checked with the set
209
+ # naming style.
210
+ #function-rgx=
211
+
212
+ # Good variable names which should always be accepted, separated by a comma.
213
+ good-names=i,
214
+ j,
215
+ k,
216
+ ex,
217
+ Run,
218
+ _,
219
+ id
220
+
221
+ # Good variable names regexes, separated by a comma. If names match any regex,
222
+ # they will always be accepted
223
+ good-names-rgxs=
224
+
225
+ # Include a hint for the correct naming format with invalid-name.
226
+ include-naming-hint=no
227
+
228
+ # Naming style matching correct inline iteration names.
229
+ inlinevar-naming-style=any
230
+
231
+ # Regular expression matching correct inline iteration names. Overrides
232
+ # inlinevar-naming-style. If left empty, inline iteration names will be checked
233
+ # with the set naming style.
234
+ #inlinevar-rgx=
235
+
236
+ # Naming style matching correct method names.
237
+ method-naming-style=snake_case
238
+
239
+ # Regular expression matching correct method names. Overrides method-naming-
240
+ # style. If left empty, method names will be checked with the set naming style.
241
+ #method-rgx=
242
+
243
+ # Naming style matching correct module names.
244
+ module-naming-style=snake_case
245
+
246
+ # Regular expression matching correct module names. Overrides module-naming-
247
+ # style. If left empty, module names will be checked with the set naming style.
248
+ #module-rgx=
249
+
250
+ # Colon-delimited sets of names that determine each other's naming style when
251
+ # the name regexes allow several styles.
252
+ name-group=
253
+
254
+ # Regular expression which should only match function or class names that do
255
+ # not require a docstring.
256
+ no-docstring-rgx=^_
257
+
258
+ # List of decorators that produce properties, such as abc.abstractproperty. Add
259
+ # to this list to register other decorators that produce valid properties.
260
+ # These decorators are taken in consideration only for invalid-name.
261
+ property-classes=abc.abstractproperty
262
+
263
+ # Regular expression matching correct type variable names. If left empty, type
264
+ # variable names will be checked with the set naming style.
265
+ #typevar-rgx=
266
+
267
+ # Naming style matching correct variable names.
268
+ variable-naming-style=snake_case
269
+
270
+ # Regular expression matching correct variable names. Overrides variable-
271
+ # naming-style. If left empty, variable names will be checked with the set
272
+ # naming style.
273
+ #variable-rgx=
274
+
275
+
276
+ [SIMILARITIES]
277
+
278
+ # Comments are removed from the similarity computation
279
+ ignore-comments=yes
280
+
281
+ # Docstrings are removed from the similarity computation
282
+ ignore-docstrings=yes
283
+
284
+ # Imports are removed from the similarity computation
285
+ ignore-imports=no
286
+
287
+ # Signatures are removed from the similarity computation
288
+ ignore-signatures=no
289
+
290
+ # Minimum lines number of a similarity.
291
+ min-similarity-lines=4
292
+
293
+
294
+ [LOGGING]
295
+
296
+ # The type of string formatting that logging methods do. `old` means using %
297
+ # formatting, `new` is for `{}` formatting.
298
+ logging-format-style=old
299
+
300
+ # Logging modules to check that the string format arguments are in logging
301
+ # function parameter format.
302
+ logging-modules=logging
303
+
304
+
305
+ [STRING]
306
+
307
+ # This flag controls whether inconsistent-quotes generates a warning when the
308
+ # character used as a quote delimiter is used inconsistently within a module.
309
+ check-quote-consistency=no
310
+
311
+ # This flag controls whether the implicit-str-concat should generate a warning
312
+ # on implicit string concatenation in sequences defined over several lines.
313
+ check-str-concat-over-line-jumps=no
314
+
315
+
316
+ [FORMAT]
317
+
318
+ # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
319
+ expected-line-ending-format=
320
+
321
+ # Regexp for a line that is allowed to be longer than the limit.
322
+ ignore-long-lines=^\s*(# )?<?https?://\S+>?$
323
+
324
+ # Number of spaces of indent required inside a hanging or continued line.
325
+ indent-after-paren=4
326
+
327
+ # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
328
+ # tab).
329
+ indent-string=' '
330
+
331
+ # Maximum number of characters on a single line.
332
+ max-line-length=100
333
+
334
+ # Maximum number of lines in a module.
335
+ max-module-lines=1000
336
+
337
+ # Allow the body of a class to be on the same line as the declaration if body
338
+ # contains single statement.
339
+ single-line-class-stmt=no
340
+
341
+ # Allow the body of an if to be on the same line as the test if there is no
342
+ # else.
343
+ single-line-if-stmt=no
344
+
345
+
346
+ [MISCELLANEOUS]
347
+
348
+ # List of note tags to take in consideration, separated by a comma.
349
+ notes=FIXME,
350
+ XXX,
351
+ TODO
352
+
353
+ # Regular expression of note tags to take in consideration.
354
+ #notes-rgx=
355
+
356
+
357
+ [SPELLING]
358
+
359
+ # Limits count of emitted suggestions for spelling mistakes.
360
+ max-spelling-suggestions=4
361
+
362
+ # Spelling dictionary name. Available dictionaries: none. To make it work,
363
+ # install the 'python-enchant' package.
364
+ spelling-dict=
365
+
366
+ # List of comma separated words that should be considered directives if they
367
+ # appear and the beginning of a comment and should not be checked.
368
+ spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
369
+
370
+ # List of comma separated words that should not be checked.
371
+ spelling-ignore-words=
372
+
373
+ # A path to a file that contains the private dictionary; one word per line.
374
+ spelling-private-dict-file=
375
+
376
+ # Tells whether to store unknown words to the private dictionary (see the
377
+ # --spelling-private-dict-file option) instead of raising a message.
378
+ spelling-store-unknown-words=no
379
+
380
+
381
+ [VARIABLES]
382
+
383
+ # List of additional names supposed to be defined in builtins. Remember that
384
+ # you should avoid defining new builtins when possible.
385
+ additional-builtins=
386
+
387
+ # Tells whether unused global variables should be treated as a violation.
388
+ allow-global-unused-variables=yes
389
+
390
+ # List of names allowed to shadow builtins
391
+ allowed-redefined-builtins=
392
+
393
+ # List of strings which can identify a callback function by name. A callback
394
+ # name must start or end with one of those strings.
395
+ callbacks=cb_,
396
+ _cb
397
+
398
+ # A regular expression matching the name of dummy variables (i.e. expected to
399
+ # not be used).
400
+ dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
401
+
402
+ # Argument names that match this expression will be ignored. Default to name
403
+ # with leading underscore.
404
+ ignored-argument-names=_.*|^ignored_|^unused_
405
+
406
+ # Tells whether we should check for unused import in __init__ files.
407
+ init-import=no
408
+
409
+ # List of qualified module names which can have objects that can redefine
410
+ # builtins.
411
+ redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
412
+
413
+
414
+ [TYPECHECK]
415
+
416
+ # List of decorators that produce context managers, such as
417
+ # contextlib.contextmanager. Add to this list to register other decorators that
418
+ # produce valid context managers.
419
+ contextmanager-decorators=contextlib.contextmanager
420
+
421
+ # List of members which are set dynamically and missed by pylint inference
422
+ # system, and so shouldn't trigger E1101 when accessed. Python regular
423
+ # expressions are accepted.
424
+ generated-members=
425
+
426
+ # Tells whether missing members accessed in mixin class should be ignored. A
427
+ # class is considered mixin if its name matches the mixin-class-rgx option.
428
+ ignore-mixin-members=yes
429
+
430
+ # Tells whether to warn about missing members when the owner of the attribute
431
+ # is inferred to be None.
432
+ ignore-none=yes
433
+
434
+ # This flag controls whether pylint should warn about no-member and similar
435
+ # checks whenever an opaque object is returned when inferring. The inference
436
+ # can return multiple potential results while evaluating a Python object, but
437
+ # some branches might not be evaluated, which results in partial inference. In
438
+ # that case, it might be useful to still emit no-member and other checks for
439
+ # the rest of the inferred objects.
440
+ ignore-on-opaque-inference=yes
441
+
442
+ # List of class names for which member attributes should not be checked (useful
443
+ # for classes with dynamically set attributes). This supports the use of
444
+ # qualified names.
445
+ ignored-classes=optparse.Values,thread._local,_thread._local
446
+
447
+ # List of module names for which member attributes should not be checked
448
+ # (useful for modules/projects where namespaces are manipulated during runtime
449
+ # and thus existing member attributes cannot be deduced by static analysis). It
450
+ # supports qualified module names, as well as Unix pattern matching.
451
+ ignored-modules=
452
+
453
+ # Show a hint with possible names when a member name was not found. The aspect
454
+ # of finding the hint is based on edit distance.
455
+ missing-member-hint=yes
456
+
457
+ # The minimum edit distance a name should have in order to be considered a
458
+ # similar match for a missing member name.
459
+ missing-member-hint-distance=1
460
+
461
+ # The total number of similar names that should be taken in consideration when
462
+ # showing a hint for a missing member.
463
+ missing-member-max-choices=1
464
+
465
+ # Regex pattern to define which classes are considered mixins ignore-mixin-
466
+ # members is set to 'yes'
467
+ mixin-class-rgx=.*[Mm]ixin
468
+
469
+ # List of decorators that change the signature of a decorated function.
470
+ signature-mutators=
471
+
472
+
473
+ [CLASSES]
474
+
475
+ # Warn about protected attribute access inside special methods
476
+ check-protected-access-in-special-methods=no
477
+
478
+ # List of method names used to declare (i.e. assign) instance attributes.
479
+ defining-attr-methods=__init__,
480
+ __new__,
481
+ setUp,
482
+ __post_init__
483
+
484
+ # List of member names, which should be excluded from the protected access
485
+ # warning.
486
+ exclude-protected=_asdict,
487
+ _fields,
488
+ _replace,
489
+ _source,
490
+ _make
491
+
492
+ # List of valid names for the first argument in a class method.
493
+ valid-classmethod-first-arg=cls
494
+
495
+ # List of valid names for the first argument in a metaclass class method.
496
+ valid-metaclass-classmethod-first-arg=cls
497
+
498
+
499
+ [DESIGN]
500
+
501
+ # List of regular expressions of class ancestor names to ignore when counting
502
+ # public methods (see R0903)
503
+ exclude-too-few-public-methods=
504
+
505
+ # List of qualified class names to ignore when counting class parents (see
506
+ # R0901)
507
+ ignored-parents=
508
+
509
+ # Maximum number of arguments for function / method.
510
+ max-args=5
511
+
512
+ # Maximum number of attributes for a class (see R0902).
513
+ max-attributes=7
514
+
515
+ # Maximum number of boolean expressions in an if statement (see R0916).
516
+ max-bool-expr=5
517
+
518
+ # Maximum number of branch for function / method body.
519
+ max-branches=12
520
+
521
+ # Maximum number of locals for function / method body.
522
+ max-locals=15
523
+
524
+ # Maximum number of parents for a class (see R0901).
525
+ max-parents=7
526
+
527
+ # Maximum number of public methods for a class (see R0904).
528
+ max-public-methods=20
529
+
530
+ # Maximum number of return / yield for function / method body.
531
+ max-returns=6
532
+
533
+ # Maximum number of statements in function / method body.
534
+ max-statements=50
535
+
536
+ # Minimum number of public methods for a class (see R0903).
537
+ min-public-methods=2
538
+
539
+
540
+ [IMPORTS]
541
+
542
+ # List of modules that can be imported at any level, not just the top level
543
+ # one.
544
+ allow-any-import-level=
545
+
546
+ # Allow wildcard imports from modules that define __all__.
547
+ allow-wildcard-with-all=no
548
+
549
+ # Analyse import fallback blocks. This can be used to support both Python 2 and
550
+ # 3 compatible code, which means that the block might have code that exists
551
+ # only in one or another interpreter, leading to false positives when analysed.
552
+ analyse-fallback-blocks=no
553
+
554
+ # Deprecated modules which should not be used, separated by a comma.
555
+ deprecated-modules=
556
+
557
+ # Output a graph (.gv or any supported image format) of external dependencies
558
+ # to the given file (report RP0402 must not be disabled).
559
+ ext-import-graph=
560
+
561
+ # Output a graph (.gv or any supported image format) of all (i.e. internal and
562
+ # external) dependencies to the given file (report RP0402 must not be
563
+ # disabled).
564
+ import-graph=
565
+
566
+ # Output a graph (.gv or any supported image format) of internal dependencies
567
+ # to the given file (report RP0402 must not be disabled).
568
+ int-import-graph=
569
+
570
+ # Force import order to recognize a module as part of the standard
571
+ # compatibility libraries.
572
+ known-standard-library=
573
+
574
+ # Force import order to recognize a module as part of a third party library.
575
+ known-third-party=enchant
576
+
577
+ # Couples of modules and preferred modules, separated by a comma.
578
+ preferred-modules=
579
+
580
+
581
+ [EXCEPTIONS]
582
+
583
+ # Exceptions that will emit a warning when being caught. Defaults to
584
+ # "BaseException, Exception".
585
+ overgeneral-exceptions=BaseException,
586
+ Exception
@@ -0,0 +1,13 @@
1
+ version: 2
2
+
3
+ build:
4
+ os: ubuntu-22.04
5
+ tools:
6
+ python: "3.11"
7
+
8
+ sphinx:
9
+ configuration: docs/conf.py
10
+
11
+ python:
12
+ install:
13
+ - requirements: docs/requirements.txt