Introduction of a way to remove background coloration.

This patch fixes #396.

Indeed, before this patch, one couldn't remove the coloured background.

Author: funilrys

PyFunceble/cli/entry_points/pyfunceble/cli.py

@@ -835,6 +835,16 @@ def get_output_control_group_data() -> List[Tuple[List[str], dict]]:
                 % get_configured_value("cli_testing.display_mode.colour"),
             },
         ),
+        (
+            ["--background-colour", "--background-color"],
+            {
+                "dest": "cli_testing.display_mode.background_colour",
+                "action": "store_true",
+                "help": "Activates or disables the background coloration to\n"
+                "STDOUT. %s"
+                % get_configured_value("cli_testing.display_mode.background_colour"),
+            },
+        ),
         (
             ["--display-status"],
             {

PyFunceble/cli/filesystem/printer/stdout.py

@@ -103,20 +103,27 @@ class StdoutPrinter(PrinterBase):
     FOREGROUND_COLORATED: List[str] = ["percentage", "simple"]
 
     _allow_coloration: bool = True
+    _allow_background_coloration: bool = True
 
     def __init__(
         self,
         template_to_use: Optional[str] = None,
         *,
         dataset: Optional[Dict[str, str]] = None,
         allow_coloration: Optional[bool] = None,
+        allow_background_coloration: Optional[bool] = None,
         **kwargs,
     ) -> None:
         if allow_coloration is not None:
             self.allow_coloration = allow_coloration
         else:
             self.guess_allow_coloration()
 
+        if allow_background_coloration is not None:
+            self.allow_background_coloration = allow_background_coloration
+        else:
+            self.guess_allow_background_coloration()
+
         super().__init__(template_to_use=template_to_use, dataset=dataset, **kwargs)
 
     @property
@@ -170,6 +177,63 @@ def guess_allow_coloration(self) -> "StdoutPrinter":
         else:
             self.allow_coloration = self.STD_ALLOW_COLORATION
 
+        return self
+
+    @property
+    def allow_background_coloration(self) -> bool:
+        """
+        Provides the current state of the :code:`_allow_background_coloration`
+        attribute.
+        """
+
+        return self._allow_background_coloration
+
+    @allow_background_coloration.setter
+    def allow_background_coloration(self, value: bool) -> Optional[bool]:
+        """
+        Sets the authorization to use the coloration.
+
+        :param value:
+            The value to set.
+
+        :raise TypeError:
+            When the given :code:`value` is not a :py:class:`str`.
+        :raise ValueError:
+            When teh given :code:`value` is empty.
+        """
+
+        if not isinstance(value, bool):
+            raise TypeError(f"<value> should be {bool}, {type(value)} given.")
+
+        self._allow_background_coloration = value
+
+    def set_allow_background_coloration(self, value: bool) -> "StdoutPrinter":
+        """
+        Sets the authorization to use the coloration.
+
+        :param value:
+            The value to set.
+        """
+
+        self.allow_background_coloration = value
+
+        return self
+
+    def guess_allow_background_coloration(self) -> "StdoutPrinter":
+        """
+        Try to guess and set the :code:`disable_background_coloration` attribute.
+        """
+
+        if PyFunceble.facility.ConfigLoader.is_already_loaded():
+            # pylint: disable=line-too-long
+            self.allow_background_coloration = (
+                PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.background_colour
+            )
+        else:
+            self.allow_background_coloration = True
+
+        return self
+
     def print_interpolated_line(self):
         """
         Prints the interpolated line into the destination.
@@ -186,10 +250,16 @@ def print_interpolated_line(self):
 
             if self.allow_coloration:
                 if self.template_to_use in self.BACKGROUND_COLORATED:
-                    print(
-                        f"{self.STATUS2BACKGROUND_COLOR[status_to_compare]}"
-                        f"{line_to_print}"
-                    )
+                    if self.allow_background_coloration:
+                        print(
+                            f"{self.STATUS2BACKGROUND_COLOR[status_to_compare]}"
+                            f"{line_to_print}"
+                        )
+                    else:
+                        print(
+                            f"{self.STATUS2FORGROUND_COLOR[status_to_compare]}"
+                            f"{line_to_print}"
+                        )
                 elif self.template_to_use in self.FOREGROUND_COLORATED:
                     print(
                         f"{self.STATUS2FORGROUND_COLOR[status_to_compare]}"

PyFunceble/cli/system/launcher.py

@@ -194,7 +194,7 @@ def __init__(self, args: Optional[argparse.Namespace] = None) -> None:
         if self.continuous_integration.authorized:
             self.continuous_integration.init()
 
-        self.stdout_printer.guess_allow_coloration()
+        self.stdout_printer.guess_allow_coloration().guess_allow_background_coloration()
 
         self.manager = multiprocessing.Manager()
 

PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -358,6 +358,11 @@ cli_testing:
     # CLI Argument: --colour | --color
     colour: yes
 
+    # Enable/Disable the printing of background colors.
+    #
+    # CLI Argument: --background-colour | --background-color
+    background_colour: yes
+
     # Set the status to display to STDOUT.
     #
     # WARNING:

PyFunceble/storage.py

@@ -60,7 +60,7 @@
 from PyFunceble.storage_facility import get_config_directory
 
 PROJECT_NAME: str = "PyFunceble"
-PROJECT_VERSION: str = "4.3.0a19.dev (Blue Duckling: Tulip)"
+PROJECT_VERSION: str = "4.3.0a20.dev (Blue Duckling: Tulip)"
 
 DISTRIBUTED_CONFIGURATION_FILENAME: str = ".PyFunceble_production.yaml"
 

docs/use/configuration/parameters/cli-testing.md

@@ -281,6 +281,11 @@ cli_testing:
     # CLI Argument: --colour | --color
     colour: yes
 
+    # Enable/Disable the printing of background colors.
+    #
+    # CLI Argument: --background-colour | --background-color
+    background_colour: yes
+
     # Set the status to display to STDOUT.
     #
     # WARNING:

version.yaml

@@ -1,4 +1,4 @@
-current_version: '4.3.0a19.dev (Blue Duckling: Tulip)'
+current_version: '4.3.0a20.dev (Blue Duckling: Tulip)'
 deprecated:
 - 3.0.21
 - 3.1.20