Skip to content

ClearSignResult#

Bases: OperationResult

ClearOperationResult model.

Attributes:

Name Type Description
outputs List[str]

List of signing result outputs.
signing_key str

The signing key used during signing.
Source code in pubtools/sign/results/clearsign.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
@dataclasses.dataclass()
class ClearSignResult(OperationResult):
    """ClearOperationResult model.

    Attributes:
        outputs (List[str]): List of signing result outputs.
        signing_key (str): The signing key used during signing.
    """

    outputs: List[str]
    signing_key: str

    def to_dict(self: Self) -> Dict[Any, Any]:
        """Return dict representation of ClearOperationResult."""
        return {"outputs": self.outputs, "signing_key": self.signing_key}

    @classmethod
    def doc_arguments(cls: Type[Self]) -> Dict[str, Any]:
        """Return dictionary with arguments description of the operation."""
        doc_arguments = {
            "operation_results": {
                "type": "list",
                "description": "Signing result output",
                "returned": "always",
                "sample": ["signed:'hello world'"],
            },
            "signing_key": {
                "type": "str",
                "description": "The signing key which is used during signing.",
                "returned": "always",
                "sample": "123",
            },
        }

        return doc_arguments

doc_arguments() classmethod #

Return dictionary with arguments description of the operation.

Source code in pubtools/sign/results/clearsign.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
@classmethod
def doc_arguments(cls: Type[Self]) -> Dict[str, Any]:
    """Return dictionary with arguments description of the operation."""
    doc_arguments = {
        "operation_results": {
            "type": "list",
            "description": "Signing result output",
            "returned": "always",
            "sample": ["signed:'hello world'"],
        },
        "signing_key": {
            "type": "str",
            "description": "The signing key which is used during signing.",
            "returned": "always",
            "sample": "123",
        },
    }

    return doc_arguments

to_dict() #

Return dict representation of ClearOperationResult.

Source code in pubtools/sign/results/clearsign.py 
21
22
23
def to_dict(self: Self) -> Dict[Any, Any]:
    """Return dict representation of ClearOperationResult."""
    return {"outputs": self.outputs, "signing_key": self.signing_key}