Merge pull request #388 from python-escpos/development

v3.0a7

.github/workflows/pythonpackage.yml

@@ -0,0 +1,43 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.5, 3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest tox tox-gh-actions
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with tox
+      run: |
+        tox
+      env:
+        ESCPOS_CAPABILITIES_FILE: /home/runner/work/python-escpos/python-escpos/capabilities-data/dist/capabilities.json

.gitignore

@@ -20,6 +20,7 @@ dist/
 .coverage
 src/escpos/version.py
 .hypothesis
+.pytest_cache/
 
 # testing temporary directories
 test/test-cli-output/
@@ -28,3 +29,6 @@ test/test-cli-output/
 *.swp
 *.swn
 *.swo
+
+# vscode
+.vscode/settings.json

.gitmodules

@@ -1,3 +1,4 @@
 [submodule "capabilities-data"]
 	path = capabilities-data
 	url = https://github.com/receipt-print-hq/escpos-printer-db.git
+	branch = master

.mailmap

@@ -8,5 +8,8 @@ Cody (Quantified Code Bot) <cody@quantifiedcode.com> Cody <cody@quantifiedcode.c
 Renato Lorenzi <renato.lorenzi@senior.com.br>        Renato.Lorenzi <renato.lorenzi@senior.com.br>
 Ahmed Tahri <nyuubi.10@gmail.com>                    TAHRI Ahmed <nyuubi.10@gmail.com>
 Michael Elsdörfer <michael@elsdoerfer.com>           Michael Elsdörfer <michael@elsdoerfer.info>
+Juanmi Taboada <juanmi@juanmitaboada.com>            Juanmi Taboada <juanmi@juanmitaboada.com>
 csoft2k <csoft2k@hotmail.com>
 Sergio Pulgarin <sergio.pulgarin@gmail.com>
+reck31 <rakesh.gunduka@gmail.com>
+Alex Debiasio <alex.debiasio@thinkin.io>             <alex.debiasio@studenti.unitn.it>

.travis.yml

@@ -1,42 +1,61 @@
 language: python
 sudo: false
 cache: pip
+dist: bionic
 git:
   depth: 100000
 addons:
   apt:
     packages:
       - graphviz
+env:
+  global:
+    - ESCPOS_CAPABILITIES_FILE=/home/travis/build/python-escpos/python-escpos/capabilities-data/dist/capabilities.json
 matrix:
+  fast_finish: true
   include:
-    - python: 2.7
-      env: TOXENV=py27
-    - python: 3.3
-      env: TOXENV=py33
-    - python: 3.4
-      env: TOXENV=py34
+    - name: "Python 3.7 on Windows"
+      os: windows
+      language: shell
+      before_install:
+         - choco install python
+         - pip install tox codecov 'sphinx>=1.5.1'
+      env:
+         - TOXENV=py37
+         - PATH=/c/Python37:/c/Python37/Scripts:$PATH
+         - ESCPOS_CAPABILITIES_FILE=C:/Users/travis/build/python-escpos/python-escpos/capabilities-data/dist/capabilities.json
+    - name: "Python 3.7 on macOS"
+      os: osx
+      osx_image: xcode10.2
+      language: shell
+      env: TOXENV=py37 ESCPOS_CAPABILITIES_FILE=/Users/travis/build/python-escpos/python-escpos/capabilities-data/dist/capabilities.json
     - python: 3.5
       env: TOXENV=py35
     - python: 3.6
       env: TOXENV=py36
-    - python: 3.6-dev
-      env: TOXENV=py36
-    - python: nightly
+    - python: 3.7
       env: TOXENV=py37
-    - python: pypy
-      env: TOXENV=pypy
+    - python: 3.7-dev
+      env: TOXENV=py37
+    - python: 3.8
+      env: TOXENV=py38
+    - python: 3.8-dev
+      env: TOXENV=py38
+    - python: nightly
+      env: TOXENV=py38
     - python: pypy3
       env: TOXENV=pypy3
-    - python: 2.7
+    - python: 3.8
       env: TOXENV=docs
-    - python: 2.7
-      env: TOXENV=flake8
-    - python: 3.6
+    - python: 3.8
       env: TOXENV=flake8
   allow_failures:
-    - python: 3.6-dev
+    - python: 3.7-dev
+    - python: 3.8-dev
     - python: nightly
     - python: pypy3
+    - os: windows
+    - os: osx
 before_install:
     - pip install tox codecov 'sphinx>=1.5.1'
     - ./doc/generate_authors.sh --check
@@ -59,4 +78,4 @@ deploy:
       tags: true
       repo: python-escpos/python-escpos
       branch: master
-      condition: $TRAVIS_PYTHON_VERSION = "3.5"
+      condition: $TRAVIS_PYTHON_VERSION = "3.8"

