-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Gerber to PNG and JPEG command line
- Loading branch information
Showing
9 changed files
with
424 additions
and
426 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
| """Command line commands of PyGerber.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import Callable, Optional | ||
|
|
||
| import click | ||
|
|
||
| from pygerber.gerber.api import Color, FileTypeEnum, GerberFile, Style | ||
| from pygerber.vm.types.color import InvalidHexColorLiteralError | ||
|
|
||
|
|
||
| @click.group("gerber") | ||
| def gerber() -> None: | ||
| """Gerber format related commands.""" | ||
|
|
||
|
|
||
| @gerber.group("convert") | ||
| def convert() -> None: | ||
| """Convert Gerber image to different image format.""" | ||
|
|
||
|
|
||
| def _get_file_type_option() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.option( | ||
| "-t", | ||
| "--file-type", | ||
| "file_type", | ||
| type=click.Choice(list(FileTypeEnum.__members__.keys()), case_sensitive=False), | ||
| default=FileTypeEnum.INFER.name, | ||
| help=( | ||
| "Type (function) of the Gerber file. Affects what colors are used for " | ||
| "rendering. If not specified, file type will be inferred from extension " | ||
| "or .FileFunction attribute." | ||
| ), | ||
| ) | ||
|
|
||
|
|
||
| def _get_style_option() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.option( | ||
| "-s", | ||
| "--style", | ||
| type=click.Choice( | ||
| [*Style.presets.get_styles(), "CUSTOM"], case_sensitive=False | ||
| ), | ||
| default=None, | ||
| help=( | ||
| "Direct style override. When specified, this will override style implied " | ||
| "by file type. When set to CUSTOM, you have to use -f/--foreground and " | ||
| "-b/--background to specify foreground and background colors." | ||
| ), | ||
| ) | ||
|
|
||
|
|
||
| def _get_foreground_option() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.option( | ||
| "-f", | ||
| "--foreground", | ||
| type=str, | ||
| default=None, | ||
| help=( | ||
| "Foreground color in hex format. Only used when --style is set to CUSTOM. " | ||
| "Example: `#FF0000`, `#` is accepted but not mandatory." | ||
| ), | ||
| ) | ||
|
|
||
|
|
||
| def _get_background_option() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.option( | ||
| "-b", | ||
| "--background", | ||
| type=str, | ||
| default=None, | ||
| help=( | ||
| "Background color in hex format. Only used when --style is set to CUSTOM. " | ||
| "Example: `#FF0000`, `#` is accepted but not mandatory." | ||
| ), | ||
| ) | ||
|
|
||
|
|
||
| def _get_raster_implementation_option() -> ( | ||
| Callable[[click.decorators.FC], click.decorators.FC] | ||
| ): | ||
| return click.option( | ||
| "-i", | ||
| "--implementation", | ||
| type=click.Choice(["pillow"], case_sensitive=False), | ||
| default="pillow", | ||
| help="Name of rendering Virtual Machine to be used.", | ||
| ) | ||
|
|
||
|
|
||
| def _get_output_file_option() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.option( | ||
| "-o", | ||
| "--output", | ||
| type=click.Path(dir_okay=False), | ||
| default="output.png", | ||
| help="Path to output file.", | ||
| ) | ||
|
|
||
|
|
||
| def _get_dpmm_option() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.option( | ||
| "-d", | ||
| "--dpmm", | ||
| type=int, | ||
| default=20, | ||
| help="Dots per millimeter.", | ||
| ) | ||
|
|
||
|
|
||
| def _get_source_file_argument() -> Callable[[click.decorators.FC], click.decorators.FC]: | ||
| return click.argument( | ||
| "source", | ||
| type=click.Path(file_okay=True, dir_okay=False, exists=True, readable=True), | ||
| ) | ||
|
|
||
|
|
||
| @convert.command("png") | ||
| @_get_source_file_argument() | ||
| @_get_output_file_option() | ||
| @_get_dpmm_option() | ||
| @_get_file_type_option() | ||
| @_get_style_option() | ||
| @_get_foreground_option() | ||
| @_get_background_option() | ||
| @_get_raster_implementation_option() | ||
| def png( | ||
| source: str, | ||
| output: str, | ||
| file_type: str, | ||
| style: Optional[str], | ||
| foreground: Optional[str], | ||
| background: Optional[str], | ||
| dpmm: int, | ||
| implementation: str, | ||
| ) -> None: | ||
| """Convert Gerber image file to PNG image.""" | ||
| style_obj = _sanitize_style(style, foreground, background) | ||
| file = GerberFile.from_file(source, file_type=FileTypeEnum(file_type.upper())) | ||
|
|
||
| if implementation.lower() == "pillow": | ||
| result = file.render_with_pillow(style_obj, dpmm) | ||
| result.save_png(output) | ||
|
|
||
| else: | ||
| msg = f"Implementation {implementation!r} is not supported." | ||
| raise NotImplementedError(msg) | ||
|
|
||
|
|
||
| def _sanitize_style( | ||
| style: Optional[str], | ||
| foreground: Optional[str], | ||
| background: Optional[str], | ||
| ) -> Optional[Style]: | ||
| style_obj: Optional[Style] = None | ||
|
|
||
| if style is not None: | ||
| style = style.upper() | ||
|
|
||
| if style == "CUSTOM": | ||
| if foreground is None or background is None: | ||
| option_name = "foreground" if foreground is None else "background" | ||
| msg = ( | ||
| "When using CUSTOM style, both foreground and background must be " | ||
| "specified." | ||
| ) | ||
| raise click.BadOptionUsage(option_name, msg) | ||
|
|
||
| try: | ||
| background_color = Color.from_hex(background) | ||
| except InvalidHexColorLiteralError as e: | ||
| msg = f"Invalid hex color literal: {e!r}" | ||
| raise click.BadOptionUsage("background", msg) from e | ||
|
|
||
| try: | ||
| foreground_color = Color.from_hex(foreground) | ||
| except InvalidHexColorLiteralError as e: | ||
| msg = f"Invalid hex color literal: {e!r}" | ||
| raise click.BadOptionUsage("background", msg) from e | ||
|
|
||
| style_obj = Style( | ||
| background=background_color, | ||
| foreground=foreground_color, | ||
| ) | ||
|
|
||
| else: | ||
| style_obj = Style.presets.get_styles().get(style) | ||
|
|
||
| if style_obj is None: | ||
| option_name = "style" | ||
| msg = f"Style {style!r} is not recognized." | ||
| raise click.BadOptionUsage(option_name, msg) | ||
|
|
||
| return style_obj | ||
|
|
||
|
|
||
| @convert.command("jpeg") | ||
| @_get_source_file_argument() | ||
| @_get_output_file_option() | ||
| @_get_dpmm_option() | ||
| @_get_file_type_option() | ||
| @_get_style_option() | ||
| @_get_foreground_option() | ||
| @_get_background_option() | ||
| @_get_raster_implementation_option() | ||
| def jpeg( | ||
| source: str, | ||
| output: str, | ||
| file_type: str, | ||
| style: Optional[str], | ||
| foreground: Optional[str], | ||
| background: Optional[str], | ||
| dpmm: int, | ||
| implementation: str, | ||
| ) -> None: | ||
| """Convert Gerber image file to JPEG image.""" | ||
| style_obj = _sanitize_style(style, foreground, background) | ||
| file = GerberFile.from_file(source, file_type=FileTypeEnum(file_type.upper())) | ||
|
|
||
| if implementation.lower() == "pillow": | ||
| result = file.render_with_pillow(style_obj, dpmm) | ||
| result.save_jpeg(output) | ||
|
|
||
| else: | ||
| msg = f"Implementation {implementation!r} is not supported." | ||
| raise NotImplementedError(msg) | ||
|
|
||
|
|
||
| @gerber.command("project") | ||
| @click.argument("files", nargs=-1) | ||
| @click.option( | ||
| "-o", | ||
| "--output", | ||
| type=click.Path(dir_okay=False), | ||
| default="output.png", | ||
| help="Path to output file.", | ||
| ) | ||
| @click.option("-d", "--dpmm", type=int, default=20, help="Dots per millimeter.") | ||
| def _project(files: str, output: str, dpmm: int) -> None: | ||
| """Render multiple Gerber files and merge them layer by layer. | ||
| Layers are merged from first to last, thus last layer will be on top. | ||
| """ | ||
| raise NotImplementedError |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.