Merge pull request #20 from pablodiegoss/add-white-border

Add white border parameters

Author: pablodiegoss

.github/workflows/python-app.yml

@@ -16,18 +16,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python 3.12
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.12
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install black
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with black
+        pip install poetry==1.8.4
+        poetry install
+    - name: Test with pytest
       run: |
-        black . --check
-    - name: Test with unittest
-      run: |
-        python -m unittest -v tests/*.py
+        poetry run pytest -v

.github/workflows/python-publish.yml

@@ -17,11 +17,11 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: '3.x'
+        python-version: '3.12'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install poetry
+        pip install poetry==1.8.4
     - name: Set Release Version
       id: vars
       run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
@@ -30,5 +30,5 @@ jobs:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        sed -i 's/PLACE_HOLDER_VERSION/${{ env.RELEASE_VERSION }}/' pyproject.toml
+        sed -i 's/0.0.0/${{ env.RELEASE_VERSION }}/' pyproject.toml
         poetry publish --build

Makefile

@@ -0,0 +1,7 @@
+
+lint:
+	ruff format pymarker 
+	ruff check --extend-select I --fix pymarker
+
+check: 
+	ruff check

poetry.lock

@@ -1,3 +1,13 @@
-from .core import *
-from .cli import *
-from .utils import *
+from .cli import generate_patt_and_marker as generate_patt_and_marker
+from .core import (
+    generate_marker as generate_marker,
+)
+from .core import (
+    generate_marker_from_image as generate_marker_from_image,
+)
+from .core import (
+    generate_patt as generate_patt,
+)
+from .core import (
+    generate_patt_from_image as generate_patt_from_image,
+)

pymarker/__init__.py

@@ -1,30 +1,38 @@
 import click
+
 from .core import generate_marker, generate_patt
+from .exceptions import BlackBorderSizeError, WhiteBorderSizeError
 from .utils import echo
 
 
 @click.command()
 @click.argument("filename")
 @click.option("--patt", "-p", is_flag=True, default=False)
 @click.option("--marker", "-m", is_flag=True, default=False)
-@click.option("--string", "-s", is_flag=True, default=False)
-@click.option("--border-size", "-b", default=50)  # 50% is based on template hiro marker
+@click.option("--as_string", "-s", is_flag=True, default=False)
+@click.option("--black-border-size", "-b", default=20)
+@click.option("--white-border-size", "-w", default=3)
 @click.option("--output", "-o", default=None, type=str)
-def generate_patt_and_marker(filename, patt, marker, string, border_size, output):
-    echo("-- Starting PyMarker Generator --".format(filename), silent=string)
-    if (patt and marker) or (not patt and not marker):
-        echo("Generating patt and marker for {}".format(filename), silent=string)
-        # generate_patt must be silent if you are not using the flag string.
-        echo(generate_patt(filename, output, string), silent=not string)
-        generate_marker(filename, border_size, output)
-    elif marker:
-        echo("Generating marker for {}".format(filename), silent=string)
-        generate_marker(filename, border_size, output)
-    elif patt:
-        echo("Generating patt for {}".format(filename), silent=string)
-        echo(generate_patt(filename, output, string), silent=not string)
-
-    echo("Done.", silent=string)
+def generate_patt_and_marker(
+    filename, patt, marker, as_string, black_border_size, white_border_size, output
+):
+    echo("-- Starting PyMarker Generator --".format(), silent=as_string)
+    if marker or (not patt and not marker):
+        echo("Generating marker for {}".format(filename), silent=as_string)
+        try:
+            generate_marker(filename, black_border_size, output, white_border_size)
+        except BlackBorderSizeError:
+            echo("Black border size cannot be less or equal 0 or bigger than 50%")
+            return
+        except WhiteBorderSizeError:
+            echo("White border size cannot be less than 0 or bigger than 50%")
+            return
+
+    if patt or (not patt and not marker):
+        echo("Generating patt for {}".format(filename), silent=as_string)
+        echo(generate_patt(filename, output, as_string), silent=not as_string)
+
+    echo("Done.", silent=as_string)
 
 
 def main():

pymarker/cli.py

@@ -1,36 +1,25 @@
+from PIL import Image
+
+from .exceptions import BlackBorderSizeError, WhiteBorderSizeError
 from .utils import (
-    open_image,
-    get_box_coords,
-    remove_extension,
+    PattStr,
+    add_border,
+    calculate_border,
+    check_path,
+    color_to_file,
+    create_and_open_patt,
+    generate_white_background,
     get_dir,
     get_name,
-    check_path,
-    PattStr,
+    open_image,
     square_image,
 )
-from PIL import Image
-from math import ceil
-
-
-def get_marker_size(image, border_size):
-    size = image.height + (border_size * 2)
-    # Using the size double because the resulting marker should be a square.
-    return (size, size)
-
-
-def create_empty_patt(filename):
-    patt_name = remove_extension(filename) + ".patt"
-    patt_file = open(patt_name, "w")
-    patt_file.close()
-    return patt_name
-
 
-def create_and_open_patt(filename):
-    patt_name = create_empty_patt(filename)
-    return open(patt_name, "a")
+DEFAULT_BLACK_BORDER_PERCENTAGE = 20
+DEFAULT_WHITE_BORDER_PERCENTAGE = 3
 
 
-def generate_patt(filename, output=None, string=False):
+def generate_patt(filename: str, output: str = None, string: bool = False):
     if filename:
         image = open_image(filename)
         # Patt default marker size is 16x16 pixels
@@ -56,8 +45,7 @@ def generate_patt(filename, output=None, string=False):
         raise FileNotFoundError
 
 
-def generate_patt_from_image(image):
-
+def generate_patt_from_image(image: Image.Image) -> PattStr:
     # Patt default marker size is 16x16 pixels
     image = image.resize((16, 16))
 
@@ -76,60 +64,56 @@ def generate_patt_from_image(image):
     return patt.close()
 
 
-def generate_marker_from_image(image: Image.Image, border_percentage=50):
-
-    image = square_image(image)
-    border_size = ceil(image.height * (border_percentage / 100))
-
-    new_image = generate_white_background(image)
-
-    # Default color is black, setting (0, 0, 0) for clarity, as the border should be black
-    marker_size = get_marker_size(new_image, border_size)
-    marker = Image.new("RGB", marker_size, (0, 0, 0))
-    marker.paste(new_image, get_box_coords(new_image, border_size))
+def generate_marker_from_image(
+    original_image: Image.Image,
+    black_border_percentage=DEFAULT_BLACK_BORDER_PERCENTAGE,
+    white_border_percentage=DEFAULT_WHITE_BORDER_PERCENTAGE,
+) -> Image.Image:
+    squared_image = square_image(original_image)
+    try:
+        black_border_size = calculate_border(
+            squared_image.height, (black_border_percentage / 100)
+        )
+    except ValueError as e:
+        raise BlackBorderSizeError(str(e))
+
+    # Create a white background if the image has transparency
+    marker_middle_image = generate_white_background(squared_image)
+
+    # Add black border
+    black = (0, 0, 0)
+    marker = add_border(marker_middle_image, black_border_size, black)
+
+    if white_border_percentage != 0:
+        try:
+            white_border_size = calculate_border(
+                squared_image.height, (white_border_percentage / 100)
+            )
+        except ValueError as e:
+            raise WhiteBorderSizeError(str(e))
+
+        # Add white border
+        white = (255, 255, 255)
+        marker = add_border(marker, white_border_size, white)
 
     return marker
 
 
-def patt_number_format(point):
-    return str(point).rjust(3, " ")
-
-
-# Prints all pixels from a split color to the patt file
-def color_to_file(c, patt):
-    n = 1
-    for point in list(c.getdata()):
-        patt.write(patt_number_format(point))
-        if n != 0 and n % 16 == 0:
-            n = 0
-            patt.write("\n")
-        else:
-            patt.write(" ")
-        n += 1
-
-
-def generate_white_background(image):
-    if len(image.split()) > 3:
-        white_image = Image.new("RGB", image.size, (255, 255, 255))
-        white_image.paste(image, mask=image.split()[3])
-        return white_image
-    return image
-
-
-def generate_marker(filename, border_percentage=50, output=None):
+def generate_marker(
+    filename: str,
+    black_border_percentage: int = DEFAULT_BLACK_BORDER_PERCENTAGE,
+    output=None,
+    white_border_percentage: int = DEFAULT_WHITE_BORDER_PERCENTAGE,
+):
     if filename:
         image = open_image(filename)
         output = check_path(output) if output else get_dir(filename)
         name = get_name(filename)
 
-        border_size = ceil(image.height * (border_percentage / 100))
-
-        new_image = generate_white_background(image)
+        border_marker = generate_marker_from_image(
+            image, black_border_percentage, white_border_percentage
+        )
 
-        # Default color is black, setting (0, 0, 0) for clarity, as the border should be black
-        marker_size = get_marker_size(new_image, border_size)
-        marker = Image.new("RGB", marker_size, (0, 0, 0))
-        marker.paste(new_image, get_box_coords(new_image, border_size))
-        marker.save(output + name + "_marker.png", "PNG")
+        border_marker.save(output + name + "_marker.png", "PNG")
     else:
         raise FileNotFoundError

pymarker/core.py

@@ -0,0 +1,14 @@
+class BlackBorderSizeError(Exception):
+    """Exception raised for errors in the black border size."""
+
+    def __init__(self, message="Black border size must be between 1% and 49%."):
+        self.message = message
+        super().__init__(self.message)
+
+
+class WhiteBorderSizeError(Exception):
+    """Exception raised for errors in the white border size."""
+
+    def __init__(self, message="White border size must be between 1% and 49%."):
+        self.message = message
+        super().__init__(self.message)