Merge pull request #13 from ForNeus57/feature/pylint

feat: Added pyint linter

Author: ForNeus57

.github/workflows/python_linter.yaml

@@ -32,3 +32,6 @@ jobs:
 
       - name: Run flake8
         run: make flake8
+
+      - name: Run pylint
+        run: make pylint

.pylintrc

@@ -0,0 +1,2 @@
+[FORMAT]
+max-line-length=120

Makefile

@@ -1,4 +1,4 @@
-all:
+all: clang-tidy mypy ruff flake8 pylint
 	echo 'All'
 
 python-install:
@@ -23,4 +23,7 @@ ruff:
 	ruff check ./src/python/
 
 flake8:
-	flake8 ./src/python/
+	flake8 --ignore=E127 ./src/python/
+
+pylint:
+	pylint ./src/python/

setup.cfg

@@ -35,10 +35,10 @@ console_scripts =
 
 [options.extras_require]
 development =
-    mypy==1.18.2,
-    ruff==0.14.6,
-    flake8==7.3.0,
-    pylint==4.0.2,
+    mypy==1.18.2
+    ruff==0.14.6
+    flake8==7.3.0
+    pylint==4.0.2
     nbqa==1.9.1
     pytest==9.0.1
 

src/python/app/command/io.py

@@ -1,15 +1,21 @@
+"""Module for input/output operations related to parsing commandline"""
+
 from sys import stdin, stdout
 from typing import BinaryIO
 
 
 def map_input(input_source: str) -> BinaryIO:
+    """Maps input source to stdin or to the file path"""
+
     if input_source is None:
         return stdin.buffer
 
     return open(input_source, mode='rb')
 
 
 def map_output(output_source: str) -> BinaryIO:
+    """Maps output source to stdout or to the file path"""
+
     if output_source is None:
         return stdout.buffer
 

src/python/app/command/parser.py

@@ -1,27 +1,23 @@
+"""Module containing functions that provide functionality related to commandline arguments parsing"""
+
 from argparse import ArgumentParser, Namespace
 from typing import Callable
 
 from app.command.io import map_input, map_output
 from app.io.format_factory import get_reader_from_format, KnownFormat, get_writer_from_format
-from app.operation.bgr2rgb import BGR2RGBOperation
-from app.operation.flip import FlipOperation
-from app.operation.grayscale import GrayscaleOperation
-from app.operation.histogram_equalization import HistogramEqualizationOperation
-from app.operation.identity import IdentityOperation
-from app.operation.operation import Operation
-from app.operation.roll import RollOperation
-
-from app.operation.rotate90 import Rotate90Operation
+from app.operation import Rotate90, Identity, Flip, BGR2RGB, Roll, Grayscale, HistogramEqualization, IOperation
 
 
 def get_parser() -> ArgumentParser:
+    """Functions that initialises the Argument Parser"""
+
     parser = ArgumentParser(prog='PROG',
                             description='Image CLI that performs different image operations like scaling, rotating etc')
-    parser.add_argument('input',
+    parser.add_argument('--input',
                         nargs='?',
                         default=None,
                         help='program input')
-    parser.add_argument('output',
+    parser.add_argument('--output',
                         nargs='?',
                         default=None,
                         help='program output')
@@ -32,7 +28,7 @@ def get_parser() -> ArgumentParser:
                         help='program output')
 
     subparser = parser.add_subparsers(required=True,
-                                      help='Command to be performed on an image')
+                                      help='Command or operation to be performed on an image')
 
     for operation_class in available_commands():
         operation = operation_class()
@@ -46,7 +42,8 @@ def get_parser() -> ArgumentParser:
     return parser
 
 
-def prepare_command(command: Operation) -> Callable[[Namespace], int]:
+def prepare_command(command: IOperation) -> Callable[[Namespace], int]:
+    """Function that decorates the operation in order to provide input and output to it"""
 
     def wrapper(args: Namespace) -> int:
         data_format = KnownFormat.from_string(args.format)
@@ -64,12 +61,14 @@ def wrapper(args: Namespace) -> int:
 
 
 def available_commands():
+    """Function that returns all the supported commandline operations by the program"""
+
     return [
-        Rotate90Operation,
-        IdentityOperation,
-        FlipOperation,
-        BGR2RGBOperation,
-        RollOperation,
-        GrayscaleOperation,
-        HistogramEqualizationOperation,
+        Rotate90,
+        Identity,
+        Flip,
+        BGR2RGB,
+        Roll,
+        Grayscale,
+        HistogramEqualization,
     ]

src/python/app/error/app_exception.py

@@ -1,2 +1,5 @@
+"""Module providing root class for all exceptions in this pacakge"""
+
+
 class AppException(Exception):
-    pass
+    """Root of the exceptions to provided by this package"""

src/python/app/error/invalid_format_exception.py

@@ -1,5 +1,13 @@
+"""Module providing invalid format exception"""
+
 from app.error.app_exception import AppException
 
 
-class UnknownFormatException(AppException):
-    pass
+class InvalidFormatException(AppException):
+    """Class that signals that the format is known, but the is some error in the binary related to the image"""
+
+    def __init__(self, message: str) -> None:
+        self.message = message
+
+    def __str__(self) -> str:
+        return self.message

src/python/app/error/unknown_format_exception.py

@@ -1,7 +1,10 @@
+"""Module providing unknown format exception"""
+
 from app.error.app_exception import AppException
 
 
 class UnknownFormatException(AppException):
+    """The image is provided in unsupported format"""
 
     def __init__(self, data_format: str) -> None:
         self.data_format = data_format

src/python/app/image/image.py

@@ -1,3 +1,5 @@
+"""Module implementing the image class used in the operations"""
+
 from dataclasses import dataclass
 from typing import final
 
@@ -7,4 +9,6 @@
 @final
 @dataclass(slots=True)
 class Image:
+    """Class that stores the image object as a numpy array"""
+
     data: np.ndarray