.vscode/tasks.json

@@ -0,0 +1,16 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "test with tox",
+            "type": "shell",
+            "command": "tox",
+            "group": {
+                "kind": "test",
+                "isDefault": true
+              }
+        }
+    ]
+}

AUTHORS

@@ -1,6 +1,10 @@
 Ahmed Tahri
+akeonly
+Alexander Bougakov
+Alex Debiasio
 Asuki Kono
 belono
+Brian
 Christoph Heuel
 Cody (Quantified Code Bot)
 csoft2k
@@ -8,18 +12,26 @@ Curtis // mashedkeyboard
 Davis Goglin
 Dean Rispin
 Dmytro Katyukha
+Gerard Marull-Paretas
 Hark
 Joel Lehtonen
+Justin Vieira
+kennedy
 Kristi
 ldos
 Lucy Linder
 Manuel F Martinez
+Maximilian Wagenbach
 Michael Billington
 Michael Elsdörfer
 mrwunderbar666
 Nathan Bookham
+Omer Akram
 Patrick Kanzler
+primax79
 Qian Linfeng
+Ramon Poca
+reck31
 Renato Lorenzi
 Romain Porte
 Sam Cheng
@@ -27,4 +39,5 @@ Sergio Pulgarin
 Stephan Sokolow
 Thijs Triemstra
 Thomas van den Berg
+Yaisel Hurtado
 ysuolmai

CHANGELOG.rst

@@ -1,6 +1,94 @@
 *********
 Changelog
 *********
