Merge branch 'main' into docstrings-linting

haystack/components/builders/prompt_builder.py

@@ -35,6 +35,12 @@ def __init__(self, template: str):
             component.set_input_type(self, var, Any, "")
 
     def to_dict(self) -> Dict[str, Any]:
+        """
+        Returns a dictionary representation of the component.
+
+        :returns:
+            Serialized dictionary representation of the component.
+        """
         return default_to_dict(self, template=self._template_string)
 
     @component.output_types(prompt=str)

haystack/components/converters/pypdf.py

@@ -21,14 +21,14 @@ class PyPDFConverter(Protocol):
     A protocol that defines a converter which takes a PdfReader object and converts it into a Document object.
     """
 
-    def convert(self, reader: "PdfReader") -> Document:
+    def convert(self, reader: "PdfReader") -> Document:  # noqa: D102
         ...
 
-    def to_dict(self):
+    def to_dict(self):  # noqa: D102
         ...
 
     @classmethod
-    def from_dict(cls, data):
+    def from_dict(cls, data):  # noqa: D102
         ...
 
 
@@ -43,10 +43,12 @@ def convert(self, reader: "PdfReader") -> Document:
         return Document(content=text)
 
     def to_dict(self):
+        """Serialize the converter to a dictionary."""
         return default_to_dict(self)
 
     @classmethod
     def from_dict(cls, data):
+        """Deserialize the converter from a dictionary."""
         return default_from_dict(cls, data)
 
 

haystack/components/evaluators/document_recall.py

@@ -20,6 +20,9 @@ def __str__(self):
 
     @staticmethod
     def from_str(string: str) -> "RecallMode":
+        """
+        Convert a string to a RecallMode enum.
+        """
         enum_map = {e.value: e for e in RecallMode}
         mode = enum_map.get(string)
         if mode is None:

haystack/core/component/component.py

@@ -149,6 +149,9 @@ def run(self, **kwargs):
 class ComponentMeta(type):
     @staticmethod
     def positional_to_kwargs(cls_type, args) -> Dict[str, Any]:
+        """
+        Convert positional arguments to keyword arguments based on the signature of the `__init__` method.
+        """
         init_signature = inspect.signature(cls_type.__init__)
         init_params = {name: info for name, info in init_signature.parameters.items() if name != "self"}
 

haystack/core/component/types.py

@@ -45,6 +45,7 @@ class InputSocket:
 
     @property
     def is_mandatory(self):
+        """Check if the input is mandatory."""
         return self.default_value == _empty
 
     def __post_init__(self):

haystack/dataclasses/answer.py

@@ -15,11 +15,11 @@ class Answer(Protocol):
     query: str
     meta: Dict[str, Any]
 
-    def to_dict(self) -> Dict[str, Any]:
+    def to_dict(self) -> Dict[str, Any]:  # noqa: D102
         ...
 
     @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> "Answer":
+    def from_dict(cls, data: Dict[str, Any]) -> "Answer":  # noqa: D102
         ...
 
 
@@ -40,6 +40,12 @@ class Span:
         end: int
 
     def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize the object to a dictionary.
+
+        :returns:
+            Serialized dictionary representation of the object.
+        """
         document = self.document.to_dict(flatten=False) if self.document is not None else None
         document_offset = asdict(self.document_offset) if self.document_offset is not None else None
         context_offset = asdict(self.context_offset) if self.context_offset is not None else None
@@ -57,6 +63,14 @@ def to_dict(self) -> Dict[str, Any]:
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "ExtractedAnswer":
+        """
+        Deserialize the object from a dictionary.
+
+        :param data:
+            Dictionary representation of the object.
+        :returns:
+            Deserialized object.
+        """
         init_params = data.get("init_parameters", {})
         if (doc := init_params.get("document")) is not None:
             data["init_parameters"]["document"] = Document.from_dict(doc)
@@ -86,6 +100,12 @@ class Cell:
         column: int
 
     def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize the object to a dictionary.
+
+        :returns:
+            Serialized dictionary representation of the object.
+        """
         document = self.document.to_dict(flatten=False) if self.document is not None else None
         context = self.context.to_json() if self.context is not None else None
         document_cells = [asdict(c) for c in self.document_cells]
@@ -104,6 +124,15 @@ def to_dict(self) -> Dict[str, Any]:
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "ExtractedTableAnswer":
+        """
+        Deserialize the object from a dictionary.
+
+        :param data:
+            Dictionary representation of the object.
+
+        :returns:
+            Deserialized object.
+        """
         init_params = data.get("init_parameters", {})
         if (doc := init_params.get("document")) is not None:
             data["init_parameters"]["document"] = Document.from_dict(doc)
@@ -127,11 +156,26 @@ class GeneratedAnswer:
     meta: Dict[str, Any] = field(default_factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
+        """
+        Serialize the object to a dictionary.
+
+        :returns:
+            Serialized dictionary representation of the object.
+        """
         documents = [doc.to_dict(flatten=False) for doc in self.documents]
         return default_to_dict(self, data=self.data, query=self.query, documents=documents, meta=self.meta)
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "GeneratedAnswer":
+        """
+        Deserialize the object from a dictionary.
+
+        :param data:
+            Dictionary representation of the object.
+
+        :returns:
+            Deserialized object.
+        """
         init_params = data.get("init_parameters", {})
         if (documents := init_params.get("documents")) is not None:
             data["init_parameters"]["documents"] = [Document.from_dict(d) for d in documents]