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.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:9:0: R0913: Too many arguments (8/5) (too-many-arguments)
src/dictk/translation.py:9:0: R0914: Too many local variables (22/15) (too-many-locals)
************* Module dictk.rosta
src/dictk/rosta.py:99:0: R0913: Too many arguments (6/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.image
src/dictk/image.py:1:0: C0302: Too many lines in module (1032/1000) (too-many-lines)
src/dictk/image.py:92:0: R0913: Too many arguments (6/5) (too-many-arguments)
src/dictk/image.py:92:0: R0914: Too many local variables (16/15) (too-many-locals)
src/dictk/image.py:188:0: R0913: Too many arguments (6/5) (too-many-arguments)
src/dictk/image.py:261:0: R0913: Too many arguments (6/5) (too-many-arguments)
src/dictk/image.py:261:0: R0914: Too many local variables (19/15) (too-many-locals)
src/dictk/image.py:388:0: R0914: Too many local variables (18/15) (too-many-locals)


Report
======
439 statements analysed.

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

+---------+-------+-----------+-----------+------------+---------+
|type     |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module   |5      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|class    |4      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|method   |1      |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|function |36     |NC         |NC         |100.00      |0.00     |
+---------+-------+-----------+-----------+------------+---------+



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

    imageio 
      \-v3 (dictk.image)
    matplotlib 
      \-patches (dictk.image)
      \-pyplot (dictk.image)
    numpy (dictk.cli,dictk.image,dictk.rosta,dictk.translation)
    scipy 
      \-interpolate (dictk.image)
      \-ndimage (dictk.image,dictk.rosta)
    skimage 
      \-registration (dictk.translation)



1637 lines have been analyzed

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

+----------+-------+------+---------+-----------+
|type      |number |%     |previous |difference |
+==========+=======+======+=========+===========+
|code      |755    |46.12 |NC       |NC         |
+----------+-------+------+---------+-----------+
|docstring |632    |38.61 |NC       |NC         |
+----------+-------+------+---------+-----------+
|comment   |66     |4.03  |NC       |NC         |
+----------+-------+------+---------+-----------+
|empty     |184    |11.24 |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 |1      |NC       |NC         |
+-----------+-------+---------+-----------+
|refactor   |11     |NC       |NC         |
+-----------+-------+---------+-----------+
|warning    |0      |NC       |NC         |
+-----------+-------+---------+-----------+
|error      |1      |NC       |NC         |
+-----------+-------+---------+-----------+



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

+------------------+-------+--------+---------+-----------+
|module            |error  |warning |refactor |convention |
+==================+=======+========+=========+===========+
|dictk.translation |100.00 |0.00    |18.18    |0.00       |
+------------------+-------+--------+---------+-----------+
|dictk.image       |0.00   |0.00    |54.55    |100.00     |
+------------------+-------+--------+---------+-----------+
|dictk.cli         |0.00   |0.00    |18.18    |0.00       |
+------------------+-------+--------+---------+-----------+
|dictk.rosta       |0.00   |0.00    |9.09     |0.00       |
+------------------+-------+--------+---------+-----------+



Messages
--------

+------------------------------+------------+
|message id                    |occurrences |
+==============================+============+
|too-many-arguments            |6           |
+------------------------------+------------+
|too-many-locals               |4           |
+------------------------------+------------+
|too-many-positional-arguments |1           |
+------------------------------+------------+
|too-many-lines                |1           |
+------------------------------+------------+
|no-name-in-module             |1           |
+------------------------------+------------+




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