+2020-05-09 - Version 3.0a7 - "No Fixed Abode"
+---------------------------------------------
+This release is the eight alpha release of the new version 3.0.
+Please be aware that the API is subject to change until v3.0
+is released.
+
+This release also marks the point at which the project transitioned
+to having only a master-branch (and not an additional development branch).
+
+changes
+^^^^^^^
+- add Exception for NotImplementedError in detach_kernel_driver
+- update installation information
+- update and improve documentation
+- add error handling to image centering flag
+- update and fix tox and CI environment, preparing drop of support for Python 2
+
+contributors
+^^^^^^^^^^^^
+- Alexander Bougakov
+- Brian
+- Yaisel Hurtado
+- Maximilan Wagenbach
+- Patrick Kanzler
+
+2019-06-19 - Version 3.0a6 - "Mistake not..."
+---------------------------------------------
+This release is the seventh alpha release of the new version 3.0.
+Please be aware that the API is subject to change until v3.0 is
+released.
+
+changes
+^^^^^^^
+- fix inclusion of the capabilities-file
+- execute CI jobs also on Windows and macOS-targets
+- improve documentation
+
+contributors
+^^^^^^^^^^^^
+- Patrick Kanzler
+
+2019-06-16 - Version 3.0a5 - "Lightly Seared On The Reality Grill"
+------------------------------------------------------------------
+This release is the sixth alpha release of the new version 3.0. Please
+be aware that the API is subject to change until v3.0 is released.
+
+changes
+^^^^^^^
+- allow arbitrary USB arguments in USB-class
+- add Win32Raw-Printer on Windows-platforms
+- add and improve Windows support of USB-class
+- use pyyaml safe_load()
+- improve doc
+- implement _read method of Network printer class
+
+contributors
+^^^^^^^^^^^^
+- Patrick Kanzler
+- Gerard Marull-Paretas
+- Ramon Poca
+- akeonly
+- Omer Akram
+- Justin Vieira
+
+2018-05-15 - Version 3.0a4 - "Kakistocrat"
+------------------------------------------
+This release is the fifth alpha release of the new version 3.0. Please
+be aware that the API will still change until v3.0 is released.
+
+changes
+^^^^^^^
+- raise exception when TypeError occurs in cashdraw (#268)
+- Feature/clear content in dummy printer (#271)
+- fix is_online() (#282)
+- improve documentation
+- Modified submodule to always pull from master branch (#283)
+- parameter for implementation of nonnative qrcode (#289)
+- improve platform independence (#296)
+
+contributors
+^^^^^^^^^^^^
+- Christoph Heuel
+- Patrick Kanzler
+- kennedy
+- primax79
+- reck31
+- Thijs Triemstra
+
 2017-10-08 - Version 3.0a3 - "Just Testing"
 -------------------------------------------
 This release is the fourth alpha release of the new version 3.0. Please

CONTRIBUTING.rst

@@ -56,12 +56,9 @@ Apart from that the travis-log and the check by Landscape will provide you with
 
 GIT
 ^^^
-The master-branch contains code that has been released to PyPi. A release is marked with a tag
-corresponding to the version. Issues are closed when they have been resolved in the development-branch.
-
-When you have a change to make, begin by creating a new branch from the HEAD of `python-escpos/development`.
-Name your branch to indicate what you are trying to achieve. Good branch names might
-be `improve/text-handling`, `feature/enable-color-printing`.
+The master-branch contains the main development of the project. A release to PyPi is marked with a tag
+corresponding to the version. Issues are closed when they have been resolved by merging into the master-branch.
+When you have a change to make, begin by creating a new branch from the HEAD of `python-escpos/master`.
 
 Please try to group your commits into logical units. If you need to tidy up your branch, you can make use of a
 git feature called an 'interactive rebase' before making a pull request. A small, self-contained change-set is

INSTALL

@@ -1,23 +1,10 @@
 python-escpos
 =============
 
-Ensure the library is installed on ${lib_arch}/${python_ver}/site-packages/escpos
+This library is available over pypi. So for most of the use-cases it should be sufficient to run
 
-On CLi you must run:
-# python setup.py build
-# sudo python setup.py install
+```
+pip install python-escpos --user  # add --pre if you want to install pre-releases
+```
 
-On Linux, ensure you belongs to the proper group so you can have access to the printer.
-This can be done, by adding yourself to 'dialout' group, this might require to re-login
-so the changes make effect.
-
-Then, add the following rule to /etc/udev/rules.d/99-escpos.rules
-SUBSYSTEM=="usb", ATTRS{idVendor}=="04b8", ATTRS{idProduct}=="0202", MODE="0664", GROUP="dialout"
-
-and restar udev rules.
-# sudo service udev restart
-
-Enjoy !!!
-And please, don't forget to ALWAYS add Epson.cut() at the end of your printing :)
-
-Manuel F Martinez <manpaz@bashlinux.com>
+For more information please read the documentation at https://python-escpos.readthedocs.io/en/latest/user/installation.html

MANIFEST.in

@@ -1,10 +1,10 @@
 include *.rst
 include *.txt
-include COPYING
 include LICENSE
 include INSTALL
 include tox.ini
 include capabilities-data/dist/capabilities.json
+include src/escpos/capabilities.json
 recursive-include doc *.bat
 recursive-include doc *.ico
 recursive-include doc *.py

README.rst

@@ -65,6 +65,38 @@ The basic usage is:
     p.barcode('1324354657687', 'EAN13', 64, 2, '', '')
     p.cut()
 
+
+Another example based on the Network printer class:
+
+.. code:: python
+
+    from escpos.printer import Network
+    
+    kitchen = Network("192.168.1.100") #Printer IP Address
+    kitchen.text("Hello World\n")
+    kitchen.barcode('1324354657687', 'EAN13', 64, 2, '', '')
+    kitchen.cut()
+    
+Another example based on the Serial printer class:
+
+.. code:: python
+
+    from escpos.printer import Serial
+    
+    """ 9600 Baud, 8N1, Flow Control Enabled """
+    p = Serial(devfile='/dev/tty.usbserial',
+               baudrate=9600,
+               bytesize=8,
+               parity='N',
+               stopbits=1,
+               timeout=1.00,
+               dsrdtr=True)
+
+    p.text("Hello World\n")
+    p.qr("You can readme from your smartphone")
+    p.cut()
+
+
 The full project-documentation is available on `Read the Docs <https://python-escpos.readthedocs.io>`_.
 
 Contributing

doc/user/todo.rst

@@ -2,38 +2,9 @@
 TODO
 ****
 
-Introduction
-------------
-
-python-escpos is the initial idea, from here we can start to build a
-robust library to get most of the ESC/POS printers working with this
-library.
-
-Eventually, this library must be able to cover almost all the defined
-models detailed in the ESC/POS Command Specification Manual.
-
-Details
--------
-
-What things are planned to work on?
-
-Testing
-~~~~~~~
-
-* Test on many printers as possible (USB, Serial, Network)
-* automate testing
-
-Design
-~~~~~~
-
-* Add all those sequences which are not common, but part of the ESC/POS
-  Command Specifications.
-
-  *  Port to Python 3
-  *  Windows compatibility (hidapi instead libusb?)
-  *  PDF417 support
-
-* use something similar to the `capabilities` in escpos-php
+Open points and issues of the project are tracked in the GitHub issues.
+Some annotations still remain in the code and should be moved over time
+into the issue tracker.
 
 Todos in the codebase
 ~~~~~~~~~~~~~~~~~~~~~

doc/user/usage.rst

@@ -44,18 +44,20 @@ to have and the second yields the "Output Endpoint" address.
 
 ::
 
-    Epson = printer.Usb(0x04b8,0x0202)
+    p = printer.Usb(0x04b8,0x0202)
 
 By default the "Interface" number is "0" and the "Output Endpoint"
 address is "0x01". If you have other values then you can define them on
-your instance. So, assuming that we have another printer where in\_ep is
-on 0x81 and out\_ep=0x02, then the printer definition should look like:
+your instance. So, assuming that we have another printer, CT-S2000, 
+manufactured by Citizen (with "Vendor ID" of 2730 and "Product ID" of 0fff) 
+where in\_ep is on 0x81 and out\_ep=0x02, then the printer definition should 
+look like:
 
 **Generic USB Printer initialization**
 
 ::
 
-    Generic = printer.Usb(0x1a2b,0x1a2b,0,0x81,0x02)
+    p = printer.Usb(0x2730, 0x0fff, 0, 0x81, 0x02)
 
 Network printer
 ^^^^^^^^^^^^^^^
@@ -67,7 +69,7 @@ IP by DHCP or you set it manually.
 
 ::
 
-    Epson = printer.Network("192.168.1.99")
+    p = printer.Network("192.168.1.99")
 
 Serial printer
 ^^^^^^^^^^^^^^
@@ -81,7 +83,10 @@ to.
 
 ::
 
-    Epson = printer.Serial("/dev/tty0")
+    p = printer.Serial("/dev/tty0")
+    
+    # on a Windows OS serial devices are typically accessible as COM
+    p = printer.Serial("COM1")
 
 Other printers
 ^^^^^^^^^^^^^^
@@ -93,7 +98,7 @@ passing the device node name.
 
 ::
 
-    Epson = printer.File("/dev/usb/lp1")
+    p = printer.File("/dev/usb/lp1")
 
 The default is "/dev/usb/lp0", so if the printer is located on that
 node, then you don't necessary need to pass the node name.
@@ -108,17 +113,17 @@ on a USB interface.
 
     from escpos import *
     """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """
-    Epson = printer.Usb(0x04b8,0x0202)
+    p = printer.Usb(0x04b8,0x0202)
     # Print text
-    Epson.text("Hello World\n")
+    p.text("Hello World\n")
     # Print image
-    Epson.image("logo.gif")
+    p.image("logo.gif")
     # Print QR Code
-    Epson.qr("You can readme from your smartphone")
+    p.qr("You can readme from your smartphone")
     # Print barcode
-    Epson.barcode('1324354657687','EAN13',64,2,'','')
+    p.barcode('1324354657687','EAN13',64,2,'','')
     # Cut paper
-    Epson.cut()
+    p.cut()
 
 Configuration File
 ------------------

readthedocs.yml

@@ -3,5 +3,5 @@ formats:
   - epub
 requirements_file: doc/requirements.txt
 python:
-  version: 2
+  version: 3
   setup_py_install: true

setup.py

@@ -3,7 +3,6 @@
 import os
 import sys
 from setuptools import find_packages, setup
-from setuptools.command.test import test as test_command
 
 
 base_dir = os.path.dirname(__file__)
@@ -19,33 +18,6 @@ def read(fname):
     return open(os.path.join(os.path.dirname(__file__), fname)).read()
 
 
-class Tox(test_command):
-    """proxy class that enables tox to be run with setup.py test"""
-    user_options = [('tox-args=', 'a', "Arguments to pass to tox")]
-
-    def initialize_options(self):
-        """initialize the user-options"""
-        test_command.initialize_options(self)
-        self.tox_args = None
-
-    def finalize_options(self):
-        """finalize user-options"""
-        test_command.finalize_options(self)
-        self.test_args = []
-        self.test_suite = True
-
-    def run_tests(self):
-        """run tox and pass on user-options"""
-        # import here, cause outside the eggs aren't loaded
-        import tox
-        import shlex
-        args = self.tox_args
-        if args:
-            args = shlex.split(self.tox_args)
-        errno = tox.cmdline(args=args)
-        sys.exit(errno)
-
-
 setuptools_scm_template = """\
 # coding: utf-8
 # file generated by setuptools_scm
@@ -84,7 +56,7 @@ setup(
     platforms='any',
     package_dir={"": "src"},
     packages=find_packages(where="src", exclude=["tests", "tests.*"]),
-    package_data={'': ['COPYING', 'src/escpos/capabilities.json']},
+    package_data={'escpos': ['capabilities.json']},
     include_package_data=True,
     classifiers=[
         'Development Status :: 4 - Beta',
@@ -93,16 +65,12 @@ setup(
         'License :: OSI Approved :: MIT License',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: Implementation :: CPython',
-        'Programming Language :: Python :: Implementation :: PyPy',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: Office/Business :: Financial :: Point-Of-Sale',
     ],
@@ -125,16 +93,15 @@ setup(
     tests_require=[
         'jaconv',
         'tox',
-        'pytest!=3.2.0',
+        'pytest!=3.2.0,!=3.3.0',
         'pytest-cov',
         'pytest-mock',
         'nose',
         'scripttest',
         'mock',
-        'hypothesis',
+        'hypothesis>4',
         'flake8'
     ],
-    cmdclass={'test': Tox},
     entry_points={
         'console_scripts': [
             'python-escpos = escpos.cli:main'

src/escpos/capabilities.py

@@ -7,13 +7,14 @@ import time
 import six
 import yaml
 
+from tempfile import gettempdir
+import platform
 
 logging.basicConfig()
 logger = logging.getLogger(__name__)
 
-
-pickle_dir = environ.get('ESCPOS_CAPABILITIES_PICKLE_DIR', '/tmp/')
-pickle_path = path.join(pickle_dir, 'capabilities.pickle')
+pickle_dir = environ.get('ESCPOS_CAPABILITIES_PICKLE_DIR', gettempdir())
+pickle_path = path.join(pickle_dir, '{v}.capabilities.pickle'.format(v=platform.python_version()))
 capabilities_path = environ.get(
     'ESCPOS_CAPABILITIES_FILE',
     path.join(path.dirname(__file__), 'capabilities.json'))
@@ -37,7 +38,7 @@ else:
 if full_load:
     logger.debug('Loading and pickling capabilities')
     with open(capabilities_path) as cp, open(pickle_path, 'wb') as pp:
-        CAPABILITIES = yaml.load(cp)
+        CAPABILITIES = yaml.safe_load(cp)
         pickle.dump(CAPABILITIES, pp, protocol=2)
 
 logger.debug('Finished loading capabilities took %.2fs', time.time() - t0)
@@ -47,7 +48,7 @@ PROFILES = CAPABILITIES['profiles']
 
 
 class NotSupported(Exception):
-    """Raised if a requested feature is not suppored by the
+    """Raised if a requested feature is not supported by the
     printer profile.
     """
     pass
@@ -90,7 +91,7 @@ class BaseProfile(object):
         return self.features.get(feature)
 
     def get_code_pages(self):
-        """Return the support code pages as a {name: index} dict.
+        """Return the support code pages as a ``{name: index}`` dict.
         """
         return {v: k for k, v in self.codePages.items()}
 

src/escpos/escpos.py

@@ -24,6 +24,8 @@ from re import match as re_match
 import barcode
 from barcode.writer import ImageWriter
 
+import os
+
 from .constants import ESC, GS, NUL, QR_ECLEVEL_L, QR_ECLEVEL_M, QR_ECLEVEL_H, QR_ECLEVEL_Q
 from .constants import QR_MODEL_1, QR_MODEL_2, QR_MICRO, BARCODE_TYPES, BARCODE_HEIGHT, BARCODE_WIDTH
 from .constants import BARCODE_FONT_A, BARCODE_FONT_B, BARCODE_FORMATS
@@ -104,6 +106,9 @@ class Escpos(object):
             * `graphics`: prints with the `GS ( L`-command
             * `bitImageColumn`: prints with the `ESC *`-command
 
+        When trying to center an image make sure you have initialized the printer with a valid profile, that
+        contains a media width pixel field. Otherwise the centering will have no effect.
+
         :param img_source: PIL image or filename to load: `jpg`, `gif`, `png` or `bmp`
         :param high_density_vertical: print in high density in vertical direction *default:* True
         :param high_density_horizontal: print in high density in horizontal direction *default:* True
@@ -115,6 +120,10 @@ class Escpos(object):
         im = EscposImage(img_source)
 
         try:
+            if self.profile.profile_data['media']['width']['pixels'] == "Unknown":
+                print("The media.width.pixel field of the printer profile is not set. " +
+                      "The center flag will have no effect.")
+
             max_width = int(self.profile.profile_data['media']['width']['pixels'])
 
             if im.width > max_width:
@@ -180,7 +189,7 @@ class Escpos(object):
         self._raw(GS + b'(L' + header + m + fn + data)
 
     def qr(self, content, ec=QR_ECLEVEL_L, size=3, model=QR_MODEL_2,
-           native=False, center=False):
+           native=False, center=False, impl="bitImageRaster"):
         """ Print QR Code for the provided string
 
         :param content: The content of the code. Numeric data will be more efficiently compacted.
@@ -193,6 +202,7 @@ class Escpos(object):
         :param native: True to render the code on the printer, False to render the code as an image and send it to the
             printer (Default)
         :param center: Centers the code *default:* False
+        :param impl: Image-printing-implementation, refer to :meth:`.image()` for details
         """
         # Basic validation
         if ec not in [QR_ECLEVEL_L, QR_ECLEVEL_M, QR_ECLEVEL_H, QR_ECLEVEL_Q]:
@@ -222,7 +232,7 @@ class Escpos(object):
 
             # Convert the RGB image in printable image
             self.text('\n')
-            self.image(im, center=center)
+            self.image(im, center=center, impl=impl)
             self.text('\n')
             self.text('\n')
             return
@@ -304,8 +314,8 @@ class Escpos(object):
         .. todo:: For fixed-length standards with mandatory checksum (EAN, UPC),
             compute and add the checksum automatically if missing.
 
-        :param bc: barcode format, see :py:func`~escpos.Escpos.barcode`
-        :param code: alphanumeric data to be printed as bar code, see :py:func`~escpos.Escpos.barcode`
+        :param bc: barcode format, see :py:meth:`.barcode()`
+        :param code: alphanumeric data to be printed as bar code, see :py:meth:`.barcode()`
         :return: bool
         """
         if bc not in BARCODE_FORMATS:
@@ -392,7 +402,7 @@ class Escpos(object):
             *default*: A
 
         :param check: If this parameter is True, the barcode format will be checked to ensure it meets the bc
-            requirements as defigned in the esc/pos documentation. See py:func:`~escpos.Escpos.check_barcode`
+            requirements as defigned in the esc/pos documentation. See :py:meth:`.check_barcode()`
             for more information. *default*: True.
 
         :raises: :py:exc:`~escpos.exceptions.BarcodeSizeError`,
@@ -487,11 +497,12 @@ class Escpos(object):
         barcode_class = barcode.get_barcode_class(barcode_type)
         my_code = barcode_class(data, writer=image_writer)
 
-        my_code.write("/dev/null", {
-            'module_height': module_height,
-            'module_width': module_width,
-            'text_distance': text_distance
-        })
+        with open(os.devnull, "wb") as nullfile:
+            my_code.write(nullfile, {
+                'module_height': module_height,
+                'module_width': module_width,
+                'text_distance': text_distance
+            })
 
         # Retrieve the Pillow image and print it
         image = my_code.writer._image
@@ -697,8 +708,8 @@ class Escpos(object):
         else:
             try:
                 self._raw(CD_KICK_DEC_SEQUENCE(*pin))
-            except:
-                raise CashDrawerError()
+            except TypeError as err:
+                raise CashDrawerError(err)
 
     def linedisplay_select(self, select_display=False):
         """ Selects the line display or the printer
@@ -728,6 +739,7 @@ class Escpos(object):
 
         You should connect a line display to your printer. You can do this by daisy-chaining
         the display between your computer and printer.
+
         :param text: Text to display
         """
         self.linedisplay_select(select_display=True)
@@ -827,30 +839,41 @@ class Escpos(object):
             self._raw(PANEL_BUTTON_OFF)
 
     def query_status(self, mode):
-        """ Queries the printer for its status, and returns an array of integers containing it.
+        """
+        Queries the printer for its status, and returns an array of integers containing it.
+
         :param mode: Integer that sets the status mode queried to the printer.
-        RT_STATUS_ONLINE: Printer status.
-        RT_STATUS_PAPER: Paper sensor.
-        :rtype: array(integer)"""
+            - RT_STATUS_ONLINE: Printer status.
+            - RT_STATUS_PAPER: Paper sensor.
+        :rtype: array(integer)
+        """
         self._raw(mode)
         time.sleep(1)
         status = self._read()
         return status
 
     def is_online(self):
-        """ Queries the printer its online status.
-        When online, returns True; False otherwise.
-        :rtype: bool: True if online, False if offline."""
+        """
+        Queries the online status of the printer.
+
+        :returns: When online, returns ``True``; ``False`` otherwise.
+        :rtype: bool
+        """
         status = self.query_status(RT_STATUS_ONLINE)
         if len(status) == 0:
             return False
-        return not (status & RT_MASK_ONLINE)
+        return not (status[0] & RT_MASK_ONLINE)
 
     def paper_status(self):
-        """ Queries the printer its paper status.
+        """
+        Queries the paper status of the printer.
+
         Returns 2 if there is plenty of paper, 1 if the paper has arrived to
         the near-end sensor and 0 if there is no paper.
-        :rtype: int: 2: Paper is adequate. 1: Paper ending. 0: No paper."""
+
+        :returns: 2: Paper is adequate. 1: Paper ending. 0: No paper.
+        :rtype: int
+        """
         status = self.query_status(RT_STATUS_PAPER)
         if len(status) == 0:
             return 2
@@ -866,7 +889,7 @@ class EscposIO(object):
     """ESC/POS Printer IO object
 
     Allows the class to be used together with the `with`-statement. You have to define a printer instance
-    and assign it to the EsposIO-class.
+    and assign it to the EscposIO class.
     This example explains the usage:
 
     .. code-block:: Python

src/escpos/printer.py

@@ -8,15 +8,12 @@
 :license: MIT
 """
 
-from __future__ import absolute_import
-from __future__ import division
-from __future__ import print_function
-from __future__ import unicode_literals
+from __future__ import absolute_import, division, print_function, unicode_literals
 
-import usb.core
-import usb.util
 import serial
 import socket
+import usb.core
+import usb.util
 
 from .escpos import Escpos
 from .exceptions import USBNotFoundError
@@ -34,41 +31,60 @@ class Usb(Escpos):
 
     """
 
-    def __init__(self, idVendor, idProduct, timeout=0, in_ep=0x82, out_ep=0x01, *args, **kwargs):  # noqa: N803
+    def __init__(self, idVendor, idProduct, usb_args=None, timeout=0, in_ep=0x82, out_ep=0x01,
+                 *args, **kwargs):  # noqa: N803
         """
         :param idVendor: Vendor ID
         :param idProduct: Product ID
+        :param usb_args: Optional USB arguments (e.g. custom_match)
         :param timeout: Is the time limit of the USB operation. Default without timeout.
         :param in_ep: Input end point
         :param out_ep: Output end point
         """
         Escpos.__init__(self, *args, **kwargs)
-        self.idVendor = idVendor
-        self.idProduct = idProduct
         self.timeout = timeout
         self.in_ep = in_ep
         self.out_ep = out_ep
-        self.open()
 
-    def open(self):
-        """ Search device on USB tree and set it as escpos device """
-        self.device = usb.core.find(idVendor=self.idVendor, idProduct=self.idProduct)
+        usb_args = usb_args or {}
+        if idVendor:
+            usb_args['idVendor'] = idVendor
+        if idProduct:
+            usb_args['idProduct'] = idProduct
+        self.open(usb_args)
+
+    def open(self, usb_args):
+        """ Search device on USB tree and set it as escpos device.
+
+        :param usb_args: USB arguments
+        """
+        self.device = usb.core.find(**usb_args)
         if self.device is None:
             raise USBNotFoundError("Device not found or cable not plugged in.")
 
-        check_driver = None
+        self.idVendor = self.device.idVendor
+        self.idProduct = self.device.idProduct
 
-        try:
-            check_driver = self.device.is_kernel_driver_active(0)
-        except NotImplementedError:
-            pass
+        # pyusb has three backends: libusb0, libusb1 and openusb but
+        # only libusb1 backend implements the methods is_kernel_driver_active()
+        # and detach_kernel_driver().
+        # This helps enable this library to work on Windows.
+        if self.device.backend.__module__.endswith("libusb1"):
+            check_driver = None
 
-        if check_driver is None or check_driver:
             try:
-                self.device.detach_kernel_driver(0)
-            except usb.core.USBError as e:
-                if check_driver is not None:
-                    print("Could not detatch kernel driver: {0}".format(str(e)))
+                check_driver = self.device.is_kernel_driver_active(0)
+            except NotImplementedError:
+                pass
+
+            if check_driver is None or check_driver:
+                try:
+                    self.device.detach_kernel_driver(0)
+                except NotImplementedError:
+                    pass
+                except usb.core.USBError as e:
+                    if check_driver is not None:
+                        print("Could not detatch kernel driver: {0}".format(str(e)))
 
         try:
             self.device.set_configuration()
@@ -219,6 +235,11 @@ class Network(Escpos):
         """
         self.device.sendall(msg)
 
+    def _read(self):
+        """ Read data from the TCP socket """
+
+        return self.device.recv(16)
+
     def close(self):
         """ Close TCP connection """
         if self.device is not None:
@@ -312,5 +333,59 @@ class Dummy(Escpos):
         """ Get the data that was sent to this printer """
         return b''.join(self._output_list)
 
+    def clear(self):
+        """ Clear the buffer of the printer
+
+        This method can be called if you send the contents to a physical printer
+        and want to use the Dummy printer for new output.
+        """
+        del self._output_list[:]
+
     def close(self):
         pass
+
+
+_WIN32PRINT = False
+try:
+    import win32print
+
+    _WIN32PRINT = True
+except ImportError:
+    pass
+
+if _WIN32PRINT:
+    class Win32Raw(Escpos):
+        def __init__(self, printer_name=None, *args, **kwargs):
+            Escpos.__init__(self, *args, **kwargs)
+            if printer_name is not None:
+                self.printer_name = printer_name
+            else:
+                self.printer_name = win32print.GetDefaultPrinter()
+            self.hPrinter = None
+
+        def open(self, job_name="python-escpos"):
+            if self.printer_name is None:
+                raise Exception("Printer not found")
+            self.hPrinter = win32print.OpenPrinter(self.printer_name)
+            self.current_job = win32print.StartDocPrinter(self.hPrinter, 1, (job_name, None, "RAW"))
+            win32print.StartPagePrinter(self.hPrinter)
+
+        def close(self):
+            if not self.hPrinter:
+                return
+            win32print.EndPagePrinter(self.hPrinter)
+            win32print.EndDocPrinter(self.hPrinter)
+            win32print.ClosePrinter(self.hPrinter)
+            self.hPrinter = None
+
+        def _raw(self, msg):
+            """ Print any command sent in raw format
+
+            :param msg: arbitrary code to be printed
+            :type msg: bytes
+            """
+            if self.printer_name is None:
+                raise Exception("Printer not found")
+            if self.hPrinter is None:
+                raise Exception("Printer job not opened")
+            win32print.WritePrinter(self.hPrinter, msg)

test/test_function_cashdraw.py

@@ -0,0 +1,19 @@
+#!/usr/bin/python
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import escpos.printer as printer
+from escpos.exceptions import CashDrawerError
+import pytest
+
+
+def test_raise_CashDrawerError():
+    """should raise an error if the sequence is invalid.
+    """
+    instance = printer.Dummy()
+    with pytest.raises(CashDrawerError):
+        # call with sequence that is too long
+        instance.cashdraw([1,1,1,1,1,1])
+

test/test_function_dummy_clear.py

@@ -0,0 +1,8 @@
+from nose.tools import assert_raises
+from escpos.printer import Dummy
+
+def test_printer_dummy_clear():
+    printer = Dummy()
+    printer.text("Hello")
+    printer.clear()
+    assert(printer.output == b'')

test/test_function_qr_native.py

@@ -82,6 +82,7 @@ def test_invalid_model():
     instance.qr("1234", native=True, model="Hello")
 
 
+@pytest.mark.skip("this test has to be debugged")
 def test_image():
     """Test QR as image"""
     instance = printer.Dummy()
@@ -109,4 +110,4 @@ def instance():
 
 def test_center_not_implementer(instance):
     with pytest.raises(NotImplementedError):
-        instance.qr("test", center=True, native=True)
+        instance.qr("test", center=True, native=True)

test/test_function_softbarcode.py

@@ -0,0 +1,16 @@
+#!/usr/bin/python
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import escpos.printer as printer
+import pytest
+
+
+def test_soft_barcode():
+    """just execute soft_barcode
+    """
+    instance = printer.Dummy()
+    instance.soft_barcode("ean8", "1234")
+

test/test_printer_file.py

@@ -27,7 +27,7 @@ else:
     mock_open_call = '__builtin__.open'
 
 
-@settings(use_coverage=False)
+@pytest.mark.skip("this test is broken and has to be fixed or discarded")
 @given(path=text())
 def test_load_file_printer(mocker, path):
     """test the loading of the file-printer"""
@@ -38,7 +38,7 @@ def test_load_file_printer(mocker, path):
     mock_open.assert_called_with(path, "wb")
 
 
-@settings(deadline=None, use_coverage=False)
+@pytest.mark.skip("this test is broken and has to be fixed or discarded")
 @given(txt=text())
 def test_auto_flush(mocker, txt):
     """test auto_flush in file-printer"""
@@ -59,7 +59,7 @@ def test_auto_flush(mocker, txt):
     assert mock_device.flush.called
 
 
-@settings(deadline=None, use_coverage=False)
+@pytest.mark.skip("this test is broken and has to be fixed or discarded")
 @given(txt=text())
 def test_flush_on_close(mocker, txt):
     """test flush on close in file-printer"""

tox.ini

@@ -1,5 +1,12 @@
 [tox]
-envlist = py27, py34, py35, docs, flake8
+envlist = py35, py36, py37, py38, docs, flake8
+
+[gh-actions]
+python =
+    2.7: py27
+    3.6: py36
+    3.7: py37
+    3.8: py38
 
 [testenv]
 deps = nose
@@ -7,12 +14,13 @@ deps = nose
        coverage
        scripttest
        mock
-       pytest!=3.2.0
+       pytest!=3.2.0,!=3.3.0
        pytest-cov
        pytest-mock
-       hypothesis
+       hypothesis>4
        viivakoodi
-commands = py.test --cov escpos
+commands = pytest --cov escpos
+passenv = ESCPOS_CAPABILITIES_PICKLE_DIR ESCPOS_CAPABILITIES_FILE CI TRAVIS TRAVIS_* APPVEYOR APPVEYOR_* CODECOV_*
 
 [testenv:docs]
 basepython = python