Add a few additional type hints

Author: WhyNotHugo

barcode/base.py

@@ -35,7 +35,7 @@ def to_ascii(self) -> str:
             code[i] = line.replace("1", "X").replace("0", " ")
         return "\n".join(code)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"<{self.__class__.__name__}({self.get_fullcode()!r})>"
 
     def build(self) -> List[str]:

barcode/codabar.py

@@ -27,13 +27,13 @@ class CODABAR(Barcode):
 
     name = "Codabar (NW-7)"
 
-    def __init__(self, code, writer=None, narrow=2, wide=5):
+    def __init__(self, code, writer=None, narrow=2, wide=5) -> None:
         self.code = code
         self.writer = writer or self.default_writer()
         self.narrow = narrow
         self.wide = wide
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.code
 
     def get_fullcode(self):

barcode/codex.py

@@ -3,7 +3,7 @@
 :Provided barcodes: Code 39, Code 128, PZN
 """
 
-from typing import Tuple
+from typing import Collection
 
 from barcode.base import Barcode
 from barcode.charsets import code39
@@ -19,7 +19,7 @@
 MIN_QUIET_ZONE = 2.54
 
 
-def check_code(code: str, name: str, allowed: Tuple[str, ...]) -> None:
+def check_code(code: str, name: str, allowed: Collection[str]) -> None:
     wrong = []
     for char in code:
         if char not in allowed:
@@ -37,7 +37,7 @@ class Code39(Barcode):
 
     name = "Code 39"
 
-    def __init__(self, code: str, writer=None, add_checksum: bool = True):
+    def __init__(self, code: str, writer=None, add_checksum: bool = True) -> None:
         r"""
         :param code: Code 39 string without \* and without checksum.
         :param writer: A ``barcode.writer`` instance used to render the barcode
@@ -92,7 +92,7 @@ class PZN7(Code39):
 
     digits = 6
 
-    def __init__(self, pzn, writer=None):
+    def __init__(self, pzn, writer=None) -> None:
         pzn = pzn[: self.digits]
         if not pzn.isdigit():
             raise IllegalCharacterError("PZN can only contain numbers.")
@@ -135,14 +135,14 @@ class Code128(Barcode):
 
     name = "Code 128"
 
-    def __init__(self, code, writer=None):
+    def __init__(self, code, writer=None) -> None:
         self.code = code
         self.writer = writer or self.default_writer()
         self._charset = "B"
         self._buffer = ""
         check_code(self.code, self.name, code128.ALL)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.code
 
     @property
@@ -268,7 +268,7 @@ class Gs1_128(Code128):  # noqa: N801
 
     FNC1_CHAR = "\xf1"
 
-    def __init__(self, code, writer=None):
+    def __init__(self, code, writer=None) -> None:
         code = self.FNC1_CHAR + code
         super().__init__(code, writer)
 

barcode/ean.py

@@ -41,7 +41,7 @@ class EuropeanArticleNumber13(Barcode):
 
     digits = 12
 
-    def __init__(self, ean, writer=None, no_checksum=False, guardbar=False):
+    def __init__(self, ean, writer=None, no_checksum=False, guardbar=False) -> None:
         ean = ean[: self.digits]
         if not ean.isdigit():
             raise IllegalCharacterError("EAN code can only contain numbers.")
@@ -72,7 +72,7 @@ def __init__(self, ean, writer=None, no_checksum=False, guardbar=False):
             self.MIDDLE = _ean.MIDDLE
         self.writer = writer or self.default_writer()
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.ean
 
     def get_fullcode(self):
@@ -129,8 +129,8 @@ def render(self, writer_options=None, text=None):
 class EuropeanArticleNumber13WithGuard(EuropeanArticleNumber13):
     name = "EAN-13 with guards"
 
-    def __init__(self, *args, guardbar=True, **kwargs):
-        super().__init__(*args, guardbar=guardbar, **kwargs)
+    def __init__(self, ean, writer=None, no_checksum=False, guardbar=True) -> None:
+        super().__init__(ean, writer, no_checksum, guardbar)
 
 
 class JapanArticleNumber(EuropeanArticleNumber13):
@@ -147,7 +147,7 @@ class JapanArticleNumber(EuropeanArticleNumber13):
 
     valid_country_codes = list(range(450, 460)) + list(range(490, 500))
 
