Add readability improvements (PIE)

Author: JAB1305

ruff.toml

@@ -19,6 +19,7 @@ select = [
     "I",       # isort
     "F8",      # pyflakes: undefined/unused names
     "F4",      # pyflakes: imports/__future__
+    "PIE",     # small readability improvements
 ]
 
 # TODO: Revisit these
@@ -32,7 +33,6 @@ ignore = [
     "A",       # prevent shadowing of python builtins
     "FIX",     # prevent the creation of T0DO / F1XME comments
     # Checked, need manual work:
-    "PIE",     # small readability improvements
     "PYI",     # typing best practices
     # Evaluate if we want to use:
     "S",        # security related precautions

sdk/basyx/aas/adapter/aasx.py

@@ -958,7 +958,7 @@ def add_file(self, name: str, file: IO[bytes], content_type: str) -> str:
         :return: The file name as stored in the SupplementaryFileContainer. Typically, ``name`` or a modified version of
             ``name`` to resolve conflicts.
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
     @abc.abstractmethod
     def get_content_type(self, name: str) -> str:
@@ -969,7 +969,7 @@ def get_content_type(self, name: str) -> str:
         :return: The file's content_type
         :raises KeyError: If no file with this name is stored
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
     @abc.abstractmethod
     def get_sha256(self, name: str) -> bytes:
@@ -982,7 +982,7 @@ def get_sha256(self, name: str) -> bytes:
         :return: The file content's sha256 hash sum
         :raises KeyError: If no file with this name is stored
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
     @abc.abstractmethod
     def write_file(self, name: str, file: IO[bytes]) -> None:
@@ -993,28 +993,28 @@ def write_file(self, name: str, file: IO[bytes]) -> None:
         :param file: A binary file-like object with write() method to write the file contents into
         :raises KeyError: If no file with this name is stored
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
     @abc.abstractmethod
     def delete_file(self, name: str) -> None:
         """
         Deletes a file from this SupplementaryFileContainer given its name.
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
     @abc.abstractmethod
     def __contains__(self, item: str) -> bool:
         """
         Check if a file with the given name is stored in this SupplementaryFileContainer.
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
     @abc.abstractmethod
     def __iter__(self) -> Iterator[str]:
         """
         Return an iterator over all file names stored in this SupplementaryFileContainer.
         """
-        pass  # pragma: no cover
+        # pragma: no cover
 
 
 class DictSupplementaryFileContainer(AbstractSupplementaryFileContainer):

sdk/basyx/aas/adapter/json/json_deserialization.py

@@ -1024,7 +1024,6 @@ class StrictStrippedAASFromJsonDecoder(
     Non-failsafe decoder for stripped JSON objects.
     """
 
-    pass
 
 
 def _select_decoder(

sdk/basyx/aas/adapter/xml/xml_deserialization.py

@@ -1639,7 +1639,6 @@ class StrictStrippedAASFromXmlDecoder(
     Non-failsafe decoder for stripped XML elements.
     """
 
-    pass
 
 
 def _parse_xml_document(

sdk/basyx/aas/backend/couchdb.py

@@ -583,14 +583,12 @@ class CouchDBError(Exception):
 class CouchDBConnectionError(CouchDBError):
     """Exception raised when the CouchDB server could not be reached"""
 
-    pass
 
 
 class CouchDBResponseError(CouchDBError):
     """Exception raised by when an HTTP of the CouchDB server could not be handled (e.g.
     no JSON body)"""
 
-    pass
 
 
 class CouchDBServerError(CouchDBError):
@@ -606,4 +604,3 @@ def __init__(self, code: int, error: str, reason: str, *args):
 class CouchDBConflictError(CouchDBError):
     """Exception raised when an object could not be committed due to a concurrent modification in the database"""
 
-    pass

sdk/basyx/aas/model/datatypes.py

@@ -276,7 +276,6 @@ class HexBinary(bytearray):
 class Float(float):
     """A 32bit IEEE754 float. This can not be represented with Python"""
 
-    pass
 
 
 class Long(int):

sdk/basyx/aas/model/provider.py

@@ -41,7 +41,6 @@ class AbstractObjectProvider(Generic[_KEY, _VALUE], metaclass=abc.ABCMeta):
     @abc.abstractmethod
     def get_item(self, key: _KEY) -> _VALUE:
         """Retrieve the item or raise a KeyError."""
-        pass
 
     def get(self, key: _KEY, default: Optional[_VALUE] = None) -> Optional[_VALUE]:
         """Retrieve the item or return a default value."""

sdk/basyx/aas/util/identification.py

@@ -41,7 +41,6 @@ def generate_id(self, proposal: Optional[str] = None) -> model.Identifier:
                          fragment of an IRI). It may be ignored by some implementations of or be changed if the
                          resulting id is already existing.
         """
-        pass
 
 
 class UUIDGenerator(AbstractIdentifierGenerator):
@@ -148,7 +147,7 @@ def generate_id(self, proposal: Optional[str] = None) -> model.Identifier:
     ]
 }
 # Remove ASCII control characters
-_iri_segment_quote_table_tmpl.update({i: None for i in range(0, 0x1F)})
+_iri_segment_quote_table_tmpl.update({i: None for i in range(0x1F)})
 _iri_segment_quote_table_tmpl[0x7F] = None
 _iri_segment_quote_table: Dict[int, Optional[str]] = str.maketrans(
     _iri_segment_quote_table_tmpl

server/app/adapter/jsonization.py

@@ -203,7 +203,6 @@ class ServerStrictStrippedAASFromJsonDecoder(ServerStrictAASFromJsonDecoder, Ser
     Non-failsafe decoder for stripped JSON objects.
     """
 
-    pass
 
 
 class ServerAASToJsonEncoder(AASToJsonEncoder):