multiple: explicitly set attr.s cmp parameter

We mostly don't need the compare functionality of attrs. Disable it to fall back
to object id hashes (similar to python standard classes). The only exception is
the ResourceMatch class, since we collect these into a list and need to remove
them later on. The list remove function requires the implementation of the
compare functions, explicitly enable it for the ResourceMatch class.

Fixes #106

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>

labgrid/binding.py

@@ -4,12 +4,12 @@
 import attr
 
 
-@attr.s
+@attr.s(cmp=False)
 class StateError(Exception):
     msg = attr.ib(validator=attr.validators.instance_of(str))
 
 
-@attr.s
+@attr.s(cmp=False)
 class BindingError(Exception):
     msg = attr.ib(validator=attr.validators.instance_of(str))
 
@@ -22,7 +22,7 @@ class BindingState(enum.Enum):
     active = 2
 
 
-@attr.s
+@attr.s(cmp=False)
 class BindingMixin:
     """
     Handles the binding and activation of drivers and their supplying resources

labgrid/config.py

@@ -10,7 +10,7 @@
 from .util.yaml import load
 
 
-@attr.s
+@attr.s(cmp=False)
 class Config:
     filename = attr.ib(validator=attr.validators.instance_of(str))
 

labgrid/driver/bareboxdriver.py

@@ -17,7 +17,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class BareboxDriver(CommandMixin, Driver, CommandProtocol, LinuxBootProtocol):
     """BareboxDriver - Driver to control barebox via the console.
        BareboxDriver binds on top of a ConsoleProtocol.

labgrid/driver/common.py

@@ -5,7 +5,7 @@
 from .exception import ExecutionError
 
 
-@attr.s
+@attr.s(cmp=False)
 class Driver(BindingMixin):
     """
     Represents a driver which is used externally or by other drivers. It

labgrid/driver/exception.py

@@ -1,11 +1,11 @@
 import attr
 
 
-@attr.s
+@attr.s(cmp=False)
 class ExecutionError(Exception):
     msg = attr.ib(validator=attr.validators.instance_of(str))
 
 
-@attr.s
+@attr.s(cmp=False)
 class CleanUpError(Exception):
     msg = attr.ib(validator=attr.validators.instance_of(str))

labgrid/driver/externalconsoledriver.py

@@ -15,7 +15,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class ExternalConsoleDriver(ConsoleExpectMixin, Driver, ConsoleProtocol):
     """
     Driver implementing the ConsoleProtocol interface using a subprocess

labgrid/driver/fake.py

@@ -10,7 +10,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class FakeConsoleDriver(ConsoleExpectMixin, Driver, ConsoleProtocol):
     txdelay = attr.ib(default=0.0, validator=attr.validators.instance_of(float))
 
@@ -32,7 +32,7 @@ def close(self):
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class FakeCommandDriver(CommandMixin, Driver, CommandProtocol):
     @Driver.check_active
     def run(self, *args):
@@ -48,7 +48,7 @@ def get_status(self):
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class FakeFileTransferDriver(Driver, FileTransferProtocol):
     @Driver.check_active
     def get(self, *args):
@@ -59,7 +59,7 @@ def put(self, *args):
         pass
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class FakePowerDriver(Driver, PowerProtocol):
     @Driver.check_active
     def on(self, *args):

labgrid/driver/fastbootdriver.py