-    def __init__(self, jan, *args, **kwargs):
+    def __init__(self, jan, *args, **kwargs) -> None:
         if int(jan[:3]) not in self.valid_country_codes:
             raise WrongCountryCodeError(
                 "Country code isn't between 450-460 or 490-500."
@@ -193,8 +193,8 @@ def get_fullcode(self):
 class EuropeanArticleNumber8WithGuard(EuropeanArticleNumber8):
     name = "EAN-8 with guards"
 
-    def __init__(self, *args, guardbar=True, **kwargs):
-        super().__init__(*args, guardbar=guardbar, **kwargs)
+    def __init__(self, ean, writer=None, no_checksum=False, guardbar=True) -> None:
+        super().__init__(ean, writer, no_checksum, guardbar)
 
 
 class EuropeanArticleNumber14(EuropeanArticleNumber13):

barcode/errors.py

@@ -3,10 +3,10 @@
 
 
 class BarcodeError(Exception):
-    def __init__(self, msg):
+    def __init__(self, msg) -> None:
         self.msg = msg
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.msg
 
 

barcode/isxn.py

@@ -40,7 +40,7 @@ class InternationalStandardBookNumber13(EuropeanArticleNumber13):
 
     name = "ISBN-13"
 
-    def __init__(self, isbn, writer=None):
+    def __init__(self, isbn, writer=None) -> None:
         isbn = isbn.replace("-", "")
         self.isbn13 = isbn
         if isbn[:3] not in ("978", "979"):
@@ -65,7 +65,7 @@ class InternationalStandardBookNumber10(InternationalStandardBookNumber13):
 
     digits = 9
 
-    def __init__(self, isbn, writer=None):
+    def __init__(self, isbn, writer=None) -> None:
         isbn = isbn.replace("-", "")
         isbn = isbn[: self.digits]
         super().__init__("978" + isbn, writer)
@@ -79,7 +79,7 @@ def _calculate_checksum(self):
 
         return tmp
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.isbn10
 
 
@@ -98,7 +98,7 @@ class InternationalStandardSerialNumber(EuropeanArticleNumber13):
 
     digits = 7
 
-    def __init__(self, issn, writer=None):
+    def __init__(self, issn, writer=None) -> None:
         issn = issn.replace("-", "")
         issn = issn[: self.digits]
         self.issn = issn
@@ -119,7 +119,7 @@ def _calculate_checksum(self):
     def make_ean(self):
         return f"977{self.issn[:7]}00{self._calculate_checksum()}"
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.issn
 
 

barcode/itf.py

@@ -29,7 +29,7 @@ class ITF(Barcode):
 
     name = "ITF"
 
-    def __init__(self, code, writer=None, narrow=2, wide=5):
+    def __init__(self, code, writer=None, narrow=2, wide=5) -> None:
         if not code.isdigit():
             raise IllegalCharacterError("ITF code can only contain numbers.")
         # Length must be even, prepend 0 if necessary
@@ -40,7 +40,7 @@ def __init__(self, code, writer=None, narrow=2, wide=5):
         self.narrow = narrow
         self.wide = wide
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.code
 
     def get_fullcode(self):

barcode/upc.py

@@ -22,7 +22,7 @@ class UniversalProductCodeA(Barcode):
 
     digits = 11
 
-    def __init__(self, upc, writer=None, make_ean=False):
+    def __init__(self, upc, writer=None, make_ean=False) -> None:
         """Initializes new UPC-A barcode.
 
         :param str upc: The upc number as string.
@@ -44,7 +44,7 @@ def __init__(self, upc, writer=None, make_ean=False):
         self.upc = f"{upc}{self.calculate_checksum()}"
         self.writer = writer or self.default_writer()
 
-    def __str__(self):
+    def __str__(self) -> str:
         if self.ean:
             return "0" + self.upc
 

barcode/writer.py

@@ -80,8 +80,12 @@ class BaseWriter:
     """
 
     def __init__(
-        self, initialize=None, paint_module=None, paint_text=None, finish=None
-    ):
+        self,
+        initialize=None,
+        paint_module=None,
+        paint_text=None,
+        finish=None,
+    ) -> None:
         self._callbacks = {
             "initialize": initialize,
             "paint_module": paint_module,
@@ -291,7 +295,7 @@ def render(self, code):
 
 
 class SVGWriter(BaseWriter):
-    def __init__(self):
+    def __init__(self) -> None:
         BaseWriter.__init__(
             self, self._init, self._create_module, self._create_text, self._finish
         )
@@ -398,7 +402,7 @@ class ImageWriter(BaseWriter):  # type: ignore[no-redef]
         mode: str
         dpi: int
 
-        def __init__(self, format="PNG", mode="RGB"):
+        def __init__(self, format="PNG", mode="RGB") -> None:
             """Initialise a new write instance.
 
             :params format: The file format for the generated image. This parameter can