dictk — pylint report

Informational only: pylint runs alongside ruff (which gates CI) purely to produce this report and the README's pylint score badge. See CONTRIBUTING.md.

************* Module dictk.element
src/dictk/element.py:146:0: C0301: Line too long (112/100) (line-too-long)
src/dictk/element.py:187:0: C0301: Line too long (113/100) (line-too-long)
src/dictk/element.py:233:0: C0301: Line too long (105/100) (line-too-long)
src/dictk/element.py:248:0: C0301: Line too long (121/100) (line-too-long)
src/dictk/element.py:182:32: W0621: Redefining name 'jacobian' from outer scope (line 164) (redefined-outer-name)
src/dictk/element.py:232:28: W0621: Redefining name 'displacement_gradient' from outer scope (line 211) (redefined-outer-name)
src/dictk/element.py:247:29: W0621: Redefining name 'deformation_gradient' from outer scope (line 232) (redefined-outer-name)
src/dictk/element.py:262:18: W0621: Redefining name 'deformation_gradient' from outer scope (line 232) (redefined-outer-name)
************* Module dictk.plot
src/dictk/plot.py:1084:0: C0301: Line too long (101/100) (line-too-long)
src/dictk/plot.py:1714:0: C0301: Line too long (117/100) (line-too-long)
src/dictk/plot.py:1:0: C0302: Too many lines in module (1789/1000) (too-many-lines)
src/dictk/plot.py:46:0: R0913: Too many arguments (6/5) (too-many-arguments)
src/dictk/plot.py:46:0: R0914: Too many local variables (16/15) (too-many-locals)
src/dictk/plot.py:142:0: R0913: Too many arguments (6/5) (too-many-arguments)
src/dictk/plot.py:215:0: R0913: Too many arguments (14/5) (too-many-arguments)
src/dictk/plot.py:215:0: R0914: Too many local variables (32/15) (too-many-locals)
src/dictk/plot.py:215:0: R0915: Too many statements (58/50) (too-many-statements)
src/dictk/plot.py:504:0: R0913: Too many arguments (8/5) (too-many-arguments)
src/dictk/plot.py:504:0: R0914: Too many local variables (28/15) (too-many-locals)
src/dictk/plot.py:663:0: R0914: Too many local variables (28/15) (too-many-locals)
src/dictk/plot.py:851:0: R0913: Too many arguments (11/5) (too-many-arguments)
src/dictk/plot.py:851:0: R0914: Too many local variables (39/15) (too-many-locals)
src/dictk/plot.py:911:4: W0632: Possible unbalanced tuple unpacking with sequence defined at line 2 of : left side has 2 labels, right side has 1 value (unbalanced-tuple-unpacking)
src/dictk/plot.py:851:0: R0915: Too many statements (72/50) (too-many-statements)
src/dictk/plot.py:1073:0: R0913: Too many arguments (8/5) (too-many-arguments)
src/dictk/plot.py:1158:0: R0913: Too many arguments (11/5) (too-many-arguments)
src/dictk/plot.py:1288:0: R0913: Too many arguments (8/5) (too-many-arguments)
src/dictk/plot.py:1288:0: R0914: Too many local variables (22/15) (too-many-locals)
src/dictk/plot.py:1435:0: R0913: Too many arguments (13/5) (too-many-arguments)
src/dictk/plot.py:1435:0: R0914: Too many local variables (39/15) (too-many-locals)
src/dictk/plot.py:1652:0: R0913: Too many arguments (11/5) (too-many-arguments)
src/dictk/plot.py:1652:0: R0914: Too many local variables (24/15) (too-many-locals)
************* Module dictk.correlation
src/dictk/correlation.py:46:0: C0301: Line too long (140/100) (line-too-long)
src/dictk/correlation.py:493:10: E1101: Instance of 'finfo' has no 'eps' member (no-member)
************* Module dictk.grid
src/dictk/grid.py:156:0: C0301: Line too long (118/100) (line-too-long)
src/dictk/grid.py:33:0: R0913: Too many arguments (8/5) (too-many-arguments)
src/dictk/grid.py:65:0: R0913: Too many arguments (9/5) (too-many-arguments)
src/dictk/grid.py:205:0: R0913: Too many arguments (11/5) (too-many-arguments)
src/dictk/grid.py:321:0: R0913: Too many arguments (12/5) (too-many-arguments)
************* Module dictk.cli
src/dictk/cli.py:20:0: R0913: Too many arguments (6/5) (too-many-arguments)
src/dictk/cli.py:20:0: R0917: Too many positional arguments (6/5) (too-many-positional-arguments)
************* Module dictk.rosta
src/dictk/rosta.py:99:0: R0913: Too many arguments (6/5) (too-many-arguments)
************* Module dictk.translation
src/dictk/translation.py:4:0: E0611: No name 'phase_cross_correlation' in module 'skimage.registration' (no-name-in-module)
src/dictk/translation.py:10:0: R0913: Too many arguments (9/5) (too-many-arguments)
src/dictk/translation.py:10:0: R0914: Too many local variables (23/15) (too-many-locals)
src/dictk/translation.py:202:0: R0913: Too many arguments (10/5) (too-many-arguments)
src/dictk/translation.py:202:0: R0914: Too many local variables (24/15) (too-many-locals)
src/dictk/translation.py:1:0: R0801: Similar lines in 2 files
==dictk.image:[72:78]
==dictk.plot:[78:85]
    if width < 1:
        raise ValueError(f"width {width} must be >= 1")
    if height < 1:
        raise ValueError(f"height {height} must be >= 1")

    image_height, image_width = image.shape
 (duplicate-code)


