pybarcodes 1.2.1__tar.gz → 1.2.2__tar.gz

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pybarcodes
-Version: 1.2.1
+Version: 1.2.2
 Summary: A Python package for barcode generation
 Author-email: atbuy <buy@atbuy.dev>
 License-Expression: MIT

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pybarcodes/__init__.py

@@ -7,7 +7,7 @@ __title__ = "pybarcodes"
 __author__ = "atbuy"
 __license__ = "MIT"
 __copyright__ = "Copyright 2021-present atbuy"
-__version__ = (1, 2, 1)
+__version__ = (1, 2, 2)
 
 VersionInfo = namedtuple("VersionInfo", "major minor patch")
 

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pybarcodes/barcode.py

@@ -1,22 +1,33 @@
 from collections import namedtuple
 from io import BytesIO
-from typing import Union
+from os import PathLike
+from typing import Any, Optional, Union
 
 from PIL import Image, ImageDraw, ImageFont
 
+BarcodeInput = Union[str, int]
+PathInput = Union[str, PathLike[str]]
+RenderSize = tuple[int, int]
+RenderOptions = tuple[int, int, int, int, int]
+
 
 class Barcode:
     """A base class for all barcode types"""
 
-    def __init__(self, barcode: Union[str, int]):
+    BARCODE_SIZE: RenderSize
+    BARCODE_FONT_SIZE: int
+    BARCODE_COLUMN_NUMBER: int
+    BARCODE_PADDING: Any
+
+    def __init__(self, barcode: BarcodeInput):
         self.code = self.normalize(barcode)
 
     @classmethod
-    def validate(cls, barcode: Union[str, int]) -> None:
+    def validate(cls, barcode: BarcodeInput) -> None:
         """Validate barcode input."""
 
     @classmethod
-    def normalize(cls, barcode: Union[str, int]) -> str:
+    def normalize(cls, barcode: BarcodeInput) -> str:
         """Return the normalized barcode value used by the instance."""
 
         cls.validate(barcode)
@@ -36,11 +47,11 @@ class Barcode:
 
     def render(
         self,
-        size: tuple = None,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        size: Optional[RenderSize] = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
     ) -> Image.Image:
         """Create a PIL Image object for the barcode."""
@@ -59,14 +70,14 @@ class Barcode:
 
     def save(
         self,
-        path: str,
-        size: tuple = None,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        path: PathInput,
+        size: Optional[RenderSize] = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
-        **save_kwargs,
+        **save_kwargs: Any,
     ) -> Image.Image:
         """Create a PIL Image object and save it to the path given.
 
@@ -124,13 +135,13 @@ class Barcode:
     def to_image_bytesio(
         self,
         format: str = "PNG",
-        size: tuple = None,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        size: Optional[RenderSize] = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
-        **save_kwargs,
+        **save_kwargs: Any,
     ) -> BytesIO:
         """Return the rendered barcode image in a BytesIO object."""
 
@@ -149,13 +160,13 @@ class Barcode:
     def to_image_bytes(
         self,
         format: str = "PNG",
-        size: tuple = None,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        size: Optional[RenderSize] = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
-        **save_kwargs,
+        **save_kwargs: Any,
     ) -> bytes:
         """Return the rendered barcode image as bytes."""
 
@@ -170,7 +181,7 @@ class Barcode:
             **save_kwargs,
         ).getvalue()
 
-    def write(self, path: str, encoding: str = "ascii") -> None:
+    def write(self, path: PathInput, encoding: str = "ascii") -> None:
         """
         Tries to save the barcode to a text file
 
@@ -191,12 +202,12 @@ class Barcode:
 
     def _get_render_options(
         self,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
-    ):
+    ) -> RenderOptions:
         padding = self.BARCODE_PADDING
         selected_size, default_font_size = self.BARCODE_SIZE, self.BARCODE_FONT_SIZE
 
@@ -232,10 +243,10 @@ class Barcode:
 
     def _get_barcode_image(
         self,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
     ) -> Image.Image:
         """Creates a PIL Image from the binary string of the barcode
@@ -296,7 +307,7 @@ class Barcode:
         draw.text((x, y), self.code, (0, 0, 0), font=font)
         return base
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         if isinstance(other, self.__class__):
             return self.code == other.code
         elif isinstance(other, str):
@@ -307,5 +318,5 @@ class Barcode:
     def __str__(self) -> str:
         return f"<{self.__class__.__name__}(code={self.code})>"
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return self.__str__()

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pybarcodes/codes.py

@@ -1,9 +1,9 @@
 from collections import namedtuple
-from typing import Union
+from typing import Optional, Union
 
 from PIL import Image, ImageDraw
 
-from .barcode import Barcode
+from .barcode import Barcode, BarcodeInput
 from .codings import codex as CODEXCoding
 from .exceptions import IncorrectFormat
 
@@ -11,7 +11,7 @@ Size = namedtuple("Size", "width height")
 
 
 class Code(Barcode):
-    def __init__(self, barcode: Union[str, int]):
+    def __init__(self, barcode: BarcodeInput):
         super().__init__(barcode)
 
         self.checksum = self.code[-1]
@@ -36,7 +36,7 @@ class Code(Barcode):
         self.BARCODE_COLUMN_NUMBER = column_size
 
     @classmethod
-    def validate(cls, barcode: Union[str, int]) -> None:
+    def validate(cls, barcode: BarcodeInput) -> None:
         code = str(barcode).upper()
 
         for char in code:
@@ -46,7 +46,7 @@ class Code(Barcode):
                 )
 
     @classmethod
-    def normalize(cls, barcode: Union[str, int]) -> str:
+    def normalize(cls, barcode: BarcodeInput) -> str:
         cls.validate(barcode)
         code = str(barcode).upper()
         reference = cls._calculate_checksum(code)
@@ -93,7 +93,7 @@ class Code(Barcode):
 
         return self._convert_to_binary(code)
 
-    def calculate_checksum(self, barcode: Union[str, "CODE39"] = None) -> int:
+    def calculate_checksum(self, barcode: Optional[Union[str, "CODE39"]] = None) -> int:
         """Calculate the checksum of the barcode
 
         Parameters
@@ -126,10 +126,10 @@ class Code(Barcode):
 
     def _get_barcode_image(
         self,
-        module_width: int = None,
-        bar_height: int = None,
-        quiet_zone: int = None,
-        font_size: int = None,
+        module_width: Optional[int] = None,
+        bar_height: Optional[int] = None,
+        quiet_zone: Optional[int] = None,
+        font_size: Optional[int] = None,
         draw_text: bool = True,
     ) -> Image.Image:
         """Creates a PIL Image from the binary string of the barcode.
@@ -291,5 +291,5 @@ class CODE39(Code):
     BARCODE_FONT_SIZE = 30
     BARCODE_PADDING = Size(50, 100)
 
-    def __init__(self, barcode: Union[str, int]):
-        super().__init__(barcode.upper())
+    def __init__(self, barcode: BarcodeInput):
+        super().__init__(barcode)

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pybarcodes/ean.py

@@ -1,7 +1,7 @@
 from collections import namedtuple
 from typing import Union
 
-from .barcode import Barcode
+from .barcode import Barcode, BarcodeInput
 from .codings import ean as EANCoding
 from .exceptions import IncorrectFormat
 
@@ -15,11 +15,11 @@ class EAN(Barcode):
     Shouldn't be used directly and it's subclasses are preferred
     """
 
-    def __init__(self, barcode: Union[str, int]):
+    def __init__(self, barcode: BarcodeInput):
         super().__init__(barcode)
 
     @classmethod
-    def validate(cls, barcode: Union[str, int]) -> None:
+    def validate(cls, barcode: BarcodeInput) -> None:
         code = str(barcode)
 
         if not code.isdigit():
@@ -34,7 +34,7 @@ class EAN(Barcode):
             raise IncorrectFormat(error)
 
     @classmethod
-    def normalize(cls, barcode: Union[str, int]) -> str:
+    def normalize(cls, barcode: BarcodeInput) -> str:
         cls.validate(barcode)
         code = str(barcode)[: cls.BARCODE_LENGTH]
         check_digit = cls.calculate_checksum(code)
@@ -187,7 +187,7 @@ class EAN14(EAN):
     WEIGHTS = Weights(1, 3)
     HAS_STRUCTURE = True
 
-    def __init__(self, barcode: Union[str, int]):
+    def __init__(self, barcode: BarcodeInput):
         super().__init__(barcode)
 
 
@@ -218,7 +218,7 @@ class EAN13(EAN):
     WEIGHTS = Weights(3, 1)
     HAS_STRUCTURE = True
 
-    def __init__(self, barcode: Union[str, int]):
+    def __init__(self, barcode: BarcodeInput):
         super().__init__(barcode)
 
 
@@ -249,7 +249,7 @@ class EAN8(EAN):
     WEIGHTS = Weights(1, 3)
     HAS_STRUCTURE = False
 
