docs: Updating to ruff and reformating all docstrings

Author: jagalindo

.prospector.yaml

@@ -10,43 +10,41 @@ def env_list(env_variable: str, default: list[str]) -> list[str]:
     if not result:
         return default
 
-    return result.split(':')
+    return result.split(":")
 
 
 # Get plugins folder by environment variable
 
-PLUGIN_PATHS: list[str] = env_list('PLUGIN_PATHS', [])
+PLUGIN_PATHS: list[str] = env_list("PLUGIN_PATHS", [])
 
 if not PLUGIN_PATHS:
-    print('You can configure your plugins with an environment variable: Example:')
-    print('export PLUGIN_PATHS=/home/foo/plugin1:/home/foo/plugin2')
-    want_continue = input('No plugins selected. Do you want to continue? (y/n)')
+    print("You can configure your plugins with an environment variable: Example:")
+    print("export PLUGIN_PATHS=/home/foo/plugin1:/home/foo/plugin2")
+    want_continue = input("No plugins selected. Do you want to continue? (y/n)")
 
-    if not want_continue.lower().startswith('y'):
-        print('See you soon :)')
+    if not want_continue.lower().startswith("y"):
+        print("See you soon :)")
         sys.exit(0)
 
 
 # Create symbolic link
 
-CORE_PLUGIN_DIRECTORY = 'flamapy/metamodels/'
+CORE_PLUGIN_DIRECTORY = "flamapy/metamodels/"
 if not os.path.exists(CORE_PLUGIN_DIRECTORY):
     os.mkdir(CORE_PLUGIN_DIRECTORY)
 
 
 for plugin_path in PLUGIN_PATHS:
     if not os.path.exists(plugin_path):
-        print(f'{plugin_path} path not found')
+        print(f"{plugin_path} path not found")
         continue
 
     plugin_directories = setuptools.find_namespace_packages(
-        plugin_path,
-        include=['flamapy.metamodels.*'],
-        exclude=['flamapy.metamodels.*.*']
+        plugin_path, include=["flamapy.metamodels.*"], exclude=["flamapy.metamodels.*.*"]
     )
 
     for plugin_directory in plugin_directories:
-        src = os.path.join(plugin_path, plugin_directory.replace('.', '/'))
-        dst = os.path.join(CORE_PLUGIN_DIRECTORY, plugin_directory.split('.')[-1])
+        src = os.path.join(plugin_path, plugin_directory.replace(".", "/"))
+        dst = os.path.join(CORE_PLUGIN_DIRECTORY, plugin_directory.split(".")[-1])
         if os.path.exists(src) and not os.path.exists(dst):
             os.symlink(src, dst)

configure_plugins.py

@@ -1,3 +1,3 @@
 PLUGIN_PATHS = [
-    'flamapy.metamodels',
+    "flamapy.metamodels",
 ]

flamapy/core/config.py

@@ -11,18 +11,14 @@
 from flamapy.core.exceptions import ConfigurationNotFound
 from flamapy.core.models import VariabilityModel
 from flamapy.core.operations import Operation
-from flamapy.core.plugins import (
-    Operations,
-    Plugin,
-    Plugins
-)
+from flamapy.core.plugins import Operations, Plugin, Plugins
 from flamapy.core.transformations import Transformation
 from flamapy.core.transformations.text_to_model import TextToModel
 from flamapy.core.transformations.model_to_model import ModelToModel
 from flamapy.metamodels.configuration_metamodel.models.configuration import Configuration
 
 
-LOGGER = logging.getLogger('discover')
+LOGGER = logging.getLogger("discover")
 
 
 @runtime_checkable
@@ -38,7 +34,7 @@ def filter_modules_from_plugin_paths() -> list[ModuleType]:
             module: ModuleType = import_module(path)
             results.append(module)
         except ModuleNotFoundError:
-            LOGGER.exception('ModuleNotFoundError %s', path)
+            LOGGER.exception("ModuleNotFoundError %s", path)
     return results
 
 
@@ -49,9 +45,7 @@ def __init__(self) -> None:
 
     def search_classes(self, module: ModuleType) -> list[Any]:
         classes = []
-        for _, file_name, ispkg in iter_modules(
-            module.__path__, module.__name__ + '.'
-        ):
+        for _, file_name, ispkg in iter_modules(module.__path__, module.__name__ + "."):
             if ispkg:
                 classes += self.search_classes(import_module(file_name))
             else:
