Add some additional type hints

Author: WhyNotHugo

barcode/__init__.py

@@ -6,6 +6,7 @@
 import os
 from typing import BinaryIO
 from typing import Dict
+from typing import Optional
 from typing import Union
 
 from barcode.codabar import CODABAR
@@ -56,16 +57,21 @@
 PROVIDED_BARCODES.sort()
 
 
-def get(name, code=None, writer=None, options=None):
+def get(
+    name: str,
+    code: Optional[str] = None,
+    writer=None,
+    options: Optional[dict] = None,
+):
     """Helper method for getting a generator or even a generated code.
 
-    :param str name: The name of the type of barcode desired.
-    :param str code: The actual information to encode. If this parameter is
+    :param name: The name of the type of barcode desired.
+    :param code: The actual information to encode. If this parameter is
         provided, a generated barcode is returned. Otherwise, the barcode class
         is returned.
     :param Writer writer: An alternative writer to use when generating the
         barcode.
-    :param dict options: Additional options to be passed on to the barcode when
+    :param options: Additional options to be passed on to the barcode when
         generating.
     """
     options = options or {}

barcode/base.py

@@ -1,6 +1,10 @@
 """barcode.base
 
 """
+from typing import List
+from typing import Optional
+
+from barcode.writer import BaseWriter
 from barcode.writer import SVGWriter
 
 
@@ -23,7 +27,9 @@ class Barcode:
         "text": "",
     }
 
-    def to_ascii(self):
+    writer: BaseWriter
+
+    def to_ascii(self) -> str:
         code = self.build()
         for i, line in enumerate(code):
             code[i] = line.replace("1", "X").replace("0", " ")
@@ -32,7 +38,7 @@ def to_ascii(self):
     def __repr__(self):
         return f"<{self.__class__.__name__}({self.get_fullcode()!r})>"
 
-    def build(self):
+    def build(self) -> List[str]:
         raise NotImplementedError
 
     def get_fullcode(self):
@@ -43,20 +49,16 @@ def get_fullcode(self):
         """
         raise NotImplementedError
 
-    def save(self, filename, options=None, text=None):
+    def save(
+        self, filename: str, options: Optional[dict] = None, text: Optional[str] = None
+    ) -> str:
         """Renders the barcode and saves it in `filename`.
 
-        :parameters:
-            filename : String
-                Filename to save the barcode in (without filename
-                extension).
-            options : Dict
-                The same as in `self.render`.
-            text : str
-                Text to render under the barcode.
+        :param filename: Filename to save the barcode in (without filename extension).
+        :param options: The same as in `self.render`.
+        :param text: Text to render under the barcode.
 
         :returns: The full filename with extension.
-        :rtype: String
         """
         output = self.render(options, text) if text else self.render(options)
 
@@ -77,14 +79,11 @@ def write(self, fp, options=None, text=None):
         output = self.render(options, text)
         self.writer.write(output, fp)
 
-    def render(self, writer_options=None, text=None):
+    def render(self, writer_options: Optional[dict] = None, text: Optional[str] = None):
         """Renders the barcode using `self.writer`.
 
-        :parameters:
-            writer_options : Dict
-                Options for `self.writer`, see writer docs for details.
-            text : str
-                Text to render under the barcode.
+        :param writer_options: Options for `self.writer`, see writer docs for details.
+        :param text: Text to render under the barcode.
 
         :returns: Output of the writers render method.
         """

barcode/codex.py

@@ -2,6 +2,9 @@
 
 :Provided barcodes: Code 39, Code 128, PZN
 """
+
+from typing import Tuple
+
 from barcode.base import Barcode
 from barcode.charsets import code39
 from barcode.charsets import code128
@@ -16,7 +19,7 @@
 MIN_QUIET_ZONE = 2.54
 
 
-def check_code(code, name, allowed):
+def check_code(code: str, name: str, allowed: Tuple[str, ...]) -> None:
     wrong = []
     for char in code:
         if char not in allowed:
@@ -48,7 +51,7 @@ def __init__(self, code: str, writer=None, add_checksum: bool = True):
         self.writer = writer or self.default_writer()
         check_code(self.code, self.name, code39.REF)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.code
 
     def get_fullcode(self) -> str: