Drop Py37, improve typing and docstrings (#544)

Drops Py3.7, improves typing and adds a mypy config, improves the docstrings and isorts the imports.

* configure isort
* sort with isort
* add github action
* enable flake8-docstrings
* fix docstrings
* add mypy env
* no implicit optional
* add type for raw
* add some type hints

examples/barcodes.py

@@ -1,6 +1,6 @@
+"""Example for printing barcodes."""
 from escpos.printer import Usb
 
-
 # Adapt to your needs
 p = Usb(0x0416, 0x5011, profile="TM-T88II")
 

examples/codepage_tables.py

@@ -1,23 +1,24 @@
-"""Prints code page tables.
-"""
+"""Prints code page tables."""
 
 
+import sys
+
 import six
-import sys
 
 from escpos import printer
 from escpos.constants import (
     CODEPAGE_CHANGE,
-    ESC,
-    CTL_LF,
-    CTL_FF,
     CTL_CR,
+    CTL_FF,
     CTL_HT,
+    CTL_LF,
     CTL_VT,
+    ESC,
 )
 
 
 def main():
+    """Init printer and print codepage tables."""
     dummy = printer.Dummy()
 
     dummy.hw("init")
@@ -34,6 +35,7 @@ def main():
 
 
 def print_codepage(printer, codepage):
+    """Print a codepage."""
     if codepage.isdigit():
         codepage = int(codepage)
         printer._raw(CODEPAGE_CHANGE + six.int2byte(codepage))

examples/docker-flask/app.py

@@ -1,12 +1,15 @@
-from escpos.printer import CupsPrinter
+"""Example for a flask application."""
 from flask import Flask
 
+from escpos.printer import CupsPrinter
+
 # Initialize Flask app
 app = Flask(__name__)
 
 
 @app.route("/", methods=["GET"])
 def do_print():
+    """Print."""
     # p = Usb(0x04b8, 0x0e28, 0)
     p = CupsPrinter(host="localhost", port=631, printer_name="TM-T20III")
     p.text("Hello World\n")

examples/docker-flask/requirements.txt

@@ -3,7 +3,6 @@ argcomplete==3.0.8
 blinker==1.6.2
 click==8.1.3
 Flask==2.3.2
-future==0.18.3
 itsdangerous==2.1.2
 Jinja2==3.1.2
 MarkupSafe==2.1.2

examples/qr_code.py

@@ -1,9 +1,11 @@
+"""Print example QR codes."""
 import sys
 
 from escpos.printer import Usb
 
 
 def usage():
+    """Print information on usage."""
     print("usage: qr_code.py <content>")
 
 

examples/software_barcode.py

@@ -1,6 +1,6 @@
+"""Example file for software barcodes."""
 from escpos.printer import Usb
 
-
 # Adapt to your needs
 p = Usb(0x0416, 0x5011, profile="POS-5890")
 

examples/weather.py

@@ -1,28 +1,29 @@
 #!/usr/bin/python
+"""Weather forecast example.
+
+Adapted script from Adafruit
+Weather forecast for Raspberry Pi w/Adafruit Mini Thermal Printer.
+Retrieves data from DarkSky.net's API, prints current conditions and
+forecasts for next two days.
+Weather example using nice bitmaps.
+Written by Adafruit Industries.  MIT license.
+Adapted and enhanced for escpos library by MrWunderbar666
+
+Icons taken from https://adamwhitcroft.com/climacons/
+Check out his github: https://github.com/AdamWhitcroft/climacons
+"""
 
 
-# Adapted script from Adafruit
-# Weather forecast for Raspberry Pi w/Adafruit Mini Thermal Printer.
-# Retrieves data from DarkSky.net's API, prints current conditions and
-# forecasts for next two days.
-# Weather example using nice bitmaps.
-# Written by Adafruit Industries.  MIT license.
-# Adapted and enhanced for escpos library by MrWunderbar666
-
-# Icons taken from https://adamwhitcroft.com/climacons/
-# Check out his github: https://github.com/AdamWhitcroft/climacons
-
-
-from datetime import datetime
 import calendar
-import urllib
 import json
-import time
 import os
+import time
+import urllib
+from datetime import datetime
 
 from escpos.printer import Usb
 
-""" Setting up the main pathing """
+"""Set up the main pathing."""
 this_dir, this_filename = os.path.split(__file__)
 GRAPHICS_PATH = os.path.join(this_dir, "graphics/climacons/")
 
@@ -38,13 +39,14 @@ LONG = "114.189945"  # Your Location
 
 
 def forecast_icon(idx):
+    """Get right icon for forecast."""
     icon = data["daily"]["data"][idx]["icon"]
     image = GRAPHICS_PATH + icon + ".png"
     return image
 
 
-# Dumps one forecast line to the printer
 def forecast(idx):
+    """Dump one forecast line to the printer."""
     date = datetime.fromtimestamp(int(data["daily"]["data"][idx]["time"]))
     day = calendar.day_name[date.weekday()]
     lo = data["daily"]["data"][idx]["temperatureMin"]
@@ -73,6 +75,7 @@ def forecast(idx):
 
 
 def icon():
+    """Get icon."""
     icon = data["currently"]["icon"]
     image = GRAPHICS_PATH + icon + ".png"
     return image