update to ruff

Author: gonzalocasas

pyproject.toml

@@ -49,8 +49,19 @@ Forum = "https://forum.compas-framework.org/"
 # setuptools config
 # ============================================================================
 
-[tool.black]
-line-length = 120
+[tool.ruff]
+line-length = 179
+indent-width = 4
+target-version = "py39"
+exclude = ["src/compas_eve/proto"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["I001"]
+"tests/*" = ["I001"]
+"tasks.py" = ["I001"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
@@ -64,7 +75,7 @@ doctest_optionflags= "NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL ALLOW_UNICODE
 filterwarnings = "ignore::DeprecationWarning"
 
 [tool.isort]
-line_length = 120
+line_length = 179
 multi_line_output = 3
 include_trailing_comma = true
 force_grid_wrap = 0
@@ -76,3 +87,16 @@ default_section = "THIRDPARTY"
 forced_separate = "test_compas_eve"
 skip = ["__init__.py"]
 
+[tool.ruff.lint.isort]
+force-single-line = true
+known-first-party = ["compas_eve"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 179
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = "dynamic"

setup.cfg

@@ -2,11 +2,11 @@
 universal = 1
 
 [flake8]
-max-line-length = 120
+max-line-length = 179
 exclude = */migrations/*
 
 [doc8]
-max-line-length = 120
+max-line-length = 179
 ignore = D001
 
 [pydocstyle]

src/compas_eve/codecs/__init__.py

@@ -141,10 +141,7 @@ class ProtobufMessageCodec(MessageCodec):
     def __init__(self):
         super(ProtobufMessageCodec, self).__init__()
         if not COMPAS_PB_AVAILABLE:
-            raise ImportError(
-                "The ProtobufMessageCodec requires 'compas_pb' to be installed. "
-                "Please install it with: pip install compas_pb"
-            )
+            raise ImportError("The ProtobufMessageCodec requires 'compas_pb' to be installed. Please install it with: pip install compas_pb")
 
     def encode(self, message):
         """Encode a message to Protocol Buffers binary format.
@@ -161,10 +158,7 @@ def encode(self, message):
             Protocol Buffers binary representation of the message.
         """
         if not COMPAS_PB_AVAILABLE:
-            raise ImportError(
-                "The ProtobufMessageCodec requires 'compas_pb' to be installed. "
-                "Please install it with: pip install compas_pb"
-            )
+            raise ImportError("The ProtobufMessageCodec requires 'compas_pb' to be installed. Please install it with: pip install compas_pb")
         return compas_pb.pb_dump_bts(message)
 
     def decode(self, encoded_data, message_type=None):
@@ -183,8 +177,5 @@ def decode(self, encoded_data, message_type=None):
             Decoded message object.
         """
         if not COMPAS_PB_AVAILABLE:
-            raise ImportError(
-                "The ProtobufMessageCodec requires 'compas_pb' to be installed. "
-                "Please install it with: pip install compas_pb"
-            )
+            raise ImportError("The ProtobufMessageCodec requires 'compas_pb' to be installed. Please install it with: pip install compas_pb")
         return compas_pb.pb_load_bts(encoded_data)

src/compas_eve/codecs/conversions.py

@@ -14,6 +14,7 @@ def message_to_pb(message: Message) -> message_pb2.Message:
         pb.data[k].CopyFrom(_serializer_any(v))
     return pb
 
+
 @pb_deserializer(message_pb2.Message)
 def message_from_pb(pb: message_pb2.Message) -> Message:
     message = Message()

src/compas_eve/event_emitter.py

@@ -73,11 +73,12 @@ class EventEmitterMixin(object):
 
       For example::
 
-          @ee.on('error')
+          @ee.on("error")
           def onError(message):
               logging.err(message)
 
-          ee.emit('error', Exception('something blew up'))
+
+          ee.emit("error", Exception("something blew up"))
 
       For synchronous callbacks, exceptions are **not** handled for you---
       you must catch your own exceptions inside synchronous ``on`` handlers.
@@ -102,7 +103,7 @@ def on(self, event, f=None):
         takes ``f`` as a callback; in other words, you can use this method
         as a decorator, like so::
 
-            @ee.on('data')
+            @ee.on("data")
             def data_handler(data):
                 print(data)
 
@@ -150,7 +151,7 @@ def emit(self, event, *args, **kwargs):
 
         Example::
 
-            ee.emit('data', '00101001')
+            ee.emit("data", "00101001")
 
         Assuming ``data`` is an attached function, this will call
         ``data('00101001')'``.

src/compas_eve/ghpython/background.py

@@ -33,14 +33,15 @@ class BackgroundWorker(object):
 
         import time
 
+
         def do_something_long_and_complicated(worker):
             # Result can be of any data type
             result = 0
 
             for i in range(50):
                 worker.current_value = i
                 result += i
-                worker.display_progress(i / (50-1))
+                worker.display_progress(i / (50 - 1))
                 time.sleep(0.01)
 
             worker.display_message("Done!")
@@ -190,9 +191,7 @@ def ui_callback():
         Rhino.RhinoApp.InvokeOnUiThread(System.Action(ui_callback))
 
     @classmethod
-    def instance_by_component(
-        cls, ghenv, long_running_function=None, dispose_function=None, auto_set_done=True, force_new=False, args=()
-    ):
+    def instance_by_component(cls, ghenv, long_running_function=None, dispose_function=None, auto_set_done=True, force_new=False, args=()):
         """Get the worker instance assigned to the component.
 
         This will get a persistant instance of a background worker

src/compas_eve/memory/__init__.py

@@ -57,7 +57,7 @@ def publish(self, topic, message):
 
         def _callback(**kwargs):
             encoded_message = self.codec.encode(message)
-            encoded_message_bytes = encoded_message if isinstance(encoded_message, bytes) else encoded_message.encode('utf-8')
+            encoded_message_bytes = encoded_message if isinstance(encoded_message, bytes) else encoded_message.encode("utf-8")
             self.emit(event_key, encoded_message_bytes)
 
         self.on_ready(_callback)

tests/integration/test_mqtt.py

@@ -136,9 +136,7 @@ def callback(msg):
     assert isinstance(result["value"]["graph"], Graph)
 
 
-
 def test_nested_message_types():
-
     class Header(Message):
         def __init__(self, sequence_id=None):
             super(Header, self).__init__()

tests/unit/test_codecs.py

@@ -6,12 +6,12 @@
 
 def test_json_codec_encode_decode():
     codec = JsonMessageCodec()
-    
+
     original_message = Message(name="test", value=42, active=True)
     encoded = codec.encode(original_message)
-    wire_encoding = encoded.encode('utf-8') # simulate wire encoding
+    wire_encoding = encoded.encode("utf-8")  # simulate wire encoding
     decoded = codec.decode(wire_encoding, Message)
-    
+
     assert isinstance(encoded, str)
     assert isinstance(decoded, Message)
     assert decoded.name == "test"
@@ -21,17 +21,13 @@ def test_json_codec_encode_decode():
 
 def test_json_codec_nested_data():
     codec = JsonMessageCodec()
-    
-    nested_data = {
-        "coordinates": [1.0, 2.0, 3.0],
-        "metadata": {"author": "test", "version": 1},
-        "tags": ["geometry", "point"]
-    }
-    
+
+    nested_data = {"coordinates": [1.0, 2.0, 3.0], "metadata": {"author": "test", "version": 1}, "tags": ["geometry", "point"]}
+
     original_message = Message(**nested_data)
-    encoded = codec.encode(original_message).encode('utf-8')
+    encoded = codec.encode(original_message).encode("utf-8")
     decoded = codec.decode(encoded, Message)
-    
+
     assert decoded.coordinates == [1.0, 2.0, 3.0]
     assert decoded.metadata["author"] == "test"
     assert decoded.metadata["version"] == 1
@@ -40,9 +36,9 @@ def test_json_codec_nested_data():
 
 def test_json_codec_empty_message():
     codec = JsonMessageCodec()
-    
+
     original_message = Message()
-    encoded = codec.encode(original_message).encode('utf-8')
+    encoded = codec.encode(original_message).encode("utf-8")
     decoded = codec.decode(encoded, Message)
 
     assert isinstance(decoded, Message)
@@ -52,23 +48,15 @@ def test_json_codec_empty_message():
 def test_json_codec_roundtrip():
     """Test JSON codec maintains data integrity through multiple encode/decode cycles."""
     codec = JsonMessageCodec()
-    
-    original_message = Message(
-        string_val="hello world",
-        int_val=123,
-        float_val=3.14159,
-        bool_val=True,
-        null_val=None,
-        list_val=[1, 2, 3],
-        dict_val={"key": "value"}
-    )
-    
+
+    original_message = Message(string_val="hello world", int_val=123, float_val=3.14159, bool_val=True, null_val=None, list_val=[1, 2, 3], dict_val={"key": "value"})
+
     # Multiple roundtrips
     current = original_message
     for _ in range(3):
-        encoded = codec.encode(current).encode('utf-8')
+        encoded = codec.encode(current).encode("utf-8")
         current = codec.decode(encoded, Message)
-    
+
     assert current.string_val == "hello world"
     assert current.int_val == 123
     assert current.float_val == 3.14159
@@ -80,12 +68,12 @@ def test_json_codec_roundtrip():
 
 def test_protobuf_codec_encode_decode():
     codec = ProtobufMessageCodec()
-    
+
     # Test with simple message
     original_message = Message(name="test", value=42, active=True, frame=Frame.worldXY())
     encoded = codec.encode(original_message.data)
     decoded = codec.decode(encoded, dict)
-    
+
     assert isinstance(encoded, bytes)
     assert isinstance(decoded, dict)
     assert decoded["name"] == "test"
@@ -99,17 +87,13 @@ def test_protobuf_codec_encode_decode():
 def test_protobuf_codec_nested_data():
     """Test Protobuf codec handles nested data structures."""
     codec = ProtobufMessageCodec()
-    
-    nested_data = {
-        "coordinates": [1.0, 2.0, 3.0],
-        "metadata": {"author": "test", "version": 1},
-        "tags": ["geometry", "point"]
-    }
-    
+
+    nested_data = {"coordinates": [1.0, 2.0, 3.0], "metadata": {"author": "test", "version": 1}, "tags": ["geometry", "point"]}
+
     original_message = Message(**nested_data)
     encoded = codec.encode(original_message.data)
     decoded = codec.decode(encoded)
-    
+
     assert decoded["coordinates"] == [1.0, 2.0, 3.0]
     assert decoded["metadata"]["author"] == "test"
     assert decoded["metadata"]["version"] == 1
@@ -119,23 +103,16 @@ def test_protobuf_codec_nested_data():
 def test_protobuf_codec_roundtrip():
     """Test Protobuf codec maintains data integrity through multiple encode/decode cycles."""
     codec = ProtobufMessageCodec()
-    
-    original_message = Message(
-        string_val="hello world",
-        int_val=123,
-        float_val=3.14159,
-        bool_val=True,
-        list_val=[1, 2, 3],
-        dict_val={"key": "value"}
-    )
+
+    original_message = Message(string_val="hello world", int_val=123, float_val=3.14159, bool_val=True, list_val=[1, 2, 3], dict_val={"key": "value"})
     original_message = original_message.data
-    
+
     # Multiple roundtrips
     current = original_message
     for _ in range(3):
         encoded = codec.encode(current)
         current = codec.decode(encoded)
-    
+
     assert current["string_val"] == "hello world"
     assert current["int_val"] == 123
     assert current["float_val"] == 3.14159
@@ -148,22 +125,17 @@ def test_codec_compatibility():
     """Test that both codecs produce equivalent results for the same message."""
     json_codec = JsonMessageCodec()
     protobuf_codec = ProtobufMessageCodec()
-    
-    original_message = Message(
-        name="compatibility_test",
-        count=100,
-        enabled=False,
-        data=[1, 2, 3, 4, 5]
-    )
-    
+
+    original_message = Message(name="compatibility_test", count=100, enabled=False, data=[1, 2, 3, 4, 5])
+
     # Encode with both codecs
-    json_encoded = json_codec.encode(original_message).encode('utf-8')
+    json_encoded = json_codec.encode(original_message).encode("utf-8")
     protobuf_encoded = protobuf_codec.encode(original_message.data)
-    
+
     # Decode with respective codecs
     json_decoded = json_codec.decode(json_encoded, Message)
     protobuf_decoded = protobuf_codec.decode(protobuf_encoded, Message)
-    
+
     # Both should produce equivalent messages
     assert json_decoded["name"] == protobuf_decoded["name"] == "compatibility_test"
     assert json_decoded["count"] == protobuf_decoded["count"] == 100

tests/unit/test_mqtt_paho_compatibility.py

@@ -4,10 +4,7 @@
 
 
 def test_paho_mqtt_v1_compatibility():
-    with patch("compas_eve.mqtt.mqtt_paho.PAHO_MQTT_V2_AVAILABLE", False), patch(
-        "paho.mqtt.client.Client"
-    ) as mock_client_class:
-
+    with patch("compas_eve.mqtt.mqtt_paho.PAHO_MQTT_V2_AVAILABLE", False), patch("paho.mqtt.client.Client") as mock_client_class:
         mock_client = Mock()
         mock_client_class.return_value = mock_client