@@ -62,9 +56,7 @@ def search_classes(self, module: ModuleType) -> list[Any]:
     def discover(self) -> Plugins:
         plugins = Plugins()
         for pkg in self.module_paths:
-            for _, plugin_name, ispkg in iter_modules(
-                pkg.__path__, pkg.__name__ + '.'
-            ):
+            for _, plugin_name, ispkg in iter_modules(pkg.__path__, pkg.__name__ + "."):
                 if not ispkg:
                     continue
                 module = import_module(plugin_name)
@@ -90,7 +82,7 @@ def reload(self) -> None:
         self.plugins = self.discover()
 
     def get_operations(self) -> list[Type[Operation]]:
-        """ Get the operations for all modules """
+        """Get the operations for all modules"""
         operations: list[Type[Operation]] = []
         for plugin in self.plugins:
             operations += plugin.operations
@@ -100,54 +92,51 @@ def get_name_operations(self) -> list[str]:
         operations = []
         for operation in self.get_operations():
             operations.append(operation.__name__)
-            base = operation.__base__.__name__ if operation.__base__ else ''
-            if base != 'ABC':
+            base = operation.__base__.__name__ if operation.__base__ else ""
+            if base != "ABC":
                 operations.append(base)
 
         return operations
 
     def get_transformations(self) -> list[Type[Transformation]]:
-        """ Get transformations for all modules """
+        """Get transformations for all modules"""
         transformations: list[Type[Transformation]] = []
         for plugin in self.plugins:
             transformations += plugin.transformations
         return transformations
 
     def get_transformations_t2m(self) -> list[Type[TextToModel]]:
-        """ Get t2m transformations for all modules """
+        """Get t2m transformations for all modules"""
 
         transformations: list[Type[TextToModel]] = []
         for plugin in self.plugins:
-            transformations += [
-                t for t in plugin.transformations if issubclass(t, TextToModel)
-            ]
+            transformations += [t for t in plugin.transformations if issubclass(t, TextToModel)]
         return transformations
 
     def get_transformations_m2m(self) -> list[Type[ModelToModel]]:
-        """ Get m2m transformations for all modules """
+        """Get m2m transformations for all modules"""
 
         transformations: list[Type[ModelToModel]] = []
         for plugin in self.plugins:
-            transformations += [
-                t for t in plugin.transformations if issubclass(t, ModelToModel)
-            ]
+            transformations += [t for t in plugin.transformations if issubclass(t, ModelToModel)]
         return transformations
 
     def get_operations_by_plugin(self, plugin_name: str) -> Operations:
         return self.plugins.get_operations_by_plugin_name(plugin_name)
 
     def get_plugins_with_operation(self, operation_name: str) -> list[Plugin]:
         return [
-            plugin for plugin in self.plugins
+            plugin
+            for plugin in self.plugins
             if operation_name in self.get_name_operations_by_plugin(plugin.name)
         ]
 
     def get_name_operations_by_plugin(self, plugin_name: str) -> list[str]:
         operations = []
         for operation in self.get_operations_by_plugin(plugin_name):
             operations.append(operation.__name__)
-            base = operation.__base__.__name__ if operation.__base__ else ''
-            if base != 'ABC':
+            base = operation.__base__.__name__ if operation.__base__ else ""
+            if base != "ABC":
                 operations.append(base)
 
         return operations
@@ -186,25 +175,22 @@ def use_operation_from_vm(
         vm_orig: VariabilityModel,
         plugin_name: Optional[str] = None,
         configuration_file: Optional[str] = None,
-        is_full: Optional[bool] = False
+        is_full: Optional[bool] = False,
     ) -> Any:
-
         if operation_name not in self.get_name_operations():
             raise OperationNotFound()
         vm_temp = vm_orig
         if plugin_name is not None:
             plugin = self.plugins.get_plugin_by_name(plugin_name)
-            #vm_temp = plugin.use_transformation_t2m(file)
+            # vm_temp = plugin.use_transformation_t2m(file)
         else:
