Skip to content

decorators

decorators

Decorators for reducing boilerplate required to implement token features.

UseType

Bases: Generic[T]

Placeholder for passing type parameter specification as param.

Source code in src/pygerber/gerberx3/tokenizer/decorators.py 
13
14
class UseType(Generic[T]):
    """Placeholder for passing type parameter specification as param."""

AnnotateSpecSection

Add Gerber specification reference link to docstring.

Source code in src/pygerber/gerberx3/tokenizer/decorators.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class AnnotateSpecSection:
    """Add Gerber specification reference link to docstring."""

    def __init__(self, spec_section: Revision202308) -> None:
        self.spec_section = spec_section

    def __call__(self, class_: type[TokenT]) -> type[TokenT]:
        """Update docstring with specification reference."""
        class_.__doc__ = (class_.__doc__ or "") + (
            "\n\n"
            f"See section {self.spec_section.get_sec_id()} of "
            "The Gerber Layer Format Specification "
            f"{Revision.Revision_2023_08} - "
            f"{self.spec_section.get_url()}"
        )
        return class_

__call__ 

__call__(class_: type[TokenT]) -> type[TokenT]

Update docstring with specification reference.

Source code in src/pygerber/gerberx3/tokenizer/decorators.py 
23
24
25
26
27
28
29
30
31
32
def __call__(self, class_: type[TokenT]) -> type[TokenT]:
    """Update docstring with specification reference."""
    class_.__doc__ = (class_.__doc__ or "") + (
        "\n\n"
        f"See section {self.spec_section.get_sec_id()} of "
        "The Gerber Layer Format Specification "
        f"{Revision.Revision_2023_08} - "
        f"{self.spec_section.get_url()}"
    )
    return class_