Skip to content

action_file

ActionFile

Bases: BaseModel

Helper class to write the action file.

Attributes:

Name Type Description
py_path str

...
module_name str

...
name str

...
description str

...
action Action

...
inputs type[KebabModel]

...
outputs dict[str, MetadataOutput]

...
python_path str

...
available_outputs dict[str, str]

...
Source code in m/github/actions/action_file.py 
 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
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
class ActionFile(BaseModel):
    """Helper class to write the action file."""

    py_path: str

    module_name: str

    name: str

    description: str

    action: Action

    inputs: type[KebabModel]

    outputs: dict[str, MetadataOutput]

    python_path: str

    available_outputs: dict[str, str]

    def build_inputs(self: 'ActionFile') -> str:
        """Generate the inputs for the action.

        Returns:
            A string to add to the Github action.
        """
        all_inputs: dict[str, InputInfo] = {}
        for prop_name, prop_info in self.inputs.model_fields.items():
            input_info: InputInfo = {
                'description': prop_info.description or '',
                'required': prop_info.is_required(),
            }
            default_val = prop_info.get_default()
            if default_val is not PydanticUndefined:
                input_info['default'] = default_val
            all_inputs[prop_info.alias or prop_name] = input_info
        if not all_inputs:
            return f' {EMPTY_DICT}'
        str_inputs = _indent(yaml.dumps(all_inputs), 1)
        return f'\n  {str_inputs}'

    def build_outputs(
        self: 'ActionFile',
        outputs: dict[str, MetadataOutput],
    ) -> str:
        """Generate the outputs for the action.

        Args:
            outputs: The outputs to add to the action.

        Returns:
            A string to add to the Github action.
        """
        if not outputs:
            return f' {EMPTY_DICT}'
        raw_data = {
            output_name.replace('_', '-', -1): output_val.model_dump()
            for output_name, output_val in outputs.items()
        }
        str_outputs = _indent(yaml.dumps(raw_data), 1)
        return f'\n  {str_outputs}'

    def build_steps_str(self: 'ActionFile') -> str:
        """Generate a github action str for the build steps.

        Returns:
            A string to add to the Github action.
        """
        lines: list[str] = [
            step.to_str(self.python_path, self.available_outputs)
            for step in self.action.steps
        ]
        return _indent('\n'.join(lines), 2)

    def __str__(self: 'ActionFile') -> str:
        """Stringify the action file.

        Returns:
            The github action.
        """
        template_vars = TemplateVars(
            py_path=self.py_path,
            module_name=self.module_name.replace('.', '/', -1),
            name=self.name,
            description=self.description,
            inputs=self.build_inputs(),
            outputs=self.build_outputs(self.outputs),
            steps=self.build_steps_str(),
        )
        file_content = TEMPLATE.format(**template_vars.model_dump())
        return '\n'.join([
            line.rstrip()
            for line in file_content.split('\n')
        ])

__str__()

Stringify the action file.

Returns:

Type Description
str

The github action.
Source code in m/github/actions/action_file.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
def __str__(self: 'ActionFile') -> str:
    """Stringify the action file.

    Returns:
        The github action.
    """
    template_vars = TemplateVars(
        py_path=self.py_path,
        module_name=self.module_name.replace('.', '/', -1),
        name=self.name,
        description=self.description,
        inputs=self.build_inputs(),
        outputs=self.build_outputs(self.outputs),
        steps=self.build_steps_str(),
    )
    file_content = TEMPLATE.format(**template_vars.model_dump())
    return '\n'.join([
        line.rstrip()
        for line in file_content.split('\n')
    ])

build_inputs()

Generate the inputs for the action.

Returns:

Type Description
str

A string to add to the Github action.
Source code in m/github/actions/action_file.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def build_inputs(self: 'ActionFile') -> str:
    """Generate the inputs for the action.

    Returns:
        A string to add to the Github action.
    """
    all_inputs: dict[str, InputInfo] = {}
    for prop_name, prop_info in self.inputs.model_fields.items():
        input_info: InputInfo = {
            'description': prop_info.description or '',
            'required': prop_info.is_required(),
        }
        default_val = prop_info.get_default()
        if default_val is not PydanticUndefined:
            input_info['default'] = default_val
        all_inputs[prop_info.alias or prop_name] = input_info
    if not all_inputs:
        return f' {EMPTY_DICT}'
    str_inputs = _indent(yaml.dumps(all_inputs), 1)
    return f'\n  {str_inputs}'

build_outputs(outputs)

Generate the outputs for the action.

Parameters:

Name Type Description Default
outputs dict[str, MetadataOutput]

The outputs to add to the action.

 required

Returns:

Type Description
str

A string to add to the Github action.
Source code in m/github/actions/action_file.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def build_outputs(
    self: 'ActionFile',
    outputs: dict[str, MetadataOutput],
) -> str:
    """Generate the outputs for the action.

    Args:
        outputs: The outputs to add to the action.

    Returns:
        A string to add to the Github action.
    """
    if not outputs:
        return f' {EMPTY_DICT}'
    raw_data = {
        output_name.replace('_', '-', -1): output_val.model_dump()
        for output_name, output_val in outputs.items()
    }
    str_outputs = _indent(yaml.dumps(raw_data), 1)
    return f'\n  {str_outputs}'

build_steps_str()

Generate a github action str for the build steps.

Returns:

Type Description
str

A string to add to the Github action.
Source code in m/github/actions/action_file.py 
114
115
116
117
118
119
120
121
122
123
124
def build_steps_str(self: 'ActionFile') -> str:
    """Generate a github action str for the build steps.

    Returns:
        A string to add to the Github action.
    """
    lines: list[str] = [
        step.to_str(self.python_path, self.available_outputs)
        for step in self.action.steps
    ]
    return _indent('\n'.join(lines), 2)

TemplateVars

Bases: BaseModel

Template variables.

Attributes:

Name Type Description
py_path str

...
module_name str

...
name str

...
description str

...
inputs str

...
outputs str

...
steps str

...
Source code in m/github/actions/action_file.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class TemplateVars(BaseModel):
    """Template variables."""

    py_path: str

    module_name: str

    name: str

    description: str

    inputs: str

    outputs: str

    steps: str