Skip to content

m01_optional_stop

m01_optional_stop

Wrapper for optional stop token.

M01OptionalStop

Bases: CommandToken

Wrapper for optional stop token.

See section 8.1.1 of The Gerber Layer Format Specification Revision 2023.03 - https://argmaster.github.io/pygerber/latest/gerber_specification/revision_2023_03.html

Source code in src/pygerber/gerberx3/tokenizer/tokens/m01_optional_stop.py 
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
class M01OptionalStop(CommandToken):
    """Wrapper for optional stop token.

    See section 8.1.1 of The Gerber Layer Format Specification Revision 2023.03 - https://argmaster.github.io/pygerber/latest/gerber_specification/revision_2023_03.html
    """

    def update_drawing_state(
        self,
        _state: State,
        _backend: Backend,
    ) -> Tuple[State, Iterable[DrawCommand]]:
        """Exit drawing process."""
        raise ExitParsingProcessInterrupt

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().optional_stop.pre_parser_visit_token(self, context)
        context.get_hooks().optional_stop.on_parser_visit_token(self, context)
        context.get_hooks().optional_stop.post_parser_visit_token(self, context)

    def get_gerber_code(
        self,
        indent: str = "",
        endline: str = "\n",  # noqa: ARG002
    ) -> str:
        """Get gerber code represented by this token."""
        return f"{indent}M01"

update_drawing_state 

update_drawing_state(
    _state: State, _backend: Backend
) -> Tuple[State, Iterable[DrawCommand]]

Exit drawing process.

Source code in src/pygerber/gerberx3/tokenizer/tokens/m01_optional_stop.py 
22
23
24
25
26
27
28
def update_drawing_state(
    self,
    _state: State,
    _backend: Backend,
) -> Tuple[State, Iterable[DrawCommand]]:
    """Exit drawing process."""
    raise ExitParsingProcessInterrupt

parser2_visit_token 

parser2_visit_token(context: Parser2Context) -> None

Perform actions on the context implicated by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/m01_optional_stop.py 
30
31
32
33
34
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().optional_stop.pre_parser_visit_token(self, context)
    context.get_hooks().optional_stop.on_parser_visit_token(self, context)
    context.get_hooks().optional_stop.post_parser_visit_token(self, context)

get_gerber_code 

get_gerber_code(
    indent: str = "", endline: str = "\n"
) -> str

Get gerber code represented by this token.

Source code in src/pygerber/gerberx3/tokenizer/tokens/m01_optional_stop.py 
36
37
38
39
40
41
42
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return f"{indent}M01"