Report
======
934 statements analysed.

Statistics by type
------------------

+---------+-------+-----------+-----------+------------+---------+
|type     |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module   |9      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|class    |9      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|method   |1      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|function |76     |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+



External dependencies
---------------------
::

    imageio 
      \-v3 (dictk.image)
    matplotlib 
      \-patches (dictk.plot)
      \-path (dictk.plot)
      \-patheffects (dictk.plot)
      \-pyplot (dictk.plot)
    numpy (dictk.cli,dictk.correlation,dictk.element,dictk.grid,dictk.image,dictk.plot,dictk.rosta,dictk.translation)
    scipy 
      \-interpolate (dictk.image)
      \-ndimage (dictk.image,dictk.rosta)
    skimage 
      \-registration (dictk.translation)



4585 lines have been analyzed

Raw metrics
-----------

+----------+-------+------+---------+-----------+
|type      |number |%     |previous |difference |
+==========+=======+======+=========+===========+
|code      |1907   |41.59 |NC       |NC         |
+----------+-------+------+---------+-----------+
|docstring |2136   |46.59 |NC       |NC         |
+----------+-------+------+---------+-----------+
|comment   |189    |4.12  |NC       |NC         |
+----------+-------+------+---------+-----------+
|empty     |353    |7.70  |NC       |NC         |
+----------+-------+------+---------+-----------+



Duplication
-----------

+-------------------------+------+---------+-----------+
|                         |now   |previous |difference |
+=========================+======+=========+===========+
|nb duplicated lines      |0     |NC       |NC         |
+-------------------------+------+---------+-----------+
|percent duplicated lines |0.000 |NC       |NC         |
+-------------------------+------+---------+-----------+



Messages by category
--------------------

+-----------+-------+---------+-----------+
|type       |number |previous |difference |
+===========+=======+=========+===========+
|convention |9      |NC       |NC         |
+-----------+-------+---------+-----------+
|refactor   |32     |NC       |NC         |
+-----------+-------+---------+-----------+
|warning    |5      |NC       |NC         |
+-----------+-------+---------+-----------+
|error      |2      |NC       |NC         |
+-----------+-------+---------+-----------+



% errors / warnings by module
-----------------------------

+------------------+------+--------+---------+-----------+
|module            |error |warning |refactor |convention |
+==================+======+========+=========+===========+
|dictk.translation |50.00 |0.00    |15.62    |0.00       |
+------------------+------+--------+---------+-----------+
|dictk.correlation |50.00 |0.00    |0.00     |11.11      |
+------------------+------+--------+---------+-----------+
|dictk.element     |0.00  |80.00   |0.00     |44.44      |
+------------------+------+--------+---------+-----------+
|dictk.plot        |0.00  |20.00   |62.50    |33.33      |
+------------------+------+--------+---------+-----------+
|dictk.grid        |0.00  |0.00    |12.50    |11.11      |
+------------------+------+--------+---------+-----------+
|dictk.cli         |0.00  |0.00    |6.25     |0.00       |
+------------------+------+--------+---------+-----------+
|dictk.rosta       |0.00  |0.00    |3.12     |0.00       |
+------------------+------+--------+---------+-----------+



Messages
--------

+------------------------------+------------+
|message id                    |occurrences |
+==============================+============+
|too-many-arguments            |18          |
+------------------------------+------------+
|too-many-locals               |10          |
+------------------------------+------------+
|line-too-long                 |8           |
+------------------------------+------------+
|redefined-outer-name          |4           |
+------------------------------+------------+
|too-many-statements           |2           |
+------------------------------+------------+
|unbalanced-tuple-unpacking    |1           |
+------------------------------+------------+
|too-many-positional-arguments |1           |
+------------------------------+------------+
|too-many-lines                |1           |
+------------------------------+------------+
|no-name-in-module             |1           |
+------------------------------+------------+
|no-member                     |1           |
+------------------------------+------------+
|duplicate-code                |1           |
+------------------------------+------------+




-----------------------------------
Your code has been rated at 9.40/10