-    def __init__(self, barcode: Union[str, int]):
+    def __init__(self, barcode: BarcodeInput):
         super().__init__(barcode)
 
 
@@ -271,7 +271,7 @@ class JAN(EAN13, EAN):
     """
 
     @classmethod
-    def validate(cls, barcode: Union[str, int]) -> None:
+    def validate(cls, barcode: BarcodeInput) -> None:
         super().validate(barcode)
 
         code = str(barcode)
@@ -280,7 +280,7 @@ class JAN(EAN13, EAN):
                 "JAN type barcodes need to start with country code 45 or 49."
             )
 
-    def __init__(self, barcode: Union[str, int]):
+    def __init__(self, barcode: BarcodeInput):
         super().__init__(barcode)
 
         if self.code[:2] not in ("45", "49"):

pybarcodes-1.2.2/pybarcodes/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561 typed packages.

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pybarcodes.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pybarcodes
-Version: 1.2.1
+Version: 1.2.2
 Summary: A Python package for barcode generation
 Author-email: atbuy <buy@atbuy.dev>
 License-Expression: MIT

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pybarcodes.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ pybarcodes/barcode.py
 pybarcodes/codes.py
 pybarcodes/ean.py
 pybarcodes/exceptions.py
+pybarcodes/py.typed
 pybarcodes.egg-info/PKG-INFO
 pybarcodes.egg-info/SOURCES.txt
 pybarcodes.egg-info/dependency_links.txt
@@ -16,4 +17,5 @@ pybarcodes/codings/codex.py
 pybarcodes/codings/ean.py
 tests/test_codes.py
 tests/test_ean.py
-tests/test_images.py
+tests/test_images.py
+tests/test_spec_fixtures.py

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pybarcodes"
-version = "1.2.1"
+version = "1.2.2"
 description = "A Python package for barcode generation"
 authors = [{ name = "atbuy", email = "buy@atbuy.dev" }]
 license = "MIT"
@@ -51,6 +51,9 @@ addopts = "--cov-fail-under=90"
 [tool.setuptools.packages.find]
 include = ["pybarcodes*"]
 
+[tool.setuptools.package-data]
+pybarcodes = ["py.typed"]
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"

{pybarcodes-1.2.1 → pybarcodes-1.2.2}/tests/test_codes.py

@@ -18,6 +18,7 @@ def test_code39():
     assert barcode.calculate_checksum(code) == 40
     assert barcode.calculate_checksum() == 40
     assert CODE39.normalize("abc123") == CODE39("abc123").code
+    assert CODE39(123).code == CODE39.normalize(123)
     assert CODE39.validate("abc123") is None
 
     with pytest.raises(IncorrectFormat):

pybarcodes-1.2.2/tests/test_spec_fixtures.py

@@ -0,0 +1,55 @@
+import pytest
+
+from pybarcodes import CODE39, EAN8, EAN13, EAN14
+
+
+# GS1 check digit algorithm reference:
+# https://www.gs1.org/services/how-calculate-check-digit-manually
+@pytest.mark.parametrize(
+    ("barcode_type", "payload", "expected_code"),
+    [
+        (EAN8, "9638507", "96385074"),
+        (EAN13, "629104150021", "6291041500213"),
+        (EAN14, "1061414145678", "10614141456786"),
+    ],
+)
+def test_gs1_check_digit_fixtures(barcode_type, payload, expected_code):
+    assert barcode_type.normalize(payload) == expected_code
+    assert barcode_type(payload).code == expected_code
+
+
+def test_ean8_binary_pattern_fixture():
+    barcode = EAN8("9638507")
+
+    assert barcode.get_binary_string == (
+        "1010001011010111101111010110111010101001110111001010001001011100101"
+    )
+
+
+def test_ean13_binary_pattern_fixture():
+    barcode = EAN13("629104150021")
+
+    assert barcode.get_binary_string == (
+        "101"
+        "0010011"
+        "0010111"
+        "0110011"
+        "0100111"
+        "0100011"
+        "0011001"
+        "01010"
+        "1001110"
+        "1110010"
+        "1110010"
+        "1101100"
+        "1100110"
+        "1000010"
+        "101"
+    )
+
+
+# Code 39 MOD43 reference:
+# https://docshield.tungstenautomation.com/ControlSuite/en_US/1.5.0-uh5vow9jo0/help/QCP/Dita/ACSCChecksum.html
+def test_code39_mod43_check_digit_fixture():
+    assert CODE39.normalize("+1110001111") == "+11100011115"
+    assert CODE39("+1110001111").calculate_checksum("+1110001111") == 5