Skip to content

g04_comment

g04_comment

Comment token.

Comment

Bases: CommandToken

4.1 Comment (G04).

The G04 command is used for human readable comments. It does not affect the image. The syntax for G04 is as follows.

G04 = ('G04' string) '*';

The string must follow the string syntax in 3.4.3.

Example
G04 This is a comment*
G04 The space characters as well as "," and ";" are allowed here.*

See section 4.1 of The Gerber Layer Format Specification

Source code in src/pygerber/gerberx3/tokenizer/tokens/g04_comment.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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class Comment(CommandToken):
    """## 4.1 Comment (G04).

    The G04 command is used for human readable comments. It does not affect the image.
    The syntax for G04 is as follows.

    ```ebnf
    G04 = ('G04' string) '*';
    ```

    The string must follow the string syntax in [3.4.3](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=35).

    ---

    ## Example

    ```gerber
    G04 This is a comment*
    G04 The space characters as well as "," and ";" are allowed here.*
    ```

    ---

    See section 4.1 of [The Gerber Layer Format Specification](https://www.ucamco.com/files/downloads/file_en/456/gerber-layer-format-specification-revision-2023-08_en.pdf#page=44)

    """

    def __init__(self, string: str, location: int, content: str) -> None:
        super().__init__(string, location)
        self.content = content

    @classmethod
    def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
        """Create instance of this class.

        Created to be used as callback in `ParserElement.set_parse_action()`.
        """
        content: str = str(tokens["string"])
        return cls(string=string, location=location, content=content)

    def parser2_visit_token(self, context: Parser2Context) -> None:
        """Perform actions on the context implicated by this token."""
        context.get_hooks().comment.pre_parser_visit_token(self, context)
        context.get_hooks().comment.on_parser_visit_token(self, context)
        context.get_hooks().comment.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}G04 {self.content}"

new classmethod 

new(
    string: str, location: int, tokens: ParseResults
) -> Self

Create instance of this class.

Created to be used as callback in ParserElement.set_parse_action().

Source code in src/pygerber/gerberx3/tokenizer/tokens/g04_comment.py 
47
48
49
50
51
52
53
54
@classmethod
def new(cls, string: str, location: int, tokens: ParseResults) -> Self:
    """Create instance of this class.

    Created to be used as callback in `ParserElement.set_parse_action()`.
    """
    content: str = str(tokens["string"])
    return cls(string=string, location=location, content=content)

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/g04_comment.py 
56
57
58
59
60
def parser2_visit_token(self, context: Parser2Context) -> None:
    """Perform actions on the context implicated by this token."""
    context.get_hooks().comment.pre_parser_visit_token(self, context)
    context.get_hooks().comment.on_parser_visit_token(self, context)
    context.get_hooks().comment.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/g04_comment.py 
62
63
64
65
66
67
68
def get_gerber_code(
    self,
    indent: str = "",
    endline: str = "\n",  # noqa: ARG002
) -> str:
    """Get gerber code represented by this token."""
    return f"{indent}G04 {self.content}"