@@ -12,7 +12,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class AndroidFastbootDriver(Driver):
     bindings = {
         "fastboot": {AndroidFastboot, NetworkAndroidFastboot},

labgrid/driver/infodriver.py

@@ -9,7 +9,7 @@
 from .common import Driver
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class InfoDriver(Driver, InfoProtocol):
     """
     InfoDriver implementing the InfoProtocol on top of CommandProtocol drivers

labgrid/driver/onewiredriver.py

@@ -8,7 +8,7 @@
 from .common import Driver
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class OneWirePIODriver(Driver, DigitalOutputProtocol):
 
     bindings = {"port": OneWirePIO, }

labgrid/driver/openocddriver.py

@@ -13,7 +13,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class OpenOCDDriver(Driver, BootstrapProtocol):
     bindings = {
         "interface": {AlteraUSBBlaster, NetworkAlteraUSBBlaster},

labgrid/driver/powerdriver.py

@@ -14,7 +14,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class ManualPowerDriver(Driver, PowerProtocol):
     """ManualPowerDriver - Driver to tell the user to control a target's power"""
     name = attr.ib(validator=attr.validators.instance_of(str))
@@ -43,7 +43,7 @@ def cycle(self):
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class ExternalPowerDriver(Driver, PowerProtocol):
     """ExternalPowerDriver - Driver using an external command to control a target's power"""
     cmd_on = attr.ib(validator=attr.validators.instance_of(str))
@@ -78,7 +78,7 @@ def cycle(self):
             self.on()
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class NetworkPowerDriver(Driver, PowerProtocol):
     """NetworkPowerDriver - Driver using a networked power switch to control a target's power"""
     bindings = {"port": NetworkPowerPort, }
@@ -115,7 +115,7 @@ def get(self):
         return self.backend.get(self.port.host, self.port.index)
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class DigitalOutputPowerDriver(Driver, PowerProtocol):
     """DigitalOutputPowerDriver - Driver using a DigitalOutput to reset the target and
     subprocesses to turn it on and off"""

labgrid/driver/qemudriver.py

@@ -21,7 +21,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class QEMUDriver(ConsoleExpectMixin, Driver, PowerProtocol, ConsoleProtocol):
     """
     The QEMUDriver implements an interface to start targets as qemu instances.

labgrid/driver/serialdriver.py

@@ -13,7 +13,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class SerialDriver(ConsoleExpectMixin, Driver, ConsoleProtocol):
     """
     Driver implementing the ConsoleProtocol interface over a SerialPort connection

labgrid/driver/shelldriver.py

@@ -24,7 +24,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class ShellDriver(CommandMixin, Driver, CommandProtocol, FileTransferProtocol):
     """ShellDriver - Driver to execute commands on the shell
     ShellDriver binds on top of a ConsoleProtocol.

labgrid/driver/sshdriver.py

@@ -19,7 +19,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class SSHDriver(CommandMixin, Driver, CommandProtocol, FileTransferProtocol):
     """SSHDriver - Driver to execute commands via SSH"""
     bindings = {"networkservice": NetworkService, }

labgrid/driver/ubootdriver.py

@@ -16,7 +16,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class UBootDriver(CommandMixin, Driver, CommandProtocol, LinuxBootProtocol):
     """UBootDriver - Driver to control uboot via the console.
     UBootDriver binds on top of a ConsoleProtocol.

labgrid/driver/usbloader.py

@@ -13,7 +13,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class MXSUSBDriver(Driver, BootstrapProtocol):
     bindings = {
         "loader": {MXSUSBLoader, NetworkMXSUSBLoader},
@@ -48,7 +48,7 @@ def load(self, filename=None):
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class IMXUSBDriver(Driver, BootstrapProtocol):
     bindings = {
         "loader": {IMXUSBLoader, NetworkIMXUSBLoader},

labgrid/driver/usbstorage.py

@@ -11,7 +11,7 @@
 
 
 @target_factory.reg_driver
-@attr.s
+@attr.s(cmp=False)
 class USBStorageDriver(Driver):
     bindings = {"storage": USBMassStorage, }
 

labgrid/environment.py

@@ -7,7 +7,7 @@
 from .config import Config
 
 
-@attr.s
+@attr.s(cmp=False)
 class Environment:
     """An environment encapsulates targets."""
     config_file = attr.ib(

labgrid/exceptions.py

@@ -1,21 +1,21 @@
 import attr
 
 
-@attr.s
+@attr.s(cmp=False)
 class NoConfigFoundError(Exception):
     msg = attr.ib(validator=attr.validators.instance_of(str))
 
 
-@attr.s
+@attr.s(cmp=False)
 class NoSupplierFoundError(Exception):
     msg = attr.ib(validator=attr.validators.instance_of(str))
 
 
-@attr.s
+@attr.s(cmp=False)
 class NoDriverFoundError(NoSupplierFoundError):
     pass
 
 
-@attr.s
+@attr.s(cmp=False)
 class NoResourceFoundError(NoSupplierFoundError):
     pass

labgrid/external/hawkbit.py

@@ -3,7 +3,7 @@
 import attr
 import requests as r
 
-@attr.s
+@attr.s(cmp=False)
 class HawkbitTestClient:
     host = attr.ib(validator=attr.validators.instance_of(str))
     port = attr.ib(validator=attr.validators.instance_of(str))
@@ -126,6 +126,6 @@ def get_endpoint(self, endpoint: str):
         return req.json()
 
 
-@attr.s
+@attr.s(cmp=False)
 class HawkbiError(Exception):
     msg = attr.ib()

labgrid/external/usbstick.py

@@ -17,7 +17,7 @@ class USBStatus(enum.Enum):
     mounted = 2
 
 
-@attr.s
+@attr.s(cmp=False)
 class USBStick(object):
     """The USBStick class provides an easy to use interface to describe a
     target as an USB Stick."""
@@ -140,7 +140,7 @@ def switch_image(self, image_name):
         self.image_name = image_name
 
 
-@attr.s
+@attr.s(cmp=False)
 class StateError(Exception):
     """Exception which indicates a error in the state handling of the test"""
     msg = attr.ib()

labgrid/provider/mediafileprovider.py

@@ -3,7 +3,7 @@
 from .fileprovider import FileProvider
 
 
-@attr.s
+@attr.s(cmp=False)
 class MediaFileProvider(FileProvider):
     groups = attr.ib(default={}, validator=attr.validators.instance_of(dict))
 

labgrid/remote/common.py

@@ -6,7 +6,7 @@
 import attr
 
 
-@attr.s
+@attr.s(cmp=False)
 class ResourceEntry:
     data = attr.ib()  # cls, params
     acquired = attr.ib(default=None)
@@ -47,7 +47,9 @@ def asdict(self):
         }
 
 
-@attr.s
+@attr.s(cmp=True)
+# This class requires cmp=True, since we put the matches into a list and require
+# the cmp functions to be able to remove the matches from the list later on.
 class ResourceMatch:
     exporter = attr.ib()
     group = attr.ib()
@@ -84,7 +86,7 @@ def ismatch(self, resource_path):
             return True
 
 
-@attr.s
+@attr.s(cmp=False)
 class Place:
     name = attr.ib()
     aliases = attr.ib(default=attr.Factory(set), convert=set)

labgrid/remote/config.py

@@ -7,7 +7,7 @@
 from ..exceptions import NoConfigFoundError
 
 
-@attr.s
+@attr.s(cmp=False)
 class ResourceConfig:
     filename = attr.ib(validator=attr.validators.instance_of(str))
 

labgrid/remote/coordinator.py

@@ -21,7 +21,7 @@ class Action(Enum):
     UPD = 2
 
 
-@attr.s(init=False)
+@attr.s(init=False, cmp=False)
 class RemoteSession:
     """class encapsulating a session, used by ExporterSession and ClientSession"""
     coordinator = attr.ib()
@@ -39,7 +39,7 @@ def name(self):
         return self.authid.split('/', 1)[1]
 
 
-@attr.s
+@attr.s(cmp=False)
 class ExporterSession(RemoteSession):
     """An ExporterSession is opened for each Exporter connecting to the
     coordinator, allowing the Exporter to get and set resources"""
@@ -86,7 +86,7 @@ def get_resources(self):
         return result
 
 
-@attr.s
+@attr.s(cmp=False)
 class ClientSession(RemoteSession):
     acquired = attr.ib(default=attr.Factory(list), init=False)