Skip to content

Schema

CommandExplanation dataclass

Represents a command explanation.

Attributes:

Name Type Description
command str

The command name.
purpose str

The purpose of the command.
syntax str

The syntax of the command.
options list[str]

The available options for the command.
examples list[str]

Examples of how to use the command.
Source code in peter_explains/schema.py 
 5
 6
 7
 8
 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
44
45
@dataclasses.dataclass
class CommandExplanation:
    """
    Represents a command explanation.

    Attributes:
        command (str): The command name.
        purpose (str): The purpose of the command.
        syntax (str): The syntax of the command.
        options (list[str]): The available options for the command.
        examples (list[str]): Examples of how to use the command.

    """

    command: str
    purpose: str
    syntax: str
    options: list[str]
    examples: list[str]

    @staticmethod
    def from_response(response: str) -> "CommandExplanation":
        """
        Creates a CommandExplanation object from a response string.

        Args:
            response (str): The response string containing the command explanation data.

        Returns:
            CommandExplanation: The CommandExplanation object created from the response.

        """
        json_body = response[response.find("{") : response.rfind("}") + 1]
        data = json_repair.loads(json_body)
        return CommandExplanation(
            command=data["command_name"],
            purpose=data["purpose"],
            syntax=data["syntax"],
            options=data["options"],
            examples=data["examples"],
        )

from_response(response) staticmethod

Creates a CommandExplanation object from a response string.

Parameters:

Name Type Description Default
response str

The response string containing the command explanation data.

 required

Returns:

Name Type Description
CommandExplanation CommandExplanation

The CommandExplanation object created from the response.
Source code in peter_explains/schema.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@staticmethod
def from_response(response: str) -> "CommandExplanation":
    """
    Creates a CommandExplanation object from a response string.

    Args:
        response (str): The response string containing the command explanation data.

    Returns:
        CommandExplanation: The CommandExplanation object created from the response.

    """
    json_body = response[response.find("{") : response.rfind("}") + 1]
    data = json_repair.loads(json_body)
    return CommandExplanation(
        command=data["command_name"],
        purpose=data["purpose"],
        syntax=data["syntax"],
        options=data["options"],
        examples=data["examples"],
    )

CommandExplanationWithArguments dataclass

Represents a command explanation with arguments.

Attributes:

Name Type Description
command str

The command name.
purpose str

The purpose of the command.
breakdown list[str]

The breakdown of the command.
Source code in peter_explains/schema.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@dataclasses.dataclass
class CommandExplanationWithArguments:
    """
    Represents a command explanation with arguments.

    Attributes:
        command (str): The command name.
        purpose (str): The purpose of the command.
        breakdown (list[str]): The breakdown of the command.

    """

    command: str
    purpose: str
    breakdown: list[str]

    @staticmethod
    def from_response(response: str) -> "CommandExplanationWithArguments":
        """
        Creates a CommandExplanationWithArguments object from a response string.

        Args:
            response (str): The response string containing the command explanation data.

        Returns:
            CommandExplanationWithArguments: The CommandExplanationWithArguments object created from the response.

        """
        json_body = response[response.find("{") : response.rfind("}") + 1]
        data = json_repair.loads(json_body)
        return CommandExplanationWithArguments(
            command=data["command_name"],
            purpose=data["purpose"],
            breakdown=data["breakdown"],
        )

from_response(response) staticmethod

Creates a CommandExplanationWithArguments object from a response string.

Parameters:

Name Type Description Default
response str

The response string containing the command explanation data.

 required

Returns:

Name Type Description
CommandExplanationWithArguments CommandExplanationWithArguments

The CommandExplanationWithArguments object created from the response.
Source code in peter_explains/schema.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@staticmethod
def from_response(response: str) -> "CommandExplanationWithArguments":
    """
    Creates a CommandExplanationWithArguments object from a response string.

    Args:
        response (str): The response string containing the command explanation data.

    Returns:
        CommandExplanationWithArguments: The CommandExplanationWithArguments object created from the response.

    """
    json_body = response[response.find("{") : response.rfind("}") + 1]
    data = json_repair.loads(json_body)
    return CommandExplanationWithArguments(
        command=data["command_name"],
        purpose=data["purpose"],
        breakdown=data["breakdown"],
    )