Merge pull request #341 from pyiron/rename

Rename classes to QueueAdapterCore and QueueAdapterWithConfig

pysqa/ext/modular.py

@@ -2,11 +2,11 @@
 
 import pandas
 
-from pysqa.utils.basic import BasisQueueAdapter
+from pysqa.utils.basic import QueueAdapterWithConfig
 from pysqa.utils.execute import execute_command
 
 
-class ModularQueueAdapter(BasisQueueAdapter):
+class ModularQueueAdapter(QueueAdapterWithConfig):
     """
     A class representing a modular queue adapter.
 

pysqa/ext/remote.py

@@ -8,11 +8,11 @@
 import paramiko
 from tqdm import tqdm
 
-from pysqa.utils.basic import BasisQueueAdapter
+from pysqa.utils.basic import QueueAdapterWithConfig
 from pysqa.utils.execute import execute_command
 
 
-class RemoteQueueAdapter(BasisQueueAdapter):
+class RemoteQueueAdapter(QueueAdapterWithConfig):
     """
     A class representing a remote queue adapter.
 

pysqa/queueadapter.py

@@ -4,7 +4,7 @@
 import pandas
 
 from pysqa.ext.modular import ModularQueueAdapter
-from pysqa.utils.basic import BasisQueueAdapter
+from pysqa.utils.basic import QueueAdapterWithConfig
 from pysqa.utils.config import read_config
 from pysqa.utils.execute import execute_command
 
@@ -351,7 +351,7 @@ def set_queue_adapter(
         directory (str): directory which contains the queue configurations
     """
     if config["queue_type"] in ["SGE", "TORQUE", "SLURM", "LSF", "MOAB", "FLUX"]:
-        return BasisQueueAdapter(
+        return QueueAdapterWithConfig(
             config=config, directory=directory, execute_command=execute_command
         )
     elif config["queue_type"] in ["GENT"]:

pysqa/utils/basic.py

@@ -5,13 +5,13 @@
 from jinja2 import Template
 from jinja2.exceptions import TemplateSyntaxError
 
-from pysqa.utils.core import CoreQueueAdapter
+from pysqa.utils.core import QueueAdapterCore
 from pysqa.utils.execute import execute_command
 from pysqa.utils.queues import Queues
 from pysqa.utils.validate import value_error_if_none, value_in_range
 
 
-class BasisQueueAdapter(CoreQueueAdapter):
+class QueueAdapterWithConfig(QueueAdapterCore):
     """
     The goal of the QueueAdapter class is to make submitting to a queue system as easy as starting another sub process
     locally.

pysqa/utils/core.py

@@ -71,7 +71,7 @@ def get_queue_commands(queue_type: str) -> Union[SchedulerCommands, None]:
         )
 
 
-class CoreQueueAdapter(object):
+class QueueAdapterCore(object):
     """
     The goal of the QueueAdapter class is to make submitting to a queue system as easy as starting another sub process
     locally.

tests/test_basic.py

@@ -5,7 +5,7 @@
 import unittest
 from jinja2.exceptions import TemplateSyntaxError
 from pysqa import QueueAdapter
-from pysqa.utils.basic import BasisQueueAdapter
+from pysqa.utils.basic import QueueAdapterWithConfig
 from pysqa.utils.validate import value_in_range
 
 __author__ = "Jan Janssen"
@@ -34,7 +34,7 @@ def test_bad_queue_template(self):
 class TestBasisQueueAdapter(unittest.TestCase):
     def test_bad_queue_type(self):
         with self.assertRaises(ValueError):
-            BasisQueueAdapter(config={"queue_type": "error", "queues": {}})
+            QueueAdapterWithConfig(config={"queue_type": "error", "queues": {}})
 
     def test_memory_string_comparison(self):
         self.assertEqual(value_in_range(1023, value_min="1K"), "1K")