-            #vm_temp = self.__transform_to_model_from_file(file)
-            plugin = self.plugins.get_plugin_by_extension(
-                vm_orig.get_extension())
+            # vm_temp = self.__transform_to_model_from_file(file)
+            plugin = self.plugins.get_plugin_by_extension(vm_orig.get_extension())
 
             if operation_name not in self.get_name_operations_by_plugin(plugin.name):
-                transformation_way = self.__search_transformation_way(
-                    plugin, operation_name)
+                transformation_way = self.__search_transformation_way(plugin, operation_name)
 
-                for (_, dst) in transformation_way:
+                for _, dst in transformation_way:
                     _plugin = self.plugins.get_plugin_by_extension(dst)
                     vm_temp = _plugin.use_transformation_m2m(vm_temp, dst)
                     plugin = _plugin
@@ -230,9 +216,8 @@ def use_operation_from_file(
         file: str,
         plugin_name: Optional[str] = None,
         configuration_file: Optional[str] = None,
-        is_full: Optional[bool] = False
+        is_full: Optional[bool] = False,
     ) -> Any:
-
         if operation_name not in self.get_name_operations():
             raise OperationNotFound()
 
@@ -241,14 +226,12 @@ def use_operation_from_file(
             vm_temp = plugin.use_transformation_t2m(file)
         else:
             vm_temp = self.__transform_to_model_from_file(file)
-            plugin = self.plugins.get_plugin_by_extension(
-                vm_temp.get_extension())
+            plugin = self.plugins.get_plugin_by_extension(vm_temp.get_extension())
 
             if operation_name not in self.get_name_operations_by_plugin(plugin.name):
-                transformation_way = self.__search_transformation_way(
-                    plugin, operation_name)
+                transformation_way = self.__search_transformation_way(plugin, operation_name)
 
-                for (_, dst) in transformation_way:
+                for _, dst in transformation_way:
                     _plugin = self.plugins.get_plugin_by_extension(dst)
                     vm_temp = _plugin.use_transformation_m2m(vm_temp, dst)
                     plugin = _plugin
@@ -268,10 +251,9 @@ def use_operation_from_file(
 
     def __transform_to_model_from_file(self, file: str) -> VariabilityModel:
         t2m_transformations = self.get_transformations_t2m()
-        extension = file.split('.')[-1]
+        extension = file.split(".")[-1]
         t2m_filters = filter(
-            lambda t2m: t2m.get_source_extension() == extension,
-            t2m_transformations
+            lambda t2m: t2m.get_source_extension() == extension, t2m_transformations
         )
 
         t2m = next(t2m_filters, None)
@@ -281,27 +263,21 @@ def __transform_to_model_from_file(self, file: str) -> VariabilityModel:
         return t2m(file).transform()
 
     def __search_transformation_way(
-        self,
-        plugin: Plugin,
-        operation_name: str
+        self, plugin: Plugin, operation_name: str
     ) -> list[tuple[str, str]]:
-        '''
+        """
         Search way to reach plugin with operation_name using m2m transformations
-        '''
+        """
         way: list[tuple[str, str]] = []
 
-        plugins_with_operation = self.get_plugins_with_operation(
-            operation_name)
+        plugins_with_operation = self.get_plugins_with_operation(operation_name)
         m2m_transformations = self.get_transformations_m2m()
 
         input_extension = plugin.get_extension()
 
         def __search_recursive_way(
-            input_extension: str,
-            output_extension: str,
-            tmp_way: list[tuple[str, str]]
+            input_extension: str, output_extension: str, tmp_way: list[tuple[str, str]]
         ) -> list[tuple[str, str]]:
-
             for m2m in m2m_transformations:
                 in_m2m = m2m.get_source_extension()
                 out_m2m = m2m.get_destination_extension()
@@ -327,4 +303,4 @@ def __search_recursive_way(
             if way and output_extension == way[-1][1]:
                 return way
 
-        raise NotImplementedError('Way to execute operation not found')
+        raise NotImplementedError("Way to execute operation not found")

flamapy/core/discover.py

@@ -1,4 +1,4 @@
 from .variability_model import VariabilityModel, VariabilityElement  # pylint: disable=cyclic-import
 from .ast import AST, ASTOperation  # pylint: disable=cyclic-import
 
-__all__ = ["VariabilityModel",  "AST", "VariabilityElement", "ASTOperation"]
+__all__ = ["AST", "ASTOperation", "VariabilityElement", "VariabilityModel"]