Datasets:

teven

/

github_all_lang_filtered

like 0

include *.rst include *.txt 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 recursive-include doc *.rst recursive-include doc *.txt recursive-include doc Makefile

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/env python import os import sys from setuptools import find_packages, setup base_dir = os.path.dirname(__file__) src_dir = os.path.join(base_dir, "src") # When executing the setup.py, we need to be able to import ourselves, this # means that we need to add the src/ directory to the sys.path. sys.path.insert(0, src_dir) def read(fname): """read file from same path as setup.py""" return open(os.path.join(os.path.dirname(__file__), fname)).read() setuptools_scm_template = """\ # coding: utf-8 # file generated by setuptools_scm # don't change, don't track in version control version = '{version}' """ setup( use_scm_version={ "write_to": "src/escpos/version.py", "write_to_template": setuptools_scm_template, }, platforms="any", package_dir={"": "src"}, packages=find_packages(where="src", exclude=["tests", "tests.*"]), package_data={"escpos": ["capabilities.json"]}, entry_points={"console_scripts": ["python-escpos = escpos.cli:main"]}, )

python-escpos/python-escpos

535

Python

constants.rst

text/plain

********* Changelog ********* 2020-05-12 - Version 3.0a8 - "Only Slightly Bent" ------------------------------------------------- This release is the ninth 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 drops support for Python 2, requiring at least version 3.5 of Python. changes ^^^^^^^ - Drop support for Python 2 and mark in setuptools as only supporting 3.5 and upwards - remove landscape.io badge - replace viivakoodi with python-barcode which is maintained - add configuration for Visual Studio Code - use pkg_resources for the retrieval of the capabilities.json contributors ^^^^^^^^^^^^ - Romain Porte - Patrick Kanzler 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 be aware that the API will still change until v3.0 is released. changes ^^^^^^^ - minor changes in documentation, tests and examples - pickle capabilities for faster startup - first implementation of centering images and QR - check barcodes based on regex contributors ^^^^^^^^^^^^ - Patrick Kanzler - Lucy Linder - Romain Porte - Sergio Pulgarin 2017-08-04 - Version 3.0a2 - "It's My Party And I'll Sing If I Want To" ----------------------------------------------------------------------- This release is the third alpha release of the new version 3.0. Please be aware that the API will still change until v3.0 is released. changes ^^^^^^^ - refactor of the set-method - preliminary support of POS "line display" printing - improvement of tests - added ImageWidthError - list authors in repository - add support for software-based barcode-rendering - fix SerialException when trying to close device on __del__ - added the DLE EOT querying command for USB and Serial - ensure QR codes have a large enough border - make feed for cut optional - fix the behavior of horizontal tabs - added test script for hard an soft barcodes - implemented paper sensor querying command - added weather forecast example script - added a method for simpler newlines contributors ^^^^^^^^^^^^ - csoft2k - Patrick Kanzler - mrwunderbar666 - Romain Porte - Ahmed Tahri 2017-03-29 - Version 3.0a1 - "Headcrash" ---------------------------------------- This release is the second alpha release of the new version 3.0. Please be aware that the API will still change until v3.0 is released. changes ^^^^^^^ - automatically upload releases to GitHub - add environment variable ESCPOS_CAPABILITIES_FILE - automatically handle cases where full cut or partial cut is not available - add print_and_feed contributors ^^^^^^^^^^^^ - Sam Cheng - Patrick Kanzler - Dmytro Katyukha 2017-01-31 - Version 3.0a - "Grey Area" --------------------------------------- This release is the first alpha release of the new version 3.0. Please be aware that the API will still change until v3.0 is released. changes ^^^^^^^ - change the project's license to MIT in accordance with the contributors (see python-escpos/python-escpos#171) - feature: add "capabilities" which are shared with escpos-php, capabilities are stored in `escpos-printer-db <https://github.com/receipt-print-hq/escpos-printer-db>`_ - feature: the driver tries now to guess the appropriate codepage and sets it automatically (called "magic encode") - as an alternative you can force the codepage with the old API - updated and improved documentation - changed constructor of main class due to introduction of capablities - changed interface of method `blocktext`, changed behavior of multiple methods, for details refer to the documentation on `python-escpos.readthedocs.io <https://python-escpos.readthedocs.io>`_ - add support for custom cash drawer sequence - enforce flake8 on the src-files, test py36 and py37 on travis contributors ^^^^^^^^^^^^ - Michael Billington - Michael Elsdörfer - Patrick Kanzler (with code by Frédéric Van der Essen) - Asuki Kono - Benito López - Curtis // mashedkeyboard - Thijs Triemstra - ysuolmai 2016-08-26 - Version 2.2.0 - "Fate Amenable To Change" ------------------------------------------------------ changes ^^^^^^^ - fix improper API-use in qrcode() - change setup.py shebang to make it compatible with virtualenvs. - add constants for sheet mode and colors - support changing the linespacing contributors ^^^^^^^^^^^^ - Michael Elsdörfer - Patrick Kanzler 2016-08-10 - Version 2.1.3 - "Ethics Gradient" ---------------------------------------------- changes ^^^^^^^ - configure readthedocs and travis - update doc with hint on image preprocessing - add fix for printing large images (by splitting them into multiple images) contributors ^^^^^^^^^^^^ - Patrick Kanzler 2016-08-02 - Version 2.1.2 - "Death and Gravity" ------------------------------------------------ changes ^^^^^^^ - fix File-printer: flush after every call of _raw() - fix lists in documentation - fix CODE128: by adding the control character to the barcode-selection-sequence the barcode became unusable contributors ^^^^^^^^^^^^ - Patrick Kanzler 2016-08-02 - Version 2.1.1 - "Contents May Differ" -------------------------------------------------- changes ^^^^^^^ - rename variable interface in USB-class to timeout - add support for hypothesis and move pypy3 to the allowed failures (pypy3 is not supported by hypothesis) contributors ^^^^^^^^^^^^ - Patrick Kanzler - Renato Lorenzi 2016-07-23 - Version 2.1.0 - "But Who's Counting?" -------------------------------------------------- changes ^^^^^^^ - packaging: configured the coverage-analysis codecov.io - GitHub: improved issues-template - documentation: add troubleshooting tip to network-interface - the module, cli and documentation is now aware of the version of python-escpos - the cli does now support basic tabcompletion contributors ^^^^^^^^^^^^ - Patrick Kanzler 2016-06-24 - Version 2.0.0 - "Attitude Adjuster" ------------------------------------------------ This version is based on the original version of python-escpos by Manuel F Martinez. However, many contributions have greatly improved the old codebase. Since this version does not completely match the interface of the version published on PyPi and has many improvements, it will be released as version 2.0.0. changes ^^^^^^^ - refactor complete code in order to be compatible with Python 2 and 3 - modernize packaging - add testing and CI - merge various forks into codebase, fixing multiple issues with barcode-, QR-printing, cashdraw and structure - improve the documentation - extend support of barcode-codes to type B - add function to disable panel-buttons - the text-functions are now intended for unicode, the driver will automatically encode the string based on the selected codepage - the image-functions are now much more flexible - added a CLI - restructured the constants contributors ^^^^^^^^^^^^ - Thomas van den Berg - Michael Billington - Nate Bookham - Davis Goglin - Christoph Heuel - Patrick Kanzler - Qian LinFeng 2016-01-24 - Version 1.0.9 -------------------------- - fix constant definition for PC1252 - move documentation to Sphinx 2015-10-27 - Version 1.0.8 -------------------------- - Merge pull request #59 from zouppen/master - Support for images vertically longer than 256 pixels - Sent by Joel Lehtonen <joel.lehtonen@koodilehto.fi> - Updated README 2015-08-22 - Version 1.0.7 -------------------------- - Issue #57: Fixed transparent images 2015-07-06 - Version 1.0.6 -------------------------- - Merge pull request #53 from ldos/master - Extended params for serial printers - Sent by ldos <cafeteria.ldosalzira@gmail.com> 2015-04-21 - Version 1.0.5 -------------------------- - Merge pull request #45 from Krispy2009/master - Raising the right error when wrong charcode is used - Sent by Kristi <Krispy2009@gmail.com> 2014-05-20 - Version 1.0.4 -------------------------- - Issue #20: Added Density support (Sent by thomas.erbacher@ragapack.de) - Added charcode tables - Fixed Horizontal Tab - Fixed code tabulators 2014-02-23 - Version 1.0.3 -------------------------- - Issue #18: Added quad-area characters (Sent by syncman1x@gmail.com) - Added exception for PIL import 2013-12-30 - Version 1.0.2 -------------------------- - Issue #5: Fixed vertical tab - Issue #9: Fixed identation inconsistence 2013-03-14 - Version 1.0.1 -------------------------- - Issue #8: Fixed set font - Added QR support 2012-11-15 - Version 1.0 ------------------------ - Issue #2: Added ethernet support - Issue #3: Added compatibility with libusb-1.0.1 - Issue #4: Fixed typo in escpos.py

python-escpos/python-escpos

535

Python

constants.rst

text/plain

[metadata] name = python-escpos url = https://github.com/python-escpos/python-escpos description = Python library to manipulate ESC/POS Printers long_description = file: README.rst license = MIT license_file = LICENSE author = Manuel F Martinez and others author_email = dev@pkanzler.de maintainer = Patrick Kanzler maintainer_email = dev@pkanzler.de keywords = ESC/POS, thermoprinter, voucher printer, printing, receipt classifiers = Development Status :: 4 - Beta Environment :: Console Intended Audience :: Developers License :: OSI Approved :: MIT License Operating System :: OS Independent Programming Language :: Python Programming Language :: Python :: 3 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 Topic :: Software Development :: Libraries :: Python Modules Topic :: Office/Business :: Financial :: Point-Of-Sale project_urls = Bug Tracker = https://github.com/python-escpos/python-escpos/issues Documentation = https://python-escpos.readthedocs.io/en/latest/ Release Notes = https://github.com/python-escpos/python-escpos/releases [options] python_requires = >=3.5 zip_safe = false include_package_data = true install_requires = pyusb>=1.0.0 Pillow>=2.0 qrcode>=4.0 pyserial python-barcode>=0.9.1,<1 setuptools six appdirs PyYAML argparse argcomplete future viivakoodi>=0.8 setup_requires = setuptools_scm tests_require = jaconv tox pytest!=3.2.0,!=3.3.0 pytest-cov pytest-mock nose scripttest mock hypothesis>4 flake8 sphinxcontrib-spelling>=5 [nosetests] verbosity=3 with-doctest=1 [flake8] exclude = .git,.tox,.github,.eggs,__pycache__,doc/conf.py,build,dist,capabilities-data,test,src/escpos/constants.py max-line-length = 120 # future-imports = absolute_import, division, print_function, unicode_literals # we are not there yet

python-escpos/python-escpos

535

Python

constants.rst

text/plain

formats: - pdf - epub requirements_file: doc/requirements.txt python: version: 3 setup_py_install: true

python-escpos/python-escpos

535

Python

constants.rst

text/plain

############################################################# python-escpos - Python library to manipulate ESC/POS Printers ############################################################# .. image:: https://travis-ci.org/python-escpos/python-escpos.svg?branch=master :target: https://travis-ci.org/python-escpos/python-escpos :alt: Continous Integration .. image:: https://codecov.io/github/python-escpos/python-escpos/coverage.svg?branch=master :target: https://codecov.io/github/python-escpos/python-escpos?branch=master :alt: Code Coverage .. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest :target: https://python-escpos.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status Description ----------- Python ESC/POS is a library which lets the user have access to all those printers handled by ESC/POS commands, as defined by Epson, from a Python application. The library tries to implement the functions provided by the ESC/POS-commandset and supports sending text, images, barcodes and qr-codes to the printer. Text can be aligned/justified and fonts can be changed by size, type and weight. Also, this module handles some hardware functionalities like cutting paper, control characters, printer reset and similar functions. Since supported commands differ from printer to printer the software tries to automatically apply the right settings for the printer that you set. These settings are handled by `escpos-printer-db <https://github.com/receipt-print-hq/escpos-printer-db>`_ which is also used in `escpos-php <https://github.com/mike42/escpos-php>`_. Dependencies ------------ This library makes use of: * `pyusb <https://github.com/walac/pyusb>`_ for USB-printers * `Pillow <https://github.com/python-pillow/Pillow>`_ for image printing * `qrcode <https://github.com/lincolnloop/python-qrcode>`_ for the generation of QR-codes * `pyserial <https://github.com/pyserial/pyserial>`_ for serial printers * `python-barcode <https://github.com/WhyNotHugo/python-barcode>`_ for the generation of barcodes Documentation and Usage ----------------------- The basic usage is: .. code:: python from escpos.printer import Usb """ Seiko Epson Corp. Receipt Printer (EPSON TM-T88III) """ p = Usb(0x04b8, 0x0202, 0, profile="TM-T88III") p.text("Hello World\n") p.image("logo.gif") 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 ------------ This project is open for any contribution! Please see `CONTRIBUTING.rst <https://python-escpos.readthedocs.io/en/latest/dev/contributing.html>`_ for more information. Disclaimer ---------- None of the vendors cited in this project agree or endorse any of the patterns or implementations. Its names are used only to maintain context.

python-escpos/python-escpos

535

Python

constants.rst

text/plain

[tox] 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 jaconv coverage scripttest mock pytest!=3.2.0,!=3.3.0 pytest-cov pytest-mock hypothesis>4 python-barcode commands = pytest --cov escpos passenv = ESCPOS_CAPABILITIES_PICKLE_DIR ESCPOS_CAPABILITIES_FILE CI TRAVIS TRAVIS_* APPVEYOR APPVEYOR_* CODECOV_* [testenv:docs] basepython = python changedir = doc deps = sphinx>=1.5.1 setuptools_scm python-barcode sphinxcontrib-spelling>=5 commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html [testenv:flake8] basepython = python # TODO add flake8-future # TODO add flake8-docstrings deps = flake8 commands = flake8

python-escpos/python-escpos

535

Python

constants.rst

text/plain

python-escpos ============= This library is available over pypi. So for most of the use-cases it should be sufficient to run ``` pip install python-escpos --user # add --pre if you want to install pre-releases ``` For more information please read the documentation at https://python-escpos.readthedocs.io/en/latest/user/installation.html

python-escpos/python-escpos

535

Python

constants.rst

text/plain

************ Contributing ************ This project is open to any kind of contribution. You can help with improving the documentation, adding fixes to the code, providing test cases in code or as a description or just spreading the word. Please feel free to create an issue or pull request. In order to reduce the amount of work for everyone please try to adhere to good practice. The pull requests and issues will be prefilled with templates. Please fill in your information where applicable. This project uses `semantic versioning <https://semver.org/>`_ and tries to adhere to the proposed rules as well as possible. Author-list ----------- This project keeps a list of authors. This can be auto-generated by calling `./doc/generate-authors.sh`. When contributing the first time, please include a commit with the output of this script in place. Otherwise the integration-check will fail. When you change your username or mail-address, please also update the `.mailmap` and the authors-list. You can find a good documentation on the mapping-feature in the `documentation of git-shortlog <https://git-scm.com/docs/git-shortlog#_mapping_authors>`_. Style-Guide ----------- When writing code please try to stick to these rules. PEP8 ^^^^ The entire codebase adheres to the rules of PEP8. These rules are enforced by running `flake8` in the integration-checks. Please adhere to these rules as your contribution can only be merged if the check succeeds. You can use flake8 or similar tools locally in order to check your code. Apart from that the travis-log and the check by Landscape will provide you with hints. GIT ^^^ 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 easier to review, and improves the chance of your code being merged. Please also make sure that before creating your PR, your branch is rebased on a recent commit or you merged a recent commit into your branch. This way you can ensure that your PR is without merge conflicts. Docstrings ^^^^^^^^^^ This project tries to have a good documentation. Please add a docstring to every method and class. Have a look at existing methods and classes for the style. We use basically standard rst-docstrings for Sphinx. Test ^^^^ Try to write tests whenever possible. Our goal for the future is 100% coverage. We are currently using `nose` but might change in the future. You can copy the structure from other testcases. Please remember to adapt the docstrings. Further reading ^^^^^^^^^^^^^^^ For further best practices and hints on contributing please see the `contribution-guide <https://www.contribution-guide.org/>`_. Should there be any contradictions between this guide and the linked one, please stick to this text. Aside from that feel free to create an issue or write an email if anything is unclear. Thank you for your contribution!

python-escpos/python-escpos

535

Python

constants.rst

text/plain

<!-- Please feel free to delete any sections that aren't relevant. --> <!-- mark with x between the [ ] --> I have: - [ ] searched open and closed issues for duplicates ### Bug description ### Steps to reproduce - add your steps here - as a list - using hyphens ### Device info <!-- Replace examples with your info --> **Printer:** Manufacturer Model XVI <!-- since version 2.0.1 you can type 'python-escpos version' in your shell. Alternatively you could use '__version__' in module escpos. --> **python-escpos version:** 0.0.0 **python version:** 0.0 **operating system:**

python-escpos/python-escpos

535

Python

constants.rst

text/plain

### Contributor checklist <!-- mark with x between the brackets --> - [ ] I have read the CONTRIBUTING.rst - [ ] I have tested my contribution on these devices: * e.g. Epson TM-T88II - [ ] My contribution is ready to be merged as is ---------- ### Description

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# 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

python-escpos/python-escpos

535

Python

constants.rst

text/plain

""" ESC/POS configuration manager. This module contains the implementations of abstract base class :py:class:`Config`. """ import os import appdirs import yaml from . import printer from . import exceptions class Config(object): """ Configuration handler class. This class loads configuration from a default or specificed directory. It can create your defined printer and return it to you. """ _app_name = 'python-escpos' _config_file = 'config.yaml' def __init__(self): """ Initialize configuration. Remember to add anything that needs to be reset between configurations to self._reset_config """ self._has_loaded = False self._printer = None self._printer_name = None self._printer_config = None def _reset_config(self): """ Clear the loaded configuration. If we are loading a changed config, we don't want to have leftover data. """ self._has_loaded = False self._printer = None self._printer_name = None self._printer_config = None def load(self, config_path=None): """ Load and parse the configuration file using pyyaml :param config_path: An optional file path, file handle, or byte string for the configuration file. """ self._reset_config() if not config_path: config_path = os.path.join( appdirs.user_config_dir(self._app_name), self._config_file ) try: # First check if it's file like. If it is, pyyaml can load it. # I'm checking type instead of catching exceptions to keep the # exception handling simple if hasattr(config_path, 'read'): config = yaml.safe_load(config_path) else: # If it isn't, it's a path. We have to open it first, otherwise # pyyaml will try to read it as yaml with open(config_path, 'rb') as config_file: config = yaml.safe_load(config_file) except EnvironmentError: raise exceptions.ConfigNotFoundError('Couldn\'t read config at {config_path}'.format( config_path=str(config_path), )) except yaml.YAMLError: raise exceptions.ConfigSyntaxError('Error parsing YAML') if 'printer' in config: self._printer_config = config['printer'] self._printer_name = self._printer_config.pop('type').title() if not self._printer_name or not hasattr(printer, self._printer_name): raise exceptions.ConfigSyntaxError( 'Printer type "{printer_name}" is invalid'.format( printer_name=self._printer_name, ) ) self._has_loaded = True def printer(self): """ Returns a printer that was defined in the config, or throws an exception. This method loads the default config if one hasn't beeen already loaded. """ if not self._has_loaded: self.load() if not self._printer_name: raise exceptions.ConfigSectionMissingError('printer') if not self._printer: # We could catch init errors and make them a ConfigSyntaxError, # but I'll just let them pass self._printer = getattr(printer, self._printer_name)(**self._printer_config) return self._printer

python-escpos/python-escpos

535

Python

constants.rst

text/plain

""" Image format handling class This module contains the image format handler :py:class:`EscposImage`. :author: `Michael Billington <michael.billington@gmail.com>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 Michael Billington <michael.billington@gmail.com> :license: MIT """ import math from PIL import Image, ImageOps class EscposImage(object): """ Load images in, and output ESC/POS formats. The class is designed to efficiently delegate image processing to PIL, rather than spend CPU cycles looping over pixels. """ def __init__(self, img_source): """ Load in an image :param img_source: PIL.Image, or filename to load one from. """ if isinstance(img_source, Image.Image): img_original = img_source else: img_original = Image.open(img_source) # store image for eventual further processing (splitting) self.img_original = img_original # Convert to white RGB background, paste over white background # to strip alpha. img_original = img_original.convert('RGBA') im = Image.new("RGB", img_original.size, (255, 255, 255)) im.paste(img_original, mask=img_original.split()[3]) # Convert down to greyscale im = im.convert("L") # Invert: Only works on 'L' images im = ImageOps.invert(im) # Pure black and white self._im = im.convert("1") @property def width(self): """ Width of image in pixels """ width_pixels, _ = self._im.size return width_pixels @property def width_bytes(self): """ Width of image if you use 8 pixels per byte and 0-pad at the end. """ return (self.width + 7) >> 3 @property def height(self): """ Height of image in pixels """ _, height_pixels = self._im.size return height_pixels def to_column_format(self, high_density_vertical=True): """ Extract slices of an image as equal-sized blobs of column-format data. :param high_density_vertical: Printed line height in dots """ im = self._im.transpose(Image.ROTATE_270).transpose(Image.FLIP_LEFT_RIGHT) line_height = 24 if high_density_vertical else 8 width_pixels, height_pixels = im.size top = 0 left = 0 while left < width_pixels: box = (left, top, left + line_height, top + height_pixels) im_slice = im.transform((line_height, height_pixels), Image.EXTENT, box) im_bytes = im_slice.tobytes() yield(im_bytes) left += line_height def to_raster_format(self): """ Convert image to raster-format binary """ return self._im.tobytes() def split(self, fragment_height): """ Split an image into multiple fragments after fragment_height pixels :param fragment_height: height of fragment :return: list of PIL objects """ passes = int(math.ceil(self.height/fragment_height)) fragments = [] for n in range(0, passes): left = 0 right = self.width upper = n * fragment_height lower = min((n + 1) * fragment_height, self.height) box = (left, upper, right, lower) fragments.append(self.img_original.crop(box)) return fragments def center(self, max_width): """In-place image centering :param: Maximum width in order to deduce x offset for centering :return: None """ old_width, height = self._im.size new_size = (max_width, height) new_im = Image.new("1", new_size) paste_x = int((max_width - old_width) / 2) new_im.paste(self._im, (paste_x, 0)) self._im = new_im

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# -*- coding: utf-8 -*- """Helpers to encode Japanese characters. I doubt that this currently works correctly. """ try: import jaconv except ImportError: jaconv = None def encode_katakana(text): """I don't think this quite works yet.""" encoded = [] for char in text: if jaconv: # try to convert japanese text to half-katakanas char = jaconv.z2h(jaconv.hira2kata(char)) # TODO: "the conversion may result in multiple characters" # If that really can happen (I am not really shure), than the string would have to be split and every single # character has to passed through the following lines. if char in TXT_ENC_KATAKANA_MAP: encoded.append(TXT_ENC_KATAKANA_MAP[char]) else: # TODO doesn't this discard all that is not in the map? Can we be sure that the input does contain only # encodable characters? We could at least throw an exception if encoding is not possible. pass return b"".join(encoded) TXT_ENC_KATAKANA_MAP = { # Maps UTF-8 Katakana symbols to KATAKANA Page Codes # TODO: has this really to be hardcoded? # Half-Width Katakanas '｡': b'\xa1', '｢': b'\xa2', '｣': b'\xa3', '､': b'\xa4', '･': b'\xa5', 'ｦ': b'\xa6', 'ｧ': b'\xa7', 'ｨ': b'\xa8', 'ｩ': b'\xa9', 'ｪ': b'\xaa', 'ｫ': b'\xab', 'ｬ': b'\xac', 'ｭ': b'\xad', 'ｮ': b'\xae', 'ｯ': b'\xaf', 'ｰ': b'\xb0', 'ｱ': b'\xb1', 'ｲ': b'\xb2', 'ｳ': b'\xb3', 'ｴ': b'\xb4', 'ｵ': b'\xb5', 'ｶ': b'\xb6', 'ｷ': b'\xb7', 'ｸ': b'\xb8', 'ｹ': b'\xb9', 'ｺ': b'\xba', 'ｻ': b'\xbb', 'ｼ': b'\xbc', 'ｽ': b'\xbd', 'ｾ': b'\xbe', 'ｿ': b'\xbf', 'ﾀ': b'\xc0', 'ﾁ': b'\xc1', 'ﾂ': b'\xc2', 'ﾃ': b'\xc3', 'ﾄ': b'\xc4', 'ﾅ': b'\xc5', 'ﾆ': b'\xc6', 'ﾇ': b'\xc7', 'ﾈ': b'\xc8', 'ﾉ': b'\xc9', 'ﾊ': b'\xca', 'ﾋ': b'\xcb', 'ﾌ': b'\xcc', 'ﾍ': b'\xcd', 'ﾎ': b'\xce', 'ﾏ': b'\xcf', 'ﾐ': b'\xd0', 'ﾑ': b'\xd1', 'ﾒ': b'\xd2', 'ﾓ': b'\xd3', 'ﾔ': b'\xd4', 'ﾕ': b'\xd5', 'ﾖ': b'\xd6', 'ﾗ': b'\xd7', 'ﾘ': b'\xd8', 'ﾙ': b'\xd9', 'ﾚ': b'\xda', 'ﾛ': b'\xdb', 'ﾜ': b'\xdc', 'ﾝ': b'\xdd', 'ﾞ': b'\xde', 'ﾟ': b'\xdf', }

python-escpos/python-escpos

535

Python

constants.rst

text/plain

from .capabilities import CAPABILITIES class CodePageManager: """Holds information about all the code pages (as defined in escpos-printer-db). """ def __init__(self, data): self.data = data def get_all(self): return self.data.values() @staticmethod def get_encoding_name(encoding): # TODO resolve the encoding alias return encoding.upper() def get_encoding(self, encoding): return self.data[encoding] CodePages = CodePageManager(CAPABILITIES['encodings'])

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- """ This module contains the implementations of abstract base class :py:class:`Escpos`. :author: `Manuel F Martinez <manpaz@bashlinux.com>`_ and others :organization: Bashlinux and `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2012-2017 Bashlinux and python-escpos :license: MIT """ import serial import socket import usb.core import usb.util from .escpos import Escpos from .exceptions import USBNotFoundError class Usb(Escpos): """ USB printer This class describes a printer that natively speaks USB. inheritance: .. inheritance-diagram:: escpos.printer.Usb :parts: 1 """ 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.timeout = timeout self.in_ep = in_ep self.out_ep = out_ep 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.") self.idVendor = self.device.idVendor self.idProduct = self.device.idProduct # 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 try: 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() self.device.reset() except usb.core.USBError as e: print("Could not set configuration: {0}".format(str(e))) def _raw(self, msg): """ Print any command sent in raw format :param msg: arbitrary code to be printed :type msg: bytes """ self.device.write(self.out_ep, msg, self.timeout) def _read(self): """ Reads a data buffer and returns it to the caller. """ return self.device.read(self.in_ep, 16) def close(self): """ Release USB interface """ if self.device: usb.util.dispose_resources(self.device) self.device = None class Serial(Escpos): """ Serial printer This class describes a printer that is connected by serial interface. inheritance: .. inheritance-diagram:: escpos.printer.Serial :parts: 1 """ def __init__(self, devfile="/dev/ttyS0", baudrate=9600, bytesize=8, timeout=1, parity=serial.PARITY_NONE, stopbits=serial.STOPBITS_ONE, xonxoff=False, dsrdtr=True, *args, **kwargs): """ :param devfile: Device file under dev filesystem :param baudrate: Baud rate for serial transmission :param bytesize: Serial buffer size :param timeout: Read/Write timeout :param parity: Parity checking :param stopbits: Number of stop bits :param xonxoff: Software flow control :param dsrdtr: Hardware flow control (False to enable RTS/CTS) """ Escpos.__init__(self, *args, **kwargs) self.devfile = devfile self.baudrate = baudrate self.bytesize = bytesize self.timeout = timeout self.parity = parity self.stopbits = stopbits self.xonxoff = xonxoff self.dsrdtr = dsrdtr self.open() def open(self): """ Setup serial port and set is as escpos device """ if self.device is not None and self.device.is_open: self.close() self.device = serial.Serial(port=self.devfile, baudrate=self.baudrate, bytesize=self.bytesize, parity=self.parity, stopbits=self.stopbits, timeout=self.timeout, xonxoff=self.xonxoff, dsrdtr=self.dsrdtr) if self.device is not None: print("Serial printer enabled") else: print("Unable to open serial printer on: {0}".format(str(self.devfile))) def _raw(self, msg): """ Print any command sent in raw format :param msg: arbitrary code to be printed :type msg: bytes """ self.device.write(msg) def _read(self): """ Reads a data buffer and returns it to the caller. """ return self.device.read(16) def close(self): """ Close Serial interface """ if self.device is not None and self.device.is_open: self.device.flush() self.device.close() class Network(Escpos): """ Network printer This class is used to attach to a networked printer. You can also use this in order to attach to a printer that is forwarded with ``socat``. If you have a local printer on parallel port ``/dev/usb/lp0`` then you could start ``socat`` with: .. code-block:: none socat -u TCP4-LISTEN:4242,reuseaddr,fork OPEN:/dev/usb/lp0 Then you should be able to attach to port ``4242`` with this class. Otherwise the normal usecase would be to have a printer with ethernet interface. This type of printer should work the same with this class. For the address of the printer check its manuals. inheritance: .. inheritance-diagram:: escpos.printer.Network :parts: 1 """ def __init__(self, host, port=9100, timeout=60, *args, **kwargs): """ :param host: Printer's hostname or IP address :param port: Port to write to :param timeout: timeout in seconds for the socket-library """ Escpos.__init__(self, *args, **kwargs) self.host = host self.port = port self.timeout = timeout self.open() def open(self): """ Open TCP socket with ``socket``-library and set it as escpos device """ self.device = socket.socket(socket.AF_INET, socket.SOCK_STREAM) self.device.settimeout(self.timeout) self.device.connect((self.host, self.port)) if self.device is None: print("Could not open socket for {0}".format(self.host)) def _raw(self, msg): """ Print any command sent in raw format :param msg: arbitrary code to be printed :type msg: bytes """ 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: self.device.shutdown(socket.SHUT_RDWR) self.device.close() class File(Escpos): """ Generic file printer This class is used for parallel port printer or other printers that are directly attached to the filesystem. Note that you should stay away from using USB-to-Parallel-Adapter since they are unreliable and produce arbitrary errors. inheritance: .. inheritance-diagram:: escpos.printer.File :parts: 1 """ def __init__(self, devfile="/dev/usb/lp0", auto_flush=True, *args, **kwargs): """ :param devfile: Device file under dev filesystem :param auto_flush: automatically call flush after every call of _raw() """ Escpos.__init__(self, *args, **kwargs) self.devfile = devfile self.auto_flush = auto_flush self.open() def open(self): """ Open system file """ self.device = open(self.devfile, "wb") if self.device is None: print("Could not open the specified file {0}".format(self.devfile)) def flush(self): """ Flush printing content """ self.device.flush() def _raw(self, msg): """ Print any command sent in raw format :param msg: arbitrary code to be printed :type msg: bytes """ self.device.write(msg) if self.auto_flush: self.flush() def close(self): """ Close system file """ if self.device is not None: self.device.flush() self.device.close() class Dummy(Escpos): """ Dummy printer This class is used for saving commands to a variable, for use in situations where there is no need to send commands to an actual printer. This includes generating print jobs for later use, or testing output. inheritance: .. inheritance-diagram:: escpos.printer.Dummy :parts: 1 """ def __init__(self, *args, **kwargs): """ """ Escpos.__init__(self, *args, **kwargs) self._output_list = [] def _raw(self, msg): """ Print any command sent in raw format :param msg: arbitrary code to be printed :type msg: bytes """ self._output_list.append(msg) @property def output(self): """ 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)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

import re from os import environ, path import pkg_resources import pickle import logging 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', gettempdir()) pickle_path = path.join(pickle_dir, '{v}.capabilities.pickle'.format(v=platform.python_version())) # get a temporary file from pkg_resources if no file is specified in env capabilities_path = environ.get('ESCPOS_CAPABILITIES_FILE', pkg_resources.resource_filename(__name__, 'capabilities.json')) # Load external printer database t0 = time.time() logger.debug('Using capabilities from file: %s', capabilities_path) if path.exists(pickle_path): if path.getmtime(capabilities_path) > path.getmtime(pickle_path): logger.debug('Found a more recent capabilities file') full_load = True else: full_load = False logger.debug('Loading capabilities from pickle in %s', pickle_path) with open(pickle_path, 'rb') as cf: CAPABILITIES = pickle.load(cf) else: logger.debug('Capabilities pickle file not found: %s', pickle_path) full_load = True if full_load: logger.debug('Loading and pickling capabilities') with open(capabilities_path) as cp, open(pickle_path, 'wb') as pp: CAPABILITIES = yaml.safe_load(cp) pickle.dump(CAPABILITIES, pp, protocol=2) logger.debug('Finished loading capabilities took %.2fs', time.time() - t0) PROFILES = CAPABILITIES['profiles'] class NotSupported(Exception): """Raised if a requested feature is not supported by the printer profile. """ pass BARCODE_B = 'barcodeB' class BaseProfile(object): """This represents a printer profile. A printer profile knows about the number of columns, supported features, colors and more. """ profile_data = {} def __getattr__(self, name): return self.profile_data[name] def get_font(self, font): """Return the escpos index for `font`. Makes sure that the requested `font` is valid. """ font = {'a': 0, 'b': 1}.get(font, font) if not six.text_type(font) in self.fonts: raise NotSupported( '"{}" is not a valid font in the current profile'.format(font)) return font def get_columns(self, font): """ Return the number of columns for the given font. """ font = self.get_font(font) return self.fonts[six.text_type(font)]['columns'] def supports(self, feature): """Return true/false for the given feature. """ return self.features.get(feature) def get_code_pages(self): """Return the support code pages as a ``{name: index}`` dict. """ return {v: k for k, v in self.codePages.items()} def get_profile(name=None, **kwargs): """Get the profile by name; if no name is given, return the default profile. """ if isinstance(name, Profile): return name clazz = get_profile_class(name or 'default') return clazz(**kwargs) CLASS_CACHE = {} def get_profile_class(name): """For the given profile name, load the data from the external database, then generate dynamically a class. """ if name not in CLASS_CACHE: profile_data = PROFILES[name] profile_name = clean(name) class_name = '{}{}Profile'.format( profile_name[0].upper(), profile_name[1:]) new_class = type(class_name, (BaseProfile,), {'profile_data': profile_data}) CLASS_CACHE[name] = new_class return CLASS_CACHE[name] def clean(s): # Remove invalid characters s = re.sub('[^0-9a-zA-Z_]', '', s) # Remove leading characters until we find a letter or underscore s = re.sub('^[^a-zA-Z_]+', '', s) return str(s) class Profile(get_profile_class('default')): """ For users, who want to provide their profile """ def __init__(self, columns=None, features=None): super(Profile, self).__init__() self.columns = columns self.features = features or {} def get_columns(self, font): if self.columns is not None: return self.columns return super(Profile, self).get_columns(font)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- """ Main class This module contains the abstract base class :py:class:`Escpos`. :author: `Manuel F Martinez <manpaz@bashlinux.com>`_ and others :organization: Bashlinux and `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2012-2017 Bashlinux and python-escpos :license: MIT """ import qrcode import textwrap import six import time 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 from .constants import BARCODE_TXT_OFF, BARCODE_TXT_BTH, BARCODE_TXT_ABV, BARCODE_TXT_BLW from .constants import TXT_SIZE, TXT_NORMAL from .constants import SET_FONT from .constants import LINESPACING_FUNCS, LINESPACING_RESET from .constants import LINE_DISPLAY_OPEN, LINE_DISPLAY_CLEAR, LINE_DISPLAY_CLOSE from .constants import CD_KICK_DEC_SEQUENCE, CD_KICK_5, CD_KICK_2, PAPER_FULL_CUT, PAPER_PART_CUT from .constants import HW_RESET, HW_SELECT, HW_INIT from .constants import CTL_VT, CTL_CR, CTL_FF, CTL_LF, CTL_SET_HT, PANEL_BUTTON_OFF, PANEL_BUTTON_ON from .constants import TXT_STYLE from .constants import RT_STATUS_ONLINE, RT_MASK_ONLINE from .constants import RT_STATUS_PAPER, RT_MASK_PAPER, RT_MASK_LOWPAPER, RT_MASK_NOPAPER from .exceptions import BarcodeTypeError, BarcodeSizeError, TabPosError from .exceptions import CashDrawerError, SetVariableError, BarcodeCodeError from .exceptions import ImageWidthError from .magicencode import MagicEncode from abc import ABCMeta, abstractmethod # abstract base class support from escpos.image import EscposImage from escpos.capabilities import get_profile, BARCODE_B @six.add_metaclass(ABCMeta) class Escpos(object): """ ESC/POS Printer object This class is the abstract base class for an esc/pos-printer. The printer implementations are children of this class. """ device = None def __init__(self, profile=None, magic_encode_args=None, **kwargs): """ Initialize ESCPOS Printer :param profile: Printer profile""" self.profile = get_profile(profile) self.magic = MagicEncode(self, **(magic_encode_args or {})) def __del__(self): """ call self.close upon deletion """ self.close() @abstractmethod def _raw(self, msg): """ Sends raw data to the printer This function has to be individually implemented by the implementations. :param msg: message string to be sent to the printer :type msg: bytes """ pass def _read(self): """ Returns a NotImplementedError if the instance of the class doesn't override this method. :raises NotImplementedError """ raise NotImplementedError() def image(self, img_source, high_density_vertical=True, high_density_horizontal=True, impl="bitImageRaster", fragment_height=960, center=False): """ Print an image You can select whether the printer should print in high density or not. The default value is high density. When printing in low density, the image will be stretched. Esc/Pos supplies several commands for printing. This function supports three of them. Please try to vary the implementations if you have any problems. For example the printer `IT80-002` will have trouble aligning images that are not printed in Column-mode. The available printing implementations are: * `bitImageRaster`: prints with the `GS v 0`-command * `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 :param impl: choose image printing mode between `bitImageRaster`, `graphics` or `bitImageColumn` :param fragment_height: Images larger than this will be split into multiple fragments *default:* 960 :param center: Center image horizontally *default:* False """ 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: raise ImageWidthError('{} > {}'.format(im.width, max_width)) if center: im.center(max_width) except KeyError: # If the printer's pixel width is not known, print anyways... pass except ValueError: # If the max_width cannot be converted to an int, print anyways... pass if im.height > fragment_height: fragments = im.split(fragment_height) for fragment in fragments: self.image(fragment, high_density_vertical=high_density_vertical, high_density_horizontal=high_density_horizontal, impl=impl, fragment_height=fragment_height) return if impl == "bitImageRaster": # GS v 0, raster format bit image density_byte = (0 if high_density_horizontal else 1) + (0 if high_density_vertical else 2) header = GS + b"v0" + six.int2byte(density_byte) + self._int_low_high(im.width_bytes, 2) +\ self._int_low_high(im.height, 2) self._raw(header + im.to_raster_format()) if impl == "graphics": # GS ( L raster format graphics img_header = self._int_low_high(im.width, 2) + self._int_low_high(im.height, 2) tone = b'0' colors = b'1' ym = six.int2byte(1 if high_density_vertical else 2) xm = six.int2byte(1 if high_density_horizontal else 2) header = tone + xm + ym + colors + img_header raster_data = im.to_raster_format() self._image_send_graphics_data(b'0', b'p', header + raster_data) self._image_send_graphics_data(b'0', b'2', b'') if impl == "bitImageColumn": # ESC *, column format bit image density_byte = (1 if high_density_horizontal else 0) + (32 if high_density_vertical else 0) header = ESC + b"*" + six.int2byte(density_byte) + self._int_low_high(im.width, 2) outp = [ESC + b"3" + six.int2byte(16)] # Adjust line-feed size for blob in im.to_column_format(high_density_vertical): outp.append(header + blob + b"\n") outp.append(ESC + b"2") # Reset line-feed size self._raw(b''.join(outp)) def _image_send_graphics_data(self, m, fn, data): """ Wrapper for GS ( L, to calculate and send correct data length. :param m: Modifier//variant for function. Usually '0' :param fn: Function number to use, as byte :param data: Data to send """ header = self._int_low_high(len(data) + 2, 2) 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, impl="bitImageRaster"): """ Print QR Code for the provided string :param content: The content of the code. Numeric data will be more efficiently compacted. :param ec: Error-correction level to use. One of QR_ECLEVEL_L (default), QR_ECLEVEL_M, QR_ECLEVEL_Q or QR_ECLEVEL_H. Higher error correction results in a less compact code. :param size: Pixel size to use. Must be 1-16 (default 3) :param model: QR code model to use. Must be one of QR_MODEL_1, QR_MODEL_2 (default) or QR_MICRO (not supported by all printers). :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]: raise ValueError("Invalid error correction level") if not 1 <= size <= 16: raise ValueError("Invalid block size (must be 1-16)") if model not in [QR_MODEL_1, QR_MODEL_2, QR_MICRO]: raise ValueError("Invalid QR model (must be one of QR_MODEL_1, QR_MODEL_2, QR_MICRO)") if content == "": # Handle edge case by printing nothing. return if not native: # Map ESC/POS error correction levels to python 'qrcode' library constant and render to an image if model != QR_MODEL_2: raise ValueError("Invalid QR model for qrlib rendering (must be QR_MODEL_2)") python_qr_ec = { QR_ECLEVEL_H: qrcode.constants.ERROR_CORRECT_H, QR_ECLEVEL_L: qrcode.constants.ERROR_CORRECT_L, QR_ECLEVEL_M: qrcode.constants.ERROR_CORRECT_M, QR_ECLEVEL_Q: qrcode.constants.ERROR_CORRECT_Q } qr_code = qrcode.QRCode(version=None, box_size=size, border=1, error_correction=python_qr_ec[ec]) qr_code.add_data(content) qr_code.make(fit=True) qr_img = qr_code.make_image() im = qr_img._img.convert("RGB") # Convert the RGB image in printable image self.text('\n') self.image(im, center=center, impl=impl) self.text('\n') self.text('\n') return if center: raise NotImplementedError("Centering not implemented for native QR rendering") # Native 2D code printing cn = b'1' # Code type for QR code # Select model: 1, 2 or micro. self._send_2d_code_data(six.int2byte(65), cn, six.int2byte(48 + model) + six.int2byte(0)) # Set dot size. self._send_2d_code_data(six.int2byte(67), cn, six.int2byte(size)) # Set error correction level: L, M, Q, or H self._send_2d_code_data(six.int2byte(69), cn, six.int2byte(48 + ec)) # Send content & print self._send_2d_code_data(six.int2byte(80), cn, content.encode('utf-8'), b'0') self._send_2d_code_data(six.int2byte(81), cn, b'', b'0') def _send_2d_code_data(self, fn, cn, data, m=b''): """ Wrapper for GS ( k, to calculate and send correct data length. :param fn: Function to use. :param cn: Output code type. Affects available data. :param data: Data to send. :param m: Modifier/variant for function. Often '0' where used. """ if len(m) > 1 or len(cn) != 1 or len(fn) != 1: raise ValueError("cn and fn must be one byte each.") header = self._int_low_high(len(data) + len(m) + 2, 2) self._raw(GS + b'(k' + header + cn + fn + m + data) @staticmethod def _int_low_high(inp_number, out_bytes): """ Generate multiple bytes for a number: In lower and higher parts, or more parts as needed. :param inp_number: Input number :param out_bytes: The number of bytes to output (1 - 4). """ max_input = (256 << (out_bytes * 8) - 1) if not 1 <= out_bytes <= 4: raise ValueError("Can only output 1-4 bytes") if not 0 <= inp_number <= max_input: raise ValueError("Number too large. Can only output up to {0} in {1} bytes".format(max_input, out_bytes)) outp = b'' for _ in range(0, out_bytes): outp += six.int2byte(inp_number % 256) inp_number //= 256 return outp def charcode(self, code="AUTO"): """ Set Character Code Table Sets the control sequence from ``CHARCODE`` in :py:mod:`escpos.constants` as active. It will be sent with the next text sequence. If you set the variable code to ``AUTO`` it will try to automatically guess the right codepage. (This is the standard behaviour.) :param code: Name of CharCode :raises: :py:exc:`~escpos.exceptions.CharCodeError` """ if code.upper() == "AUTO": self.magic.force_encoding(False) else: self.magic.force_encoding(code) @staticmethod def check_barcode(bc, code): """ This method checks if the barcode is in the proper format. The validation concerns the barcode length and the set of characters, but won't compute/validate any checksum. The full set of requirement for each barcode type is available in the ESC/POS documentation. As an example, using EAN13, the barcode `12345678901` will be correct, because it can be rendered by the printer. But it does not suit the EAN13 standard, because the checksum digit is missing. Adding a wrong checksum in the end will also be considered correct, but adding a letter won't (EAN13 is numeric only). .. todo:: Add a method to compute the checksum for the different standards .. todo:: For fixed-length standards with mandatory checksum (EAN, UPC), compute and add the checksum automatically if missing. :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: return False bounds, regex = BARCODE_FORMATS[bc] return any(bound[0] <= len(code) <= bound[1] for bound in bounds) and re_match(regex, code) def barcode(self, code, bc, height=64, width=3, pos="BELOW", font="A", align_ct=True, function_type=None, check=True): """ Print Barcode This method allows to print barcodes. The rendering of the barcode is done by the printer and therefore has to be supported by the unit. By default, this method will check whether your barcode text is correct, that is the characters and lengths are supported by ESCPOS. Call the method with `check=False` to disable the check, but note that uncorrect barcodes may lead to unexpected printer behaviour. There are two forms of the barcode function. Type A is default but has fewer barcodes, while type B has some more to choose from. Use the parameters `height` and `width` for adjusting of the barcode size. Please take notice that the barcode will not be printed if it is outside of the printable area. (Which should be impossible with this method, so this information is probably more useful for debugging purposes.) .. todo:: On TM-T88II width from 1 to 6 is accepted. Try to acquire command reference and correct the code. .. todo:: Supplying pos does not have an effect for every barcode type. Check and document for which types this is true. If you do not want to center the barcode you can call the method with `align_ct=False`, which will disable automatic centering. Please note that when you use center alignment, then the alignment of text will be changed automatically to centered. You have to manually restore the alignment if necessary. .. todo:: If further barcode-types are needed they could be rendered transparently as an image. (This could also be of help if the printer does not support types that others do.) :param code: alphanumeric data to be printed as bar code :param bc: barcode format, possible values are for type A are: * UPC-A * UPC-E * EAN13 * EAN8 * CODE39 * ITF * NW7 Possible values for type B: * All types from function type A * CODE93 * CODE128 * GS1-128 * GS1 DataBar Omnidirectional * GS1 DataBar Truncated * GS1 DataBar Limited * GS1 DataBar Expanded If none is specified, the method raises :py:exc:`~escpos.exceptions.BarcodeTypeError`. :param height: barcode height, has to be between 1 and 255 *default*: 64 :type height: int :param width: barcode width, has to be between 2 and 6 *default*: 3 :type width: int :param pos: where to place the text relative to the barcode, *default*: BELOW * ABOVE * BELOW * BOTH * OFF :param font: select font (see ESC/POS-documentation, the device often has two fonts), *default*: A * A * B :param align_ct: If this parameter is True the barcode will be centered. Otherwise no alignment command will be issued. :type align_ct: bool :param function_type: Choose between ESCPOS function type A or B, depending on printer support and desired barcode. If not given, the printer will attempt to automatically choose the correct function based on the current profile. *default*: A :param check: If this parameter is True, the barcode format will be checked to ensure it meets the bc requirements as definged in the ESC/POS documentation. See :py:meth:`.check_barcode()` for more information. *default*: True. :raises: :py:exc:`~escpos.exceptions.BarcodeSizeError`, :py:exc:`~escpos.exceptions.BarcodeTypeError`, :py:exc:`~escpos.exceptions.BarcodeCodeError` """ if function_type is None: # Choose the function type automatically. if bc in BARCODE_TYPES['A']: function_type = 'A' else: if bc in BARCODE_TYPES['B']: if not self.profile.supports(BARCODE_B): raise BarcodeTypeError(( "Barcode type '{bc} not supported for " "the current printer profile").format(bc=bc)) function_type = 'B' else: raise BarcodeTypeError(( "Barcode type '{bc} is not valid").format(bc=bc)) bc_types = BARCODE_TYPES[function_type.upper()] if bc.upper() not in bc_types.keys(): raise BarcodeTypeError(( "Barcode '{bc}' not valid for barcode function type " "{function_type}").format( bc=bc, function_type=function_type, )) if check and not self.check_barcode(bc, code): raise BarcodeCodeError(( "Barcode '{code}' not in a valid format for type '{bc}'").format( code=code, bc=bc, )) # Align Bar Code() if align_ct: self._raw(TXT_STYLE['align']['center']) # Height if 1 <= height <= 255: self._raw(BARCODE_HEIGHT + six.int2byte(height)) else: raise BarcodeSizeError("height = {height}".format(height=height)) # Width if 2 <= width <= 6: self._raw(BARCODE_WIDTH + six.int2byte(width)) else: raise BarcodeSizeError("width = {width}".format(width=width)) # Font if font.upper() == "B": self._raw(BARCODE_FONT_B) else: # DEFAULT FONT: A self._raw(BARCODE_FONT_A) # Position if pos.upper() == "OFF": self._raw(BARCODE_TXT_OFF) elif pos.upper() == "BOTH": self._raw(BARCODE_TXT_BTH) elif pos.upper() == "ABOVE": self._raw(BARCODE_TXT_ABV) else: # DEFAULT POSITION: BELOW self._raw(BARCODE_TXT_BLW) self._raw(bc_types[bc.upper()]) if function_type.upper() == "B": self._raw(six.int2byte(len(code))) # Print Code if code: self._raw(code.encode()) else: raise BarcodeCodeError() if function_type.upper() == "A": self._raw(NUL) def soft_barcode(self, barcode_type, data, impl='bitImageColumn', module_height=5, module_width=0.2, text_distance=1, center=True): image_writer = ImageWriter() # Check if barcode type exists if barcode_type not in barcode.PROVIDED_BARCODES: raise BarcodeTypeError( 'Barcode type {} not supported by software barcode renderer' .format(barcode_type)) # Render the barcode to a fake file barcode_class = barcode.get_barcode_class(barcode_type) my_code = barcode_class(data, writer=image_writer) 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 self.image(image, impl=impl, center=center) def text(self, txt): """ Print alpha-numeric text The text has to be encoded in the currently selected codepage. The input text has to be encoded in unicode. :param txt: text to be printed :raises: :py:exc:`~escpos.exceptions.TextError` """ txt = six.text_type(txt) self.magic.write(txt) def textln(self, txt=''): """Print alpha-numeric text with a newline The text has to be encoded in the currently selected codepage. The input text has to be encoded in unicode. :param txt: text to be printed with a newline :raises: :py:exc:`~escpos.exceptions.TextError` """ self.text('{}\n'.format(txt)) def ln(self, count=1): """Print a newline or more :param count: number of newlines to print :raises: :py:exc:`ValueError` if count < 0 """ if count < 0: raise ValueError('Count cannot be lesser than 0') if count > 0: self.text('\n' * count) def block_text(self, txt, font=None, columns=None): """ Text is printed wrapped to specified columns Text has to be encoded in unicode. :param txt: text to be printed :param font: font to be used, can be :code:`a` or :code:`b` :param columns: amount of columns :return: None """ col_count = self.profile.get_columns(font) if columns is None else columns self.text(textwrap.fill(txt, col_count)) def set(self, align='left', font='a', bold=False, underline=0, width=1, height=1, density=9, invert=False, smooth=False, flip=False, double_width=False, double_height=False, custom_size=False): """ Set text properties by sending them to the printer :param align: horizontal position for text, possible values are: * 'center' * 'left' * 'right' *default*: 'left' :param font: font given as an index, a name, or one of the special values 'a' or 'b', referring to fonts 0 and 1. :param bold: text in bold, *default*: False :param underline: underline mode for text, decimal range 0-2, *default*: 0 :param double_height: doubles the height of the text :param double_width: doubles the width of the text :param custom_size: uses custom size specified by width and height parameters. Cannot be used with double_width or double_height. :param width: text width multiplier when custom_size is used, decimal range 1-8, *default*: 1 :param height: text height multiplier when custom_size is used, decimal range 1-8, *default*: 1 :param density: print density, value from 0-8, if something else is supplied the density remains unchanged :param invert: True enables white on black printing, *default*: False :param smooth: True enables text smoothing. Effective on 4x4 size text and larger, *default*: False :param flip: True enables upside-down printing, *default*: False :type font: str :type invert: bool :type bold: bool :type underline: bool :type smooth: bool :type flip: bool :type custom_size: bool :type double_width: bool :type double_height: bool :type align: str :type width: int :type height: int :type density: int """ if custom_size: if 1 <= width <= 8 and 1 <= height <= 8 and isinstance(width, int) and\ isinstance(height, int): size_byte = TXT_STYLE['width'][width] + TXT_STYLE['height'][height] self._raw(TXT_SIZE + six.int2byte(size_byte)) else: raise SetVariableError() else: self._raw(TXT_NORMAL) if double_width and double_height: self._raw(TXT_STYLE['size']['2x']) elif double_width: self._raw(TXT_STYLE['size']['2w']) elif double_height: self._raw(TXT_STYLE['size']['2h']) else: self._raw(TXT_STYLE['size']['normal']) self._raw(TXT_STYLE['flip'][flip]) self._raw(TXT_STYLE['smooth'][smooth]) self._raw(TXT_STYLE['bold'][bold]) self._raw(TXT_STYLE['underline'][underline]) self._raw(SET_FONT(six.int2byte(self.profile.get_font(font)))) self._raw(TXT_STYLE['align'][align]) if density != 9: self._raw(TXT_STYLE['density'][density]) self._raw(TXT_STYLE['invert'][invert]) def line_spacing(self, spacing=None, divisor=180): """ Set line character spacing. If no spacing is given, we reset it to the default. There are different commands for setting the line spacing, using a different denominator: '+'' line_spacing/360 of an inch, 0 <= line_spacing <= 255 '3' line_spacing/180 of an inch, 0 <= line_spacing <= 255 'A' line_spacing/60 of an inch, 0 <= line_spacing <= 85 Some printers may not support all of them. The most commonly available command (using a divisor of 180) is chosen. """ if spacing is None: self._raw(LINESPACING_RESET) return if divisor not in LINESPACING_FUNCS: raise ValueError("divisor must be either 360, 180 or 60") if (divisor in [360, 180] and (not(0 <= spacing <= 255))): raise ValueError("spacing must be a int between 0 and 255 when divisor is 360 or 180") if divisor == 60 and (not(0 <= spacing <= 85)): raise ValueError("spacing must be a int between 0 and 85 when divisor is 60") self._raw(LINESPACING_FUNCS[divisor] + six.int2byte(spacing)) def cut(self, mode='FULL', feed=True): """ Cut paper. Without any arguments the paper will be cut completely. With 'mode=PART' a partial cut will be attempted. Note however, that not all models can do a partial cut. See the documentation of your printer for details. :param mode: set to 'PART' for a partial cut. default: 'FULL' :param feed: print and feed before cutting. default: true :raises ValueError: if mode not in ('FULL', 'PART') """ if not feed: self._raw(GS + b'V' + six.int2byte(66) + b'\x00') return self.print_and_feed(6) mode = mode.upper() if mode not in ('FULL', 'PART'): raise ValueError("Mode must be one of ('FULL', 'PART')") if mode == "PART": if self.profile.supports('paperPartCut'): self._raw(PAPER_PART_CUT) elif self.profile.supports('paperFullCut'): self._raw(PAPER_FULL_CUT) elif mode == "FULL": if self.profile.supports('paperFullCut'): self._raw(PAPER_FULL_CUT) elif self.profile.supports('paperPartCut'): self._raw(PAPER_PART_CUT) def cashdraw(self, pin): """ Send pulse to kick the cash drawer Kick cash drawer on pin 2 or pin 5 according to default parameter. For non default parameter send a decimal sequence i.e. [27,112,48] or [27,112,0,25,255] :param pin: pin number, 2 or 5 or list of decimals :raises: :py:exc:`~escpos.exceptions.CashDrawerError` """ if pin == 2: self._raw(CD_KICK_2) elif pin == 5: self._raw(CD_KICK_5) else: try: self._raw(CD_KICK_DEC_SEQUENCE(*pin)) except TypeError as err: raise CashDrawerError(err) def linedisplay_select(self, select_display=False): """ Selects the line display or the printer This method is used for line displays that are daisy-chained between your computer and printer. If you set `select_display` to true, only the display is selected and if you set it to false, only the printer is selected. :param select_display: whether the display should be selected or the printer :type select_display: bool """ if select_display: self._raw(LINE_DISPLAY_OPEN) else: self._raw(LINE_DISPLAY_CLOSE) def linedisplay_clear(self): """ Clears the line display and resets the cursor This method is used for line displays that are daisy-chained between your computer and printer. """ self._raw(LINE_DISPLAY_CLEAR) def linedisplay(self, text): """ Display text on a line display connected to your printer 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) self.linedisplay_clear() self.text(text) self.linedisplay_select(select_display=False) def hw(self, hw): """ Hardware operations :param hw: hardware action, may be: * INIT * SELECT * RESET """ if hw.upper() == "INIT": self._raw(HW_INIT) elif hw.upper() == "SELECT": self._raw(HW_SELECT) elif hw.upper() == "RESET": self._raw(HW_RESET) else: # DEFAULT: DOES NOTHING pass def print_and_feed(self, n=1): """ Print data in print buffer and feed *n* lines if n not in range (0, 255) then ValueError will be raised :param n: number of n to feed. 0 <= n <= 255. default: 1 :raises ValueError: if not 0 <= n <= 255 """ if 0 <= n <= 255: # ESC d n self._raw(ESC + b"d" + six.int2byte(n)) else: raise ValueError("n must be betwen 0 and 255") def control(self, ctl, count=5, tab_size=8): """ Feed control sequences :param ctl: string for the following control sequences: * LF *for Line Feed* * FF *for Form Feed* * CR *for Carriage Return* * HT *for Horizontal Tab* * VT *for Vertical Tab* :param count: integer between 1 and 32, controls the horizontal tab count. Defaults to 5. :param tab_size: integer between 1 and 255, controls the horizontal tab size in characters. Defaults to 8 :raises: :py:exc:`~escpos.exceptions.TabPosError` """ # Set position if ctl.upper() == "LF": self._raw(CTL_LF) elif ctl.upper() == "FF": self._raw(CTL_FF) elif ctl.upper() == "CR": self._raw(CTL_CR) elif ctl.upper() == "HT": if not (0 <= count <= 32 and 1 <= tab_size <= 255 and count * tab_size < 256): raise TabPosError() else: # Set tab positions self._raw(CTL_SET_HT) for iterator in range(1, count): self._raw(six.int2byte(iterator * tab_size)) self._raw(NUL) elif ctl.upper() == "VT": self._raw(CTL_VT) def panel_buttons(self, enable=True): """ Controls the panel buttons on the printer (e.g. FEED) When enable is set to False the panel buttons on the printer will be disabled. Calling the method with enable=True or without argument will enable the panel buttons. If panel buttons are enabled, the function of the panel button, such as feeding, will be executed upon pressing the button. If the panel buttons are disabled, pressing them will not have any effect. This command is effective until the printer is initialized, reset or power-cycled. The default is enabled panel buttons. Some panel buttons will always work, especially when printer is opened. See for more information the manual of your printer and the escpos-command-reference. :param enable: controls the panel buttons :rtype: None """ if enable: self._raw(PANEL_BUTTON_ON) else: self._raw(PANEL_BUTTON_OFF) def query_status(self, mode): """ 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) """ self._raw(mode) time.sleep(1) status = self._read() return status def is_online(self): """ 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[0] & RT_MASK_ONLINE) def paper_status(self): """ 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. :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 if (status[0] & RT_MASK_NOPAPER == RT_MASK_NOPAPER): return 0 if (status[0] & RT_MASK_LOWPAPER == RT_MASK_LOWPAPER): return 1 if (status[0] & RT_MASK_PAPER == RT_MASK_PAPER): return 2 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 EscposIO class. This example explains the usage: .. code-block:: Python with EscposIO(printer.Serial('/dev/ttyUSB0')) as p: p.set(font='a', height=2, align='center', text_type='bold') p.printer.set(align='left') p.printer.image('logo.gif') p.writelines('Big line\\n', font='b') p.writelines('Привет') p.writelines('BIG TEXT', width=2) After the `with`-statement the printer automatically cuts the paper if `autocut` is `True`. """ def __init__(self, printer, autocut=True, autoclose=True, **kwargs): """ :param printer: An EscPos-printer object :type printer: escpos.Escpos :param autocut: If True, paper is automatically cut after the `with`-statement *default*: True :param kwargs: These arguments will be passed to :py:meth:`escpos.Escpos.set()` """ self.printer = printer self.params = kwargs self.autocut = autocut self.autoclose = autoclose def set(self, **kwargs): """ Set the printer-parameters Controls which parameters will be passed to :py:meth:`Escpos.set() <escpos.escpos.Escpos.set()>`. For more information on the parameters see the :py:meth:`set() <escpos.escpos.Escpos.set()>`-methods documentation. These parameters can also be passed with this class' constructor or the :py:meth:`~escpos.escpos.EscposIO.writelines()`-method. :param kwargs: keyword-parameters that will be passed to :py:meth:`Escpos.set() <escpos.escpos.Escpos.set()>` """ self.params.update(kwargs) def writelines(self, text, **kwargs): params = dict(self.params) params.update(kwargs) if isinstance(text, six.text_type): lines = text.split('\n') elif isinstance(text, list) or isinstance(text, tuple): lines = text else: lines = ["{0}".format(text), ] # TODO check unicode handling # TODO flush? or on print? (this should prob rather be handled by the _raw-method) for line in lines: self.printer.set(**params) if isinstance(text, six.text_type): self.printer.text(u"{0}\n".format(line)) else: self.printer.text("{0}\n".format(line)) def close(self): """ called upon closing the `with`-statement """ self.printer.close() def __enter__(self, **kwargs): return self def __exit__(self, type, value, traceback): """ If :py:attr:`autocut <escpos.escpos.EscposIO.autocut>` is `True` (set by this class' constructor), then :py:meth:`printer.cut() <escpos.escpos.Escpos.cut()>` will be called here. """ if not (type is not None and issubclass(type, Exception)): if self.autocut: self.printer.cut() if self.autoclose: self.close()

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- """ Magic Encode This module tries to convert an UTF-8 string to an encoded string for the printer. It uses trial and error in order to guess the right codepage. The code is based on the encoding-code in py-xml-escpos by @fvdsn. :author: `Patrick Kanzler <dev@pkanzler.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 Patrick Kanzler and Frédéric van der Essen :license: MIT """ from builtins import bytes from .constants import CODEPAGE_CHANGE from .exceptions import Error from .codepages import CodePages import six class Encoder(object): """Takes a list of available code spaces. Picks the right one for a given character. Note: To determine the code page, it needs to do the conversion, and thus already knows what the final byte in the target encoding would be. Nevertheless, the API of this class doesn't return the byte. The caller use to do the character conversion itself. $ python -m timeit -s "{u'ö':'a'}.get(u'ö')" 100000000 loops, best of 3: 0.0133 usec per loop $ python -m timeit -s "u'ö'.encode('latin1')" 100000000 loops, best of 3: 0.0141 usec per loop """ def __init__(self, codepage_map): self.codepages = codepage_map self.available_encodings = set(codepage_map.keys()) self.available_characters = {} self.used_encodings = set() def get_sequence(self, encoding): return int(self.codepages[encoding]) def get_encoding_name(self, encoding): """Given an encoding provided by the user, will return a canonical encoding name; and also validate that the encoding is supported. TODO: Support encoding aliases: pc437 instead of cp437. """ encoding = CodePages.get_encoding_name(encoding) if encoding not in self.codepages: raise ValueError(( 'Encoding "{}" cannot be used for the current profile. ' 'Valid encodings are: {}' ).format(encoding, ','.join(self.codepages.keys()))) return encoding @staticmethod def _get_codepage_char_list(encoding): """Get codepage character list Gets characters 128-255 for a given code page, as an array. :param encoding: The name of the encoding. This must appear in the CodePage list """ codepage = CodePages.get_encoding(encoding) if 'data' in codepage: encodable_chars = list("".join(codepage['data'])) assert(len(encodable_chars) == 128) return encodable_chars elif 'python_encode' in codepage: encodable_chars = [u" "] * 128 for i in range(0, 128): codepoint = i + 128 try: encodable_chars[i] = bytes([codepoint]).decode(codepage['python_encode']) except UnicodeDecodeError: # Non-encodable character, just skip it pass return encodable_chars raise LookupError("Can't find a known encoding for {}".format(encoding)) def _get_codepage_char_map(self, encoding): """ Get codepage character map Process an encoding and return a map of UTF-characters to code points in this encoding. This is generated once only, and returned from a cache. :param encoding: The name of the encoding. """ # Skip things that were loaded previously if encoding in self.available_characters: return self.available_characters[encoding] codepage_char_list = self._get_codepage_char_list(encoding) codepage_char_map = dict((utf8, i + 128) for (i, utf8) in enumerate(codepage_char_list)) self.available_characters[encoding] = codepage_char_map return codepage_char_map def can_encode(self, encoding, char): """Determine if a character is encodeable in the given code page. :param encoding: The name of the encoding. :param char: The character to attempt to encode. """ available_map = {} try: available_map = self._get_codepage_char_map(encoding) except LookupError: return False # Decide whether this character is encodeable in this code page is_ascii = ord(char) < 128 is_encodable = char in available_map return is_ascii or is_encodable @staticmethod def _encode_char(char, charmap, defaultchar): """ Encode a single character with the given encoding map :param char: char to encode :param charmap: dictionary for mapping characters in this code page """ if ord(char) < 128: return ord(char) if char in charmap: return charmap[char] return ord(defaultchar) def encode(self, text, encoding, defaultchar='?'): """ Encode text under the given encoding :param text: Text to encode :param encoding: Encoding name to use (must be defined in capabilities) :param defaultchar: Fallback for non-encodable characters """ codepage_char_map = self._get_codepage_char_map(encoding) output_bytes = bytes([self._encode_char(char, codepage_char_map, defaultchar) for char in text]) return output_bytes def __encoding_sort_func(self, item): key, index = item return ( key in self.used_encodings, index ) def find_suitable_encoding(self, char): """The order of our search is a specific one: 1. code pages that we already tried before; there is a good chance they might work again, reducing the search space, and by re-using already used encodings we might also reduce the number of codepage change instructiosn we have to send. Still, any performance gains will presumably be fairly minor. 2. code pages in lower ESCPOS slots first. Presumably, they are more likely to be supported, so if a printer profile is missing or incomplete, we might increase our change that the code page we pick for this character is actually supported. """ sorted_encodings = sorted( self.codepages.items(), key=self.__encoding_sort_func) for encoding, _ in sorted_encodings: if self.can_encode(encoding, char): # This encoding worked; at it to the set of used ones. self.used_encodings.add(encoding) return encoding def split_writable_text(encoder, text, encoding): """Splits off as many characters from the begnning of text as are writable with "encoding". Returns a 2-tuple (writable, rest). """ if not encoding: return None, text for idx, char in enumerate(text): if encoder.can_encode(encoding, char): continue return text[:idx], text[idx:] return text, None class MagicEncode(object): """A helper that helps us to automatically switch to the right code page to encode any given Unicode character. This will consider the printers supported codepages, according to the printer profile, and if a character cannot be encoded with the current profile, it will attempt to find a suitable one. If the printer does not support a suitable code page, it can insert an error character. """ def __init__(self, driver, encoding=None, disabled=False, defaultsymbol='?', encoder=None): """ :param driver: :param encoding: If you know the current encoding of the printer when initializing this class, set it here. If the current encoding is unknown, the first character emitted will be a codepage switch. :param disabled: :param defaultsymbol: :param encoder: """ if disabled and not encoding: raise Error('If you disable magic encode, you need to define an encoding!') self.driver = driver self.encoder = encoder or Encoder(driver.profile.get_code_pages()) self.encoding = self.encoder.get_encoding_name(encoding) if encoding else None self.defaultsymbol = defaultsymbol self.disabled = disabled def force_encoding(self, encoding): """Sets a fixed encoding. The change is emitted right away. From now one, this buffer will switch the code page anymore. However, it will still keep track of the current code page. """ if not encoding: self.disabled = False else: self.write_with_encoding(encoding, None) self.disabled = True def write(self, text): """Write the text, automatically switching encodings. """ if self.disabled: self.write_with_encoding(self.encoding, text) return # See how far we can go into the text with the current encoding to_write, text = split_writable_text(self.encoder, text, self.encoding) if to_write: self.write_with_encoding(self.encoding, to_write) while text: # See if any of the code pages that the printer profile # supports can encode this character. encoding = self.encoder.find_suitable_encoding(text[0]) if not encoding: self._handle_character_failed(text[0]) text = text[1:] continue # Write as much text as possible with the encoding found. to_write, text = split_writable_text(self.encoder, text, encoding) if to_write: self.write_with_encoding(encoding, to_write) def _handle_character_failed(self, char): """Called when no codepage was found to render a character. """ # Writing the default symbol via write() allows us to avoid # unnecesary codepage switches. self.write(self.defaultsymbol) def write_with_encoding(self, encoding, text): if text is not None and type(text) is not six.text_type: raise Error("The supplied text has to be unicode, but is of type {type}.".format( type=type(text) )) # We always know the current code page; if the new codepage # is different, emit a change command. if encoding != self.encoding: self.encoding = encoding self.driver._raw( CODEPAGE_CHANGE + six.int2byte(self.encoder.get_sequence(encoding))) if text: self.driver._raw(self.encoder.encode(text, encoding))

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# -*- coding: utf-8 -*- """ python-escpos enables you to manipulate escpos-printers """ __all__ = ["constants", "escpos", "exceptions", "printer"] try: from .version import version as __version__ # noqa except ImportError: # pragma: no cover raise ImportError( 'Failed to find (autogenerated) version.py. ' 'This might be because you are installing from GitHub\'s tarballs, ' 'use the PyPI ones.' )

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/env python # PYTHON_ARGCOMPLETE_OK """ CLI This module acts as a command line interface for python-escpos. It mirrors closely the available ESCPOS commands while adding a couple extra ones for convenience. It requires you to have a configuration file. See documentation for details. """ import argparse try: import argcomplete except ImportError: # this CLI works nevertheless without argcomplete pass # noqa import sys import six from . import config from . import version # Must be defined before it's used in DEMO_FUNCTIONS def str_to_bool(string): """ Used as a type in argparse so that we get back a proper bool instead of always True """ return string.lower() in ('y', 'yes', '1', 'true') # A list of functions that work better with a newline to be sent after them. REQUIRES_NEWLINE = ('qr', 'barcode', 'text', 'block_text') # Used in demo method # Key: The name of escpos function and the argument passed on the CLI. Some # manual translation is done in the case of barcodes_a -> barcode. # Value: A list of dictionaries to pass to the escpos function as arguments. DEMO_FUNCTIONS = { 'text': [ {'txt': 'Hello, World!\n', } ], 'qr': [ {'content': 'This tests a QR code'}, {'content': 'https://en.wikipedia.org/'} ], 'barcodes_a': [ {'bc': 'UPC-A', 'code': '13243546576'}, {'bc': 'UPC-E', 'code': '132435'}, {'bc': 'EAN13', 'code': '1324354657687'}, {'bc': 'EAN8', 'code': '1324354'}, {'bc': 'CODE39', 'code': 'TEST'}, {'bc': 'ITF', 'code': '55867492279103'}, {'bc': 'NW7', 'code': 'A00000000A'}, ], 'barcodes_b': [ {'bc': 'UPC-A', 'code': '13243546576', 'function_type': 'B'}, {'bc': 'UPC-E', 'code': '132435', 'function_type': 'B'}, {'bc': 'EAN13', 'code': '1324354657687', 'function_type': 'B'}, {'bc': 'EAN8', 'code': '1324354', 'function_type': 'B'}, {'bc': 'CODE39', 'code': 'TEST', 'function_type': 'B'}, {'bc': 'ITF', 'code': '55867492279103', 'function_type': 'B'}, {'bc': 'NW7', 'code': 'A00000000A', 'function_type': 'B'}, {'bc': 'CODE93', 'code': 'A00000000A', 'function_type': 'B'}, {'bc': 'CODE93', 'code': '1324354657687', 'function_type': 'B'}, {'bc': 'CODE128A', 'code': 'TEST', 'function_type': 'B'}, {'bc': 'CODE128B', 'code': 'TEST', 'function_type': 'B'}, {'bc': 'CODE128C', 'code': 'TEST', 'function_type': 'B'}, {'bc': 'GS1-128', 'code': '00123456780000000001', 'function_type': 'B'}, {'bc': 'GS1 DataBar Omnidirectional', 'code': '0000000000000', 'function_type': 'B'}, {'bc': 'GS1 DataBar Truncated', 'code': '0000000000000', 'function_type': 'B'}, {'bc': 'GS1 DataBar Limited', 'code': '0000000000000', 'function_type': 'B'}, {'bc': 'GS1 DataBar Expanded', 'code': '00AAAAAAA', 'function_type': 'B'}, ], } # Used to build the CLI # A list of dictionaries. Each dict is a CLI argument. # Keys: # parser: A dict of args for command_parsers.add_parser # defaults: A dict of args for subparser.set_defaults # arguments: A list of dicts of args for subparser.add_argument ESCPOS_COMMANDS = [ { 'parser': { 'name': 'qr', 'help': 'Print a QR code', }, 'defaults': { 'func': 'qr', }, 'arguments': [ { 'option_strings': ('--content',), 'help': 'Text to print as a qr code', 'required': True, }, { 'option_strings': ('--size',), 'help': 'QR code size (1-16) [default:3]', 'required': False, 'type': int, } ], }, { 'parser': { 'name': 'barcode', 'help': 'Print a barcode', }, 'defaults': { 'func': 'barcode', }, 'arguments': [ { 'option_strings': ('--code',), 'help': 'Barcode data to print', 'required': True, }, { 'option_strings': ('--bc',), 'help': 'Barcode format', 'required': True, }, { 'option_strings': ('--height',), 'help': 'Barcode height in px', 'type': int, }, { 'option_strings': ('--width',), 'help': 'Barcode width', 'type': int, }, { 'option_strings': ('--pos',), 'help': 'Label position', 'choices': ['BELOW', 'ABOVE', 'BOTH', 'OFF'], }, { 'option_strings': ('--font',), 'help': 'Label font', 'choices': ['A', 'B'], }, { 'option_strings': ('--align_ct',), 'help': 'Align barcode center', 'type': str_to_bool, }, { 'option_strings': ('--function_type',), 'help': 'ESCPOS function type', 'choices': ['A', 'B'], }, ], }, { 'parser': { 'name': 'text', 'help': 'Print plain text', }, 'defaults': { 'func': 'text', }, 'arguments': [ { 'option_strings': ('--txt',), 'help': 'Plain text to print', 'required': True, } ], }, { 'parser': { 'name': 'block_text', 'help': 'Print wrapped text', }, 'defaults': { 'func': 'block_text', }, 'arguments': [ { 'option_strings': ('--txt',), 'help': 'block_text to print', 'required': True, }, { 'option_strings': ('--columns',), 'help': 'Number of columns', 'type': int, }, ], }, { 'parser': { 'name': 'cut', 'help': 'Cut the paper', }, 'defaults': { 'func': 'cut', }, 'arguments': [ { 'option_strings': ('--mode',), 'help': 'Type of cut', 'choices': ['FULL', 'PART'], }, ], }, { 'parser': { 'name': 'cashdraw', 'help': 'Kick the cash drawer', }, 'defaults': { 'func': 'cashdraw', }, 'arguments': [ { 'option_strings': ('--pin',), 'help': 'Which PIN to kick', 'choices': [2, 5], }, ], }, { 'parser': { 'name': 'image', 'help': 'Print an image', }, 'defaults': { 'func': 'image', }, 'arguments': [ { 'option_strings': ('--img_source',), 'help': 'Path to image', 'required': True, }, { 'option_strings': ('--impl',), 'help': 'Implementation to use', 'choices': ['bitImageRaster', 'bitImageColumn', 'graphics'], }, { 'option_strings': ('--high_density_horizontal',), 'help': 'Image density (horizontal)', 'type': str_to_bool, }, { 'option_strings': ('--high_density_vertical',), 'help': 'Image density (vertical)', 'type': str_to_bool, }, ], }, { 'parser': { 'name': 'fullimage', 'help': 'Print a fullimage', }, 'defaults': { 'func': 'fullimage', }, 'arguments': [ { 'option_strings': ('--img',), 'help': 'Path to img', 'required': True, }, { 'option_strings': ('--max_height',), 'help': 'Max height of image in px', 'type': int, }, { 'option_strings': ('--width',), 'help': 'Max width of image in px', 'type': int, }, { 'option_strings': ('--histeq',), 'help': 'Equalize the histrogram', 'type': str_to_bool, }, { 'option_strings': ('--bandsize',), 'help': 'Size of bands to divide into when printing', 'type': int, }, ], }, { 'parser': { 'name': 'charcode', 'help': 'Set character code table', }, 'defaults': { 'func': 'charcode', }, 'arguments': [ { 'option_strings': ('--code',), 'help': 'Character code', 'required': True, }, ], }, { 'parser': { 'name': 'set', 'help': 'Set text properties', }, 'defaults': { 'func': 'set', }, 'arguments': [ { 'option_strings': ('--align',), 'help': 'Horizontal alignment', 'choices': ['left', 'center', 'right'], }, { 'option_strings': ('--font',), 'help': 'Font choice', 'choices': ['left', 'center', 'right'], }, { 'option_strings': ('--text_type',), 'help': 'Text properties', 'choices': ['B', 'U', 'U2', 'BU', 'BU2', 'NORMAL'], }, { 'option_strings': ('--width',), 'help': 'Width multiplier', 'type': int, }, { 'option_strings': ('--height',), 'help': 'Height multiplier', 'type': int, }, { 'option_strings': ('--density',), 'help': 'Print density', 'type': int, }, { 'option_strings': ('--invert',), 'help': 'White on black printing', 'type': str_to_bool, }, { 'option_strings': ('--smooth',), 'help': 'Text smoothing. Effective on >: 4x4 text', 'type': str_to_bool, }, { 'option_strings': ('--flip',), 'help': 'Text smoothing. Effective on >: 4x4 text', 'type': str_to_bool, }, ], }, { 'parser': { 'name': 'hw', 'help': 'Hardware operations', }, 'defaults': { 'func': 'hw', }, 'arguments': [ { 'option_strings': ('--hw',), 'help': 'Operation', 'choices': ['INIT', 'SELECT', 'RESET'], 'required': True, }, ], }, { 'parser': { 'name': 'control', 'help': 'Control sequences', }, 'defaults': { 'func': 'control', }, 'arguments': [ { 'option_strings': ('--ctl',), 'help': 'Control sequence', 'choices': ['LF', 'FF', 'CR', 'HT', 'VT'], 'required': True, }, { 'option_strings': ('--pos',), 'help': 'Horizontal tab position (1-4)', 'type': int, }, ], }, { 'parser': { 'name': 'panel_buttons', 'help': 'Controls panel buttons', }, 'defaults': { 'func': 'panel_buttons', }, 'arguments': [ { 'option_strings': ('--enable',), 'help': 'Feed button enabled', 'type': str_to_bool, 'required': True, }, ], }, { 'parser': { 'name': 'raw', 'help': 'Raw data', }, 'defaults': { 'func': '_raw', }, 'arguments': [ { 'option_strings': ('--msg',), 'help': 'Raw data to send', 'required': True, }, ], }, ] def main(): """ Handles loading of configuration and creating and processing of command line arguments. Called when run from a CLI. """ parser = argparse.ArgumentParser( description='CLI for python-escpos', epilog='Printer configuration is defined in the python-escpos config' 'file. See documentation for details.', ) parser.register('type', 'bool', str_to_bool) # Allow config file location to be passed parser.add_argument( '-c', '--config', help='Alternate path to the configuration file', ) # Everything interesting runs off of a subparser so we can use the format # cli [subparser] -args command_subparsers = parser.add_subparsers( title='ESCPOS Command', dest='parser', ) # fix inconsistencies in the behaviour of some versions of argparse command_subparsers.required = False # force 'required' testing # Build the ESCPOS command arguments for command in ESCPOS_COMMANDS: parser_command = command_subparsers.add_parser(**command['parser']) parser_command.set_defaults(**command['defaults']) for argument in command['arguments']: option_strings = argument.pop('option_strings') parser_command.add_argument(*option_strings, **argument) # Build any custom arguments parser_command_demo = command_subparsers.add_parser('demo', help='Demonstrates various functions') parser_command_demo.set_defaults(func='demo') demo_group = parser_command_demo.add_mutually_exclusive_group() demo_group.add_argument( '--barcodes-a', help='Print demo barcodes for function type A', action='store_true', ) demo_group.add_argument( '--barcodes-b', help='Print demo barcodes for function type B', action='store_true', ) demo_group.add_argument( '--qr', help='Print some demo QR codes', action='store_true', ) demo_group.add_argument( '--text', help='Print some demo text', action='store_true', ) parser_command_version = command_subparsers.add_parser('version', help='Print the version of python-escpos') parser_command_version.set_defaults(version=True) # hook in argcomplete if 'argcomplete' in globals(): argcomplete.autocomplete(parser) # Get only arguments actually passed args_dict = vars(parser.parse_args()) if not args_dict: parser.print_help() sys.exit() command_arguments = dict([k, v] for k, v in six.iteritems(args_dict) if v is not None) # If version should be printed, do this, then exit print_version = command_arguments.pop('version', None) if print_version: print(version.version) sys.exit() # If there was a config path passed, grab it config_path = command_arguments.pop('config', None) # Load the configuration and defined printer saved_config = config.Config() saved_config.load(config_path) printer = saved_config.printer() if not printer: raise Exception('No printers loaded from config') target_command = command_arguments.pop('func') # remove helper-argument 'parser' from dict command_arguments.pop('parser', None) if hasattr(printer, target_command): # print command with args getattr(printer, target_command)(**command_arguments) if target_command in REQUIRES_NEWLINE: printer.text("\n") else: command_arguments['printer'] = printer globals()[target_command](**command_arguments) def demo(printer, **kwargs): """ Prints demos. Called when CLI is passed `demo`. This function uses the DEMO_FUNCTIONS dictionary. :param printer: A printer from escpos.printer :param kwargs: A dict with a key for each function you want to test. It's in this format since it usually comes from argparse. """ for demo_choice in kwargs.keys(): command = getattr( printer, demo_choice .replace('barcodes_a', 'barcode') .replace('barcodes_b', 'barcode') ) for params in DEMO_FUNCTIONS[demo_choice]: command(**params) printer.cut() if __name__ == '__main__': main()

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# -*- coding: utf-8 -*- """ ESC/POS Exceptions classes Result/Exit codes: - `0` = success - `10` = No Barcode type defined :py:exc:`~escpos.exceptions.BarcodeTypeError` - `20` = Barcode size values are out of range :py:exc:`~escpos.exceptions.BarcodeSizeError` - `30` = Barcode text not supplied :py:exc:`~escpos.exceptions.BarcodeCodeError` - `40` = Image height is too large :py:exc:`~escpos.exceptions.ImageSizeError` - `41` = Image width is too large :py:exc:`~escpos.exceptions.ImageWidthError` - `50` = No string supplied to be printed :py:exc:`~escpos.exceptions.TextError` - `60` = Invalid pin to send Cash Drawer pulse :py:exc:`~escpos.exceptions.CashDrawerError` - `70` = Invalid number of tab positions :py:exc:`~escpos.exceptions.TabPosError` - `80` = Invalid char code :py:exc:`~escpos.exceptions.CharCodeError` - `90` = USB device not found :py:exc:`~escpos.exceptions.USBNotFoundError` - `100` = Set variable out of range :py:exc:`~escpos.exceptions.SetVariableError` - `200` = Configuration not found :py:exc:`~escpos.exceptions.ConfigNotFoundError` - `210` = Configuration syntax error :py:exc:`~escpos.exceptions.ConfigSyntaxError` - `220` = Configuration section not found :py:exc:`~escpos.exceptions.ConfigSectionMissingError` :author: `Manuel F Martinez <manpaz@bashlinux.com>`_ and others :organization: Bashlinux and `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2012-2017 Bashlinux and python-escpos :license: MIT """ class Error(Exception): """ Base class for ESC/POS errors """ def __init__(self, msg, status=None): Exception.__init__(self) self.msg = msg self.resultcode = 1 if status is not None: self.resultcode = status def __str__(self): return self.msg class BarcodeTypeError(Error): """ No Barcode type defined. This exception indicates that no known barcode-type has been entered. The barcode-type has to be one of those specified in :py:meth:`escpos.escpos.Escpos.barcode`. The returned error code is `10`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 10 def __str__(self): return "No Barcode type is defined ({msg})".format(msg=self.msg) class BarcodeSizeError(Error): """ Barcode size is out of range. This exception indicates that the values for the barcode size are out of range. The size of the barcode has to be in the range that is specified in :py:meth:`escpos.escpos.Escpos.barcode`. The resulting returncode is `20`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 20 def __str__(self): return "Barcode size is out of range ({msg})".format(msg=self.msg) class BarcodeCodeError(Error): """ No Barcode code was supplied, or it is incorrect. No data for the barcode has been supplied in :py:meth:`escpos.escpos.Escpos.barcode` or the the `check` parameter was True and the check failed. The returncode for this exception is `30`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 30 def __str__(self): return "No Barcode code was supplied ({msg})".format(msg=self.msg) class ImageSizeError(Error): """ Image height is longer than 255px and can't be printed. The returncode for this exception is `40`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 40 def __str__(self): return "Image height is longer than 255px and can't be printed ({msg})".format(msg=self.msg) class ImageWidthError(Error): """ Image width is too large. The return code for this exception is `41`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 41 def __str__(self): return "Image width is too large ({msg})".format(msg=self.msg) class TextError(Error): """ Text string must be supplied to the `text()` method. This exception is raised when an empty string is passed to :py:meth:`escpos.escpos.Escpos.text`. The returncode for this exception is `50`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 50 def __str__(self): return "Text string must be supplied to the text() method ({msg})".format(msg=self.msg) class CashDrawerError(Error): """ Valid pin must be set in order to send pulse. A valid pin number has to be passed onto the method :py:meth:`escpos.escpos.Escpos.cashdraw`. The returncode for this exception is `60`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 60 def __str__(self): return "Valid pin must be set to send pulse ({msg})".format(msg=self.msg) class TabPosError(Error): """ Valid tab positions must be set by using from 1 to 32 tabs, and between 1 and 255 tab size values. Both values multiplied must not exceed 255, since it is the maximum tab value. This exception is raised by :py:meth:`escpos.escpos.Escpos.control`. The returncode for this exception is `70`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 70 def __str__(self): return "Valid tab positions must be in the range 0 to 16 ({msg})".format(msg=self.msg) class CharCodeError(Error): """ Valid char code must be set. The supplied charcode-name in :py:meth:`escpos.escpos.Escpos.charcode` is unknown. Ths returncode for this exception is `80`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 80 def __str__(self): return "Valid char code must be set ({msg})".format(msg=self.msg) class USBNotFoundError(Error): """ Device wasn't found (probably not plugged in) The USB device seems to be not plugged in. Ths returncode for this exception is `90`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 90 def __str__(self): return "USB device not found ({msg})".format(msg=self.msg) class SetVariableError(Error): """ A set method variable was out of range Check set variables against minimum and maximum values Ths returncode for this exception is `100`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 100 def __str__(self): return "Set variable out of range ({msg})".format(msg=self.msg) # Configuration errors class ConfigNotFoundError(Error): """ The configuration file was not found The default or passed configuration file could not be read Ths returncode for this exception is `200`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 200 def __str__(self): return "Configuration not found ({msg})".format(msg=self.msg) class ConfigSyntaxError(Error): """ The configuration file is invalid The syntax is incorrect Ths returncode for this exception is `210`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 210 def __str__(self): return "Configuration syntax is invalid ({msg})".format(msg=self.msg) class ConfigSectionMissingError(Error): """ The configuration file is missing a section The part of the config asked for doesn't exist in the loaded configuration Ths returncode for this exception is `220`. """ def __init__(self, msg=""): Error.__init__(self, msg) self.msg = msg self.resultcode = 220 def __str__(self): return "Configuration section is missing ({msg})".format(msg=self.msg)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# -*- coding: utf-8 -*- """ Set of ESC/POS Commands (Constants) This module contains constants that are described in the esc/pos-documentation. Since there is no definitive and unified specification for all esc/pos-like printers the constants could later be moved to `capabilities` as in `escpos-php by @mike42 <https://github.com/mike42/escpos-php>`_. :author: `Manuel F Martinez <manpaz@bashlinux.com>`_ and others :organization: Bashlinux and `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2012-2017 Bashlinux and python-escpos :license: MIT """ import six # Control characters # as labelled in https://www.novopos.ch/client/EPSON/TM-T20/TM-T20_eng_qr.pdf NUL = b'\x00' EOT = b'\x04' ENQ = b'\x05' DLE = b'\x10' DC4 = b'\x14' CAN = b'\x18' ESC = b'\x1b' FS = b'\x1c' GS = b'\x1d' # Feed control sequences CTL_LF = b'\n' # Print and line feed CTL_FF = b'\f' # Form feed CTL_CR = b'\r' # Carriage return CTL_HT = b'\t' # Horizontal tab CTL_SET_HT = ESC + b'\x44' # Set horizontal tab positions CTL_VT = b'\v' # Vertical tab # Printer hardware HW_INIT = ESC + b'@' # Clear data in buffer and reset modes HW_SELECT = ESC + b'=\x01' # Printer select HW_RESET = ESC + b'\x3f\x0a\x00' # Reset printer hardware # (TODO: Where is this specified?) # Cash Drawer (ESC p <pin> <on time: 2*ms> <off time: 2*ms>) _CASH_DRAWER = lambda m, t1='', t2='': ESC + b'p' + m + six.int2byte(t1) + six.int2byte(t2) CD_KICK_DEC_SEQUENCE = lambda esc, p, m, t1=50, t2=50: six.int2byte(esc) + six.int2byte(p) + six.int2byte(m) + six.int2byte(t1) + six.int2byte(t2) CD_KICK_2 = _CASH_DRAWER(b'\x00', 50, 50) # Sends a pulse to pin 2 [] CD_KICK_5 = _CASH_DRAWER(b'\x01', 50, 50) # Sends a pulse to pin 5 [] # Paper Cutter _CUT_PAPER = lambda m: GS + b'V' + m PAPER_FULL_CUT = _CUT_PAPER(b'\x00') # Full cut paper PAPER_PART_CUT = _CUT_PAPER(b'\x01') # Partial cut paper # Beep BEEP = b'\x07' # Panel buttons (e.g. the FEED button) _PANEL_BUTTON = lambda n: ESC + b'c5' + six.int2byte(n) PANEL_BUTTON_ON = _PANEL_BUTTON(0) # enable all panel buttons PANEL_BUTTON_OFF = _PANEL_BUTTON(1) # disable all panel buttons # Line display printing LINE_DISPLAY_OPEN = ESC + b'\x3d\x02' LINE_DISPLAY_CLEAR = ESC + b'\x40' LINE_DISPLAY_CLOSE = ESC + b'\x3d\x01' # Sheet modes SHEET_SLIP_MODE = ESC + b'\x63\x30\x04' # slip paper SHEET_ROLL_MODE = ESC + b'\x63\x30\x01' # paper roll # Text format # TODO: Acquire the "ESC/POS Application Programming Guide for Paper Roll # Printers" and tidy up this stuff too. TXT_SIZE = GS + b'!' TXT_NORMAL = ESC + b'!\x00' # Normal text TXT_STYLE = { 'bold': { False: ESC + b'\x45\x00', # Bold font OFF True: ESC + b'\x45\x01' # Bold font ON }, 'underline': { 0: ESC + b'\x2d\x00', # Underline font OFF 1: ESC + b'\x2d\x01', # Underline font 1-dot ON 2: ESC + b'\x2d\x02' # Underline font 2-dot ON }, 'size': { 'normal': TXT_NORMAL + ESC + b'!\x00', # Normal text '2h': TXT_NORMAL + ESC + b'!\x10', # Double height text '2w': TXT_NORMAL + ESC + b'!\x20', # Double width text '2x': TXT_NORMAL + ESC + b'!\x30' # Quad area text }, 'font': { 'a': ESC + b'\x4d\x00', # Font type A 'b': ESC + b'\x4d\x00' # Font type B }, 'align': { 'left': ESC + b'\x61\x00', # Left justification 'center': ESC + b'\x61\x01', # Centering 'right': ESC + b'\x61\x02' # Right justification }, 'invert': { True: GS + b'\x42\x01', # Inverse Printing ON False: GS + b'\x42\x00' # Inverse Printing OFF }, 'color': { 'black': ESC + b'\x72\x00', # Default Color 'red': ESC + b'\x72\x01' # Alternative Color, Usually Red }, 'flip': { True: ESC + b'\x7b\x01', # Flip ON False: ESC + b'\x7b\x00' # Flip OFF }, 'density': { 0: GS + b'\x7c\x00', # Printing Density -50% 1: GS + b'\x7c\x01', # Printing Density -37.5% 2: GS + b'\x7c\x02', # Printing Density -25% 3: GS + b'\x7c\x03', # Printing Density -12.5% 4: GS + b'\x7c\x04', # Printing Density 0% 5: GS + b'\x7c\x08', # Printing Density +50% 6: GS + b'\x7c\x07', # Printing Density +37.5% 7: GS + b'\x7c\x06', # Printing Density +25% 8: GS + b'\x7c\x05' # Printing Density +12.5% }, 'smooth': { True: GS + b'\x62\x01', # Smooth ON False: GS + b'\x62\x00' # Smooth OFF }, 'height': { # Custom text height 1: 0x00, 2: 0x01, 3: 0x02, 4: 0x03, 5: 0x04, 6: 0x05, 7: 0x06, 8: 0x07 }, 'width': { # Custom text width 1: 0x00, 2: 0x10, 3: 0x20, 4: 0x30, 5: 0x40, 6: 0x50, 7: 0x60, 8: 0x70 } } # Fonts SET_FONT = lambda n: ESC + b'\x4d' + n TXT_FONT_A = SET_FONT(b'\x00') # Font type A TXT_FONT_B = SET_FONT(b'\x01') # Font type B # Spacing LINESPACING_RESET = ESC + b'2' LINESPACING_FUNCS = { 60: ESC + b'A', # line_spacing/60 of an inch, 0 <= line_spacing <= 85 360: ESC + b'+', # line_spacing/360 of an inch, 0 <= line_spacing <= 255 180: ESC + b'3', # line_spacing/180 of an inch, 0 <= line_spacing <= 255 } # Prefix to change the codepage. You need to attach a byte to indicate # the codepage to use. We use escpos-printer-db as the data source. CODEPAGE_CHANGE = ESC + b'\x74' # Barcode format _SET_BARCODE_TXT_POS = lambda n: GS + b'H' + n BARCODE_TXT_OFF = _SET_BARCODE_TXT_POS(b'\x00') # HRI barcode chars OFF BARCODE_TXT_ABV = _SET_BARCODE_TXT_POS(b'\x01') # HRI barcode chars above BARCODE_TXT_BLW = _SET_BARCODE_TXT_POS(b'\x02') # HRI barcode chars below BARCODE_TXT_BTH = _SET_BARCODE_TXT_POS(b'\x03') # HRI both above and below _SET_HRI_FONT = lambda n: GS + b'f' + n BARCODE_FONT_A = _SET_HRI_FONT(b'\x00') # Font type A for HRI barcode chars BARCODE_FONT_B = _SET_HRI_FONT(b'\x01') # Font type B for HRI barcode chars BARCODE_HEIGHT = GS + b'h' # Barcode Height [1-255] BARCODE_WIDTH = GS + b'w' # Barcode Width [2-6] # NOTE: This isn't actually an ESC/POS command. It's the common prefix to the # two "print bar code" commands: # - Type A: "GS k <type as integer> <data> NUL" # - TYPE B: "GS k <type as letter> <data length> <data>" # The latter command supports more barcode types _SET_BARCODE_TYPE = lambda m: GS + b'k' + six.int2byte(m) # Barcodes for printing function type A BARCODE_TYPE_A = { 'UPC-A': _SET_BARCODE_TYPE(0), 'UPC-E': _SET_BARCODE_TYPE(1), 'EAN13': _SET_BARCODE_TYPE(2), 'EAN8': _SET_BARCODE_TYPE(3), 'CODE39': _SET_BARCODE_TYPE(4), 'ITF': _SET_BARCODE_TYPE(5), 'NW7': _SET_BARCODE_TYPE(6), 'CODABAR': _SET_BARCODE_TYPE(6), # Same as NW7 } # Barcodes for printing function type B # The first 8 are the same barcodes as type A BARCODE_TYPE_B = { 'UPC-A': _SET_BARCODE_TYPE(65), 'UPC-E': _SET_BARCODE_TYPE(66), 'EAN13': _SET_BARCODE_TYPE(67), 'EAN8': _SET_BARCODE_TYPE(68), 'CODE39': _SET_BARCODE_TYPE(69), 'ITF': _SET_BARCODE_TYPE(70), 'NW7': _SET_BARCODE_TYPE(71), 'CODABAR': _SET_BARCODE_TYPE(71), # Same as NW7 'CODE93': _SET_BARCODE_TYPE(72), 'CODE128': _SET_BARCODE_TYPE(73), 'GS1-128': _SET_BARCODE_TYPE(74), 'GS1 DATABAR OMNIDIRECTIONAL': _SET_BARCODE_TYPE(75), 'GS1 DATABAR TRUNCATED': _SET_BARCODE_TYPE(76), 'GS1 DATABAR LIMITED': _SET_BARCODE_TYPE(77), 'GS1 DATABAR EXPANDED': _SET_BARCODE_TYPE(78), } BARCODE_FORMATS = { 'UPC-A': ([(11, 12)], "^[0-9]{11,12}$"), 'UPC-E': ([(7, 8), (11, 12)], "^([0-9]{7,8}|[0-9]{11,12})$"), 'EAN13': ([(12, 13)], "^[0-9]{12,13}$"), 'EAN8': ([(7, 8)], "^[0-9]{7,8}$"), 'CODE39': ([(1, 255)], "^([0-9A-Z \$\%\+\-\.\/]+|\*[0-9A-Z \$\%\+\-\.\/]+\*)$"), 'ITF': ([(2, 255)], "^([0-9]{2})+$"), 'NW7': ([(1, 255)], "^[A-Da-d][0-9\$\+\-\.\/\:]+[A-Da-d]$"), 'CODABAR': ([(1, 255)], "^[A-Da-d][0-9\$\+\-\.\/\:]+[A-Da-d]$"), # Same as NW7 'CODE93': ([(1, 255)], "^[\\x00-\\x7F]+$"), 'CODE128': ([(2, 255)], "^\{[A-C][\\x00-\\x7F]+$"), 'GS1-128': ([(2, 255)], "^\{[A-C][\\x00-\\x7F]+$"), # same as CODE128 'GS1 DATABAR OMNIDIRECTIONAL': ([(13,13)], "^[0-9]{13}$"), 'GS1 DATABAR TRUNCATED': ([(13,13)], "^[0-9]{13}$"), # same as GS1 omnidirectional 'GS1 DATABAR LIMITED': ([(13,13)], "^[01][0-9]{12}$"), 'GS1 DATABAR EXPANDED': ([(2,255)], "^\([0-9][A-Za-z0-9 \!\"\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\_\{]+$"), } BARCODE_TYPES = { 'A': BARCODE_TYPE_A, 'B': BARCODE_TYPE_B, } # QRCode error correction levels QR_ECLEVEL_L = 0 QR_ECLEVEL_M = 1 QR_ECLEVEL_Q = 2 QR_ECLEVEL_H = 3 # QRcode models QR_MODEL_1 = 1 QR_MODEL_2 = 2 QR_MICRO = 3 # Image format # NOTE: _PRINT_RASTER_IMG is the obsolete ESC/POS "print raster bit image" # command. The constants include a fragment of the data's header. _PRINT_RASTER_IMG = lambda data: GS + b'v0' + data S_RASTER_N = _PRINT_RASTER_IMG(b'\x00') # Set raster image normal size S_RASTER_2W = _PRINT_RASTER_IMG(b'\x01') # Set raster image double width S_RASTER_2H = _PRINT_RASTER_IMG(b'\x02') # Set raster image double height S_RASTER_Q = _PRINT_RASTER_IMG(b'\x03') # Set raster image quadruple # Status Command RT_STATUS = DLE + EOT RT_STATUS_ONLINE = RT_STATUS + b'\x01' RT_STATUS_PAPER = RT_STATUS + b'\x04' RT_MASK_ONLINE = 8 RT_MASK_PAPER = 18 RT_MASK_LOWPAPER = 30 RT_MASK_NOPAPER = 114

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # 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 from escpos.printer import Usb """ Setting up the main pathing """ this_dir, this_filename = os.path.split(__file__) GRAPHICS_PATH = os.path.join(this_dir, "graphics/climacons/") # Adapt to your needs printer = Usb(0x0416, 0x5011, profile="POS-5890") # You can get your API Key on www.darksky.net and register a dev account. # Technically you can use any other weather service, of course :) API_KEY = "YOUR API KEY" LAT = "22.345490" # Your Location LONG = "114.189945" # Your Location def forecast_icon(idx): icon = data['daily']['data'][idx]['icon'] image = GRAPHICS_PATH + icon + ".png" return image # Dumps one forecast line to the printer def forecast(idx): date = datetime.fromtimestamp(int(data['daily']['data'][idx]['time'])) day = calendar.day_name[date.weekday()] lo = data['daily']['data'][idx]['temperatureMin'] hi = data['daily']['data'][idx]['temperatureMax'] cond = data['daily']['data'][idx]['summary'] print(date) print(day) print(lo) print(hi) print(cond) time.sleep(1) printer.set( font='a', height=2, align='left', bold=False, double_height=False) printer.text(day + ' \n ') time.sleep(5) # Sleep to prevent printer buffer overflow printer.text('\n') printer.image(forecast_icon(idx)) printer.text('low ' + str(lo)) printer.text(deg) printer.text('\n') printer.text(' high ' + str(hi)) printer.text(deg) printer.text('\n') # take care of pesky unicode dash printer.text(cond.replace(u'\u2013', '-').encode('utf-8')) printer.text('\n \n') def icon(): icon = data['currently']['icon'] image = GRAPHICS_PATH + icon + ".png" return image deg = ' C' # Degree symbol on thermal printer, need to find a better way to use a proper degree symbol # if you want Fahrenheit change units= to 'us' url = "https://api.darksky.net/forecast/" + API_KEY + "/" + LAT + "," + LONG + \ "?exclude=[alerts,minutely,hourly,flags]&units=si" # change last bit to 'us' for Fahrenheit response = urllib.urlopen(url) data = json.loads(response.read()) printer.print_and_feed(n=1) printer.control("LF") printer.set(font='a', height=2, align='center', bold=True, double_height=True) printer.text("Weather Forecast") printer.text("\n") printer.set(align='center') # Print current conditions printer.set(font='a', height=2, align='center', bold=True, double_height=False) printer.text('Current conditions: \n') printer.image(icon()) printer.text("\n") printer.set(font='a', height=2, align='left', bold=False, double_height=False) temp = data['currently']['temperature'] cond = data['currently']['summary'] printer.text(temp) printer.text(' ') printer.text(deg) printer.text(' ') printer.text('\n') printer.text('Sky: ' + cond) printer.text('\n') printer.text('\n') # Print forecast printer.set(font='a', height=2, align='center', bold=True, double_height=False) printer.text('Forecast: \n') forecast(0) forecast(1) printer.cut() printer.control("LF")

python-escpos/python-escpos

535

Python

constants.rst

text/plain

"""Prints code page tables. """ import six import sys from escpos import printer from escpos.constants import CODEPAGE_CHANGE, ESC, CTL_LF, CTL_FF, CTL_CR, CTL_HT, CTL_VT def main(): dummy = printer.Dummy() dummy.hw('init') for codepage in sys.argv[1:] or ['USA']: dummy.set(height=2, width=2) dummy._raw(codepage + "\n\n\n") print_codepage(dummy, codepage) dummy._raw("\n\n") dummy.cut() print(dummy.output) def print_codepage(printer, codepage): if codepage.isdigit(): codepage = int(codepage) printer._raw(CODEPAGE_CHANGE + six.int2byte(codepage)) printer._raw("after") else: printer.charcode(codepage) sep = "" # Table header printer.set(font='b') printer._raw(" {}\n".format(sep.join(map(lambda s: hex(s)[2:], range(0, 16))))) printer.set() # The table for x in range(0, 16): # First column printer.set(font='b') printer._raw("{} ".format(hex(x)[2:])) printer.set() for y in range(0, 16): byte = six.int2byte(x * 16 + y) if byte in (ESC, CTL_LF, CTL_FF, CTL_CR, CTL_HT, CTL_VT): byte = ' ' printer._raw(byte) printer._raw(sep) printer._raw('\n') if __name__ == '__main__': main()

python-escpos/python-escpos

535

Python

constants.rst

text/plain

from escpos.printer import Usb # Adapt to your needs p = Usb(0x0416, 0x5011, profile="POS-5890") # Some software barcodes p.soft_barcode('code128', 'Hello') p.soft_barcode('code39', '1234')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

from escpos.printer import Usb # Adapt to your needs p = Usb(0x0416, 0x5011, profile="POS-5890") # Print software and then hardware barcode with the same content p.soft_barcode('code39', '123456') p.text('\n') p.text('\n') p.barcode('123456', 'CODE39')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

import sys from escpos.printer import Usb def usage(): print("usage: qr_code.py <content>") if __name__ == '__main__': if len(sys.argv) != 2: usage() sys.exit(1) content = sys.argv[1] # Adapt to your needs p = Usb(0x0416, 0x5011, profile="POS-5890") p.qr(content, center=True)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# Climacons by Adam Whitcroft 75 climatically categorised pictographs for web and UI design by [@adamwhitcroft](https://www.twitter.com/#!/adamwhitcroft). Visit the [Climacons](https://adamwhitcroft.com/climacons/) website for more information. Visit [Adam Whitcroft on GitHub](https://github.com/AdamWhitcroft) ## License You are free to use any of the Climacons Icons (the "icons") in any personal or commercial work without obligation of payment (monetary or otherwise) or attribution, however a credit for the work would be appreciated. **Do not** redistribute or sell and **do not** claim creative credit. Intellectual property rights are not transferred with the download of the icons.

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- """tests for the File printer :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import six import pytest from hypothesis import given, settings from hypothesis.strategies import text import escpos.printer as printer if six.PY3: mock_open_call = 'builtins.open' else: mock_open_call = '__builtin__.open' @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""" mock_escpos = mocker.patch('escpos.escpos.Escpos.__init__') mock_open = mocker.patch(mock_open_call) printer.File(devfile=path) assert mock_escpos.called mock_open.assert_called_with(path, "wb") @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""" mock_escpos = mocker.patch('escpos.escpos.Escpos.__init__') mock_open = mocker.patch(mock_open_call) mock_device = mocker.patch.object(printer.File, 'device') p = printer.File(auto_flush=False) # inject the mocked device-object p.device = mock_device p._raw(txt) assert not mock_device.flush.called mock_device.reset_mock() p = printer.File(auto_flush=True) # inject the mocked device-object p.device = mock_device p._raw(txt) assert mock_device.flush.called @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""" mock_open = mocker.patch(mock_open_call) mock_device = mocker.patch.object(printer.File, 'device') p = printer.File(auto_flush=False) # inject the mocked device-object p.device = mock_device p._raw(txt) assert not mock_device.flush.called p.close() assert mock_device.flush.called assert mock_device.close.called

python-escpos/python-escpos

535

Python

constants.rst

text/plain

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'')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """test the raising of errors with the error module :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2017 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import pytest import escpos import escpos.exceptions def test_raise_error_wrongly(): """raise error the wrong way should reproduce https://github.com/python-escpos/python-escpos/issues/257 """ with pytest.raises(AttributeError): raise escpos.Error("This should raise an AttributeError.") def tests_raise_error(): """raise error the right way""" with pytest.raises(escpos.exceptions.Error): raise escpos.exceptions.Error("This should raise an error.")

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """tests for the text printing function :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import pytest import mock from hypothesis import given, assume import hypothesis.strategies as st from escpos.printer import Dummy def get_printer(): return Dummy(magic_encode_args={'disabled': True, 'encoding': 'CP437'}) @given(text=st.text()) def test_text(text): """Test that text() calls the MagicEncode object. """ instance = get_printer() instance.magic.write = mock.Mock() instance.text(text) instance.magic.write.assert_called_with(text) def test_block_text(): printer = get_printer() printer.block_text( "All the presidents men were eating falafel for breakfast.", font='a') assert printer.output == \ b'All the presidents men were eating falafel\nfor breakfast.' def test_textln(): printer = get_printer() printer.textln('hello, world') assert printer.output == b'hello, world\n' def test_textln_empty(): printer = get_printer() printer.textln() assert printer.output == b'\n' def test_ln(): printer = get_printer() printer.ln() assert printer.output == b'\n' def test_multiple_ln(): printer = get_printer() printer.ln(3) assert printer.output == b'\n\n\n'

python-escpos/python-escpos

535

Python

constants.rst

text/plain

"""Test for the CLI """ import os import sys from scripttest import TestFileEnvironment from nose.tools import assert_equals, nottest import escpos TEST_DIR = os.path.abspath('test/test-cli-output') DEVFILE_NAME = 'testfile' DEVFILE = os.path.join(TEST_DIR, DEVFILE_NAME) CONFIGFILE = 'testconfig.yaml' CONFIG_YAML = ''' --- printer: type: file devfile: {testfile} '''.format( testfile=DEVFILE, ) class TestCLI: """ Contains setups, teardowns, and tests for CLI """ @classmethod def setup_class(cls): """ Create a config file to read from """ with open(CONFIGFILE, 'w') as config: config.write(CONFIG_YAML) @classmethod def teardown_class(cls): """ Remove config file """ os.remove(CONFIGFILE) def setup(self): """ Create a file to print to and set up env""" self.env = None self.default_args = None self.env = TestFileEnvironment( base_path=TEST_DIR, cwd=os.getcwd(), ) self.default_args = ( 'python-escpos', '-c', CONFIGFILE, ) fhandle = open(DEVFILE, 'a') try: os.utime(DEVFILE, None) finally: fhandle.close() def teardown(self): """ Destroy printer file and env """ os.remove(DEVFILE) self.env.clear() def test_cli_help(self): """ Test getting help from cli """ result = self.env.run('python-escpos', '-h') assert not result.stderr assert 'usage' in result.stdout def test_cli_version(self): """ Test the version string """ result = self.env.run('python-escpos', 'version') assert not result.stderr assert_equals(escpos.__version__, result.stdout.strip()) @nottest # disable this test as it is not that easy anymore to predict the outcome of this call def test_cli_text(self): """ Make sure text returns what we sent it """ test_text = 'this is some text' result = self.env.run( *(self.default_args + ( 'text', '--txt', test_text, )) ) assert not result.stderr assert DEVFILE_NAME in result.files_updated.keys() assert_equals( result.files_updated[DEVFILE_NAME].bytes, test_text + '\n' ) def test_cli_text_inavlid_args(self): """ Test a failure to send valid arguments """ result = self.env.run( *(self.default_args + ( 'text', '--invalid-param', 'some data' )), expect_error=True, expect_stderr=True ) assert_equals(result.returncode, 2) assert 'error:' in result.stderr assert not result.files_updated

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- import escpos.printer as printer import pytest @pytest.mark.parametrize("bctype,data", [ ('UPC-A', '01234567890'), ('UPC-A', '012345678905'), ('UPC-E', '01234567'), ('UPC-E', '0123456'), ('UPC-E', '012345678905'), ('EAN13', '0123456789012'), ('EAN13', '012345678901'), ('EAN8', '01234567'), ('EAN8', '0123456'), ('CODE39', 'ABC-1234'), ('CODE39', 'ABC-1234-$$-+A'), ('CODE39', '*WIKIPEDIA*'), ('ITF', '010203040506070809'), ('ITF', '11221133113344556677889900'), ('CODABAR', 'A2030405060B'), ('CODABAR', 'C11221133113344556677889900D'), ('CODABAR', 'D0D'), ('NW7', 'A2030405060B'), ('NW7', 'C11221133113344556677889900D'), ('NW7', 'D0D'), ('CODE93', 'A2030405060B'), ('CODE93', '+:$&23-7@$'), ('CODE93', 'D0D'), ('CODE128', '{A2030405060B'), ('CODE128', '{C+:$&23-7@$'), ('CODE128', '{B0D'), ('GS1-128', '{A2030405060B'), ('GS1-128', '{C+:$&23-7@$'), ('GS1-128', '{B0D'), ('GS1 DATABAR OMNIDIRECTIONAL', '0123456789123'), ('GS1 DATABAR TRUNCATED', '0123456789123'), ('GS1 DATABAR LIMITED', '0123456789123'), ('GS1 DATABAR EXPANDED', '(9A{A20304+-%&06a0B'), ('GS1 DATABAR EXPANDED', '(1 {C+:&23-7%'), ('GS1 DATABAR EXPANDED', '(00000001234567678'), ]) def test_check_valid_barcode(bctype, data): assert (printer.Escpos.check_barcode(bctype, data)) @pytest.mark.parametrize("bctype,data", [ ('UPC-A', '01234567890123'), # too long ('UPC-A', '0123456789'), # too short ('UPC-A', '72527273-711'), # invalid '-' ('UPC-A', 'A12345678901'), # invalid 'A' ('UPC-E', '01234567890123'), # too long ('UPC-E', '012345'), # too short ('UPC-E', '72527-2'), # invalid '-' ('UPC-E', 'A123456'), # invalid 'A' ('EAN13', '0123456789'), # too short ('EAN13', 'A123456789012'), # invalid 'A' ('EAN13', '012345678901234'), # too long ('EAN8', '012345'), # too short ('EAN8', 'A123456789012'), # invalid 'A' ('EAN8', '012345678901234'), # too long ('CODE39', 'ALKJ_34'), # invalid '_' ('CODE39', 'A' * 256), # too long ('ITF', '010203040'), # odd length ('ITF', '0' * 256), # too long ('ITF', 'AB01'), # invalid 'A' ('CODABAR', '010203040'), # no start/stop ('CODABAR', '0' * 256), # too long ('CODABAR', 'AB-01F'), # invalid 'B' ('NW7', '010203040'), # no start/stop ('NW7', '0' * 256), # too long ('NW7', 'AB-01F'), # invalid 'B' ('CODE93', 'é010203040'), # invalid 'é' ('CODE93', '0' * 256), # too long ('CODE128', '010203040'), # missing leading { ('CODE128', '{D2354AA'), # second char not between A-C ('CODE128', '0' * 256), # too long ('GS1-128', '010203040'), # missing leading { ('GS1-128', '{D2354AA'), # second char not between A-C ('GS1-128', '0' * 256), # too long ('GS1 DATABAR OMNIDIRECTIONAL', '01234567891234'), # too long ('GS1 DATABAR OMNIDIRECTIONAL', '012345678912'), # too short ('GS1 DATABAR OMNIDIRECTIONAL', '012345678A1234'), # invalid 'A' ('GS1 DATABAR TRUNCATED', '01234567891234'), # too long ('GS1 DATABAR TRUNCATED', '012345678912'), # too short ('GS1 DATABAR TRUNCATED', '012345678A1234'), # invalid 'A' ('GS1 DATABAR LIMITED', '01234567891234'), # too long ('GS1 DATABAR LIMITED', '012345678912'), # too short ('GS1 DATABAR LIMITED', '012345678A1234'), # invalid 'A' ('GS1 DATABAR LIMITED', '02345678912341'), # invalid start (should be 01) ('GS1 DATABAR EXPANDED', '010203040'), # missing leading ( ('GS1-128', '(' + ('0' * 256)), # too long ('GS1 DATABAR EXPANDED', '(a{D2354AA'), # second char not between 0-9 ('GS1 DATABAR EXPANDED', 'IT will fail'), # first char not '(' ]) def test_check_invalid_barcode(bctype, data): assert (not printer.Escpos.check_barcode(bctype, data))

python-escpos/python-escpos

535

Python

constants.rst

text/plain

import pytest from escpos.capabilities import get_profile, NotSupported, BARCODE_B, Profile @pytest.fixture def profile(): return get_profile('default') class TestBaseProfile: """Test the `BaseProfile` class. """ def test_get_font(self, profile): with pytest.raises(NotSupported): assert profile.get_font('3') assert profile.get_font(1) == 1 assert profile.get_font('a') == 0 def test_supports(self, profile): assert not profile.supports('asdf asdf') assert profile.supports(BARCODE_B) def test_get_columns(self, profile): assert profile.get_columns('a') > 5 with pytest.raises(NotSupported): assert profile.get_columns('asdfasdf') class TestCustomProfile: """Test custom profile options with the `Profile` class. """ def test_columns(self): assert Profile(columns=10).get_columns('sdfasdf') == 10 def test_features(self): assert Profile(features={'foo': True}).supports('foo')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """test the facility which enables usage of the with-statement :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import escpos.printer as printer import escpos.escpos as escpos def test_with_statement(): """Use with statement""" dummy_printer = printer.Dummy() with escpos.EscposIO(dummy_printer) as p: p.writelines('Some text.\n') # TODO extend these tests as they don't really do anything at the moment

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """verifies that the metaclass abc is properly used by ESC/POS :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 Patrick Kanzler :license: MIT """ from nose.tools import raises import escpos.escpos as escpos from abc import ABCMeta @raises(TypeError) def test_abstract_base_class_raises(): """test whether the abstract base class raises an exception for ESC/POS""" escpos.Escpos() # This call should raise TypeError because of abstractmethod _raw() def test_abstract_base_class(): """ test whether Escpos has the metaclass ABCMeta """ assert issubclass(escpos.Escpos, object) assert type(escpos.Escpos) is ABCMeta

python-escpos/python-escpos

535

Python

constants.rst

text/plain

import six import escpos.printer as printer from escpos.constants import TXT_NORMAL, TXT_STYLE, SET_FONT from escpos.constants import TXT_SIZE # Default test, please copy and paste this block to test set method calls def test_default_values(): instance = printer.Dummy() instance.set() expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert(instance.output == b''.join(expected_sequence)) # Size tests def test_set_size_2h(): instance = printer.Dummy() instance.set(double_height=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['2h'], # Double height text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) def test_set_size_2w(): instance = printer.Dummy() instance.set(double_width=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['2w'], # Double width text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) def test_set_size_2x(): instance = printer.Dummy() instance.set(double_height=True, double_width=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['2x'], # Double text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) def test_set_size_custom(): instance = printer.Dummy() instance.set(custom_size=True, width=8, height=7) expected_sequence = ( TXT_SIZE, # Custom text size, no normal reset six.int2byte(TXT_STYLE['width'][8] + TXT_STYLE['height'][7]), TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) # Flip def test_set_flip(): instance = printer.Dummy() instance.set(flip=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][True], # Flip ON TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) # Smooth def test_smooth(): instance = printer.Dummy() instance.set(smooth=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][True], # Smooth ON TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert(instance.output == b''.join(expected_sequence)) # Type def test_set_bold(): instance = printer.Dummy() instance.set(bold=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][True], # Bold ON TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) def test_set_underline(): instance = printer.Dummy() instance.set(underline=1) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][1], # Underline ON, type 1 SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) def test_set_underline2(): instance = printer.Dummy() instance.set(underline=2) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][2], # Underline ON, type 2 SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][False] # Inverted OFF ) assert (instance.output == b''.join(expected_sequence)) # Align def test_align_center(): instance = printer.Dummy() instance.set(align='center') expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['center'], # Align center TXT_STYLE['invert'][False] # Inverted OFF ) assert(instance.output == b''.join(expected_sequence)) def test_align_right(): instance = printer.Dummy() instance.set(align='right') expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['right'], # Align right TXT_STYLE['invert'][False] # Inverted OFF ) assert(instance.output == b''.join(expected_sequence)) # Densities def test_densities(): for density in range(8): instance = printer.Dummy() instance.set(density=density) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['density'][density], # Custom density from 0 to 8 TXT_STYLE['invert'][False] # Inverted OFF ) assert(instance.output == b''.join(expected_sequence)) # Invert def test_invert(): instance = printer.Dummy() instance.set(invert=True) expected_sequence = ( TXT_NORMAL, TXT_STYLE['size']['normal'], # Normal text size TXT_STYLE['flip'][False], # Flip OFF TXT_STYLE['smooth'][False], # Smooth OFF TXT_STYLE['bold'][False], # Bold OFF TXT_STYLE['underline'][0], # Underline OFF SET_FONT(b'\x00'), # Default font TXT_STYLE['align']['left'], # Align left TXT_STYLE['invert'][True] # Inverted ON ) assert(instance.output == b''.join(expected_sequence))

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/env python """ Image tests- Check that images from different source formats are correctly converted to ESC/POS column & raster formats. :author: `Michael Billington <michael.billington@gmail.com>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `Michael Billington <michael.billington@gmail.com>`_ :license: MIT """ from escpos.image import EscposImage def test_image_black(): """ Test rendering solid black image """ for img_format in ['png', 'jpg', 'gif']: _load_and_check_img('canvas_black.' + img_format, 1, 1, b'\x80', [b'\x80']) def test_image_black_transparent(): """ Test rendering black/transparent image """ for img_format in ['png', 'gif']: _load_and_check_img('black_transparent.' + img_format, 2, 2, b'\xc0\x00', [b'\x80\x80']) def test_image_black_white(): """ Test rendering black/white image """ for img_format in ['png', 'jpg', 'gif']: _load_and_check_img('black_white.' + img_format, 2, 2, b'\xc0\x00', [b'\x80\x80']) def test_image_white(): """ Test rendering solid white image """ for img_format in ['png', 'jpg', 'gif']: _load_and_check_img('canvas_white.' + img_format, 1, 1, b'\x00', [b'\x00']) def test_split(): """ test whether the split-function works as expected """ im = EscposImage('test/resources/black_white.png') (upper_part, lower_part) = im.split(1) upper_part = EscposImage(upper_part) lower_part = EscposImage(lower_part) assert(upper_part.width == lower_part.width == 2) assert(upper_part.height == lower_part.height == 1) assert(upper_part.to_raster_format() == b'\xc0') assert(lower_part.to_raster_format() == b'\x00') def _load_and_check_img(filename, width_expected, height_expected, raster_format_expected, column_format_expected): """ Load an image, and test whether raster & column formatted output, sizes, etc match expectations. """ im = EscposImage('test/resources/' + filename) assert(im.width == width_expected) assert(im.height == height_expected) assert(im.to_raster_format() == raster_format_expected) i = 0 for row in im.to_column_format(False): assert(row == column_format_expected[i]) i += 1

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """tests for panel button function :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import escpos.printer as printer def test_function_panel_button_on(): """test the panel button function (enabling) by comparing output""" instance = printer.Dummy() instance.panel_buttons() assert(instance.output == b'\x1B\x63\x35\x00') def test_function_panel_button_off(): """test the panel button function (disabling) by comparing output""" instance = printer.Dummy() instance.panel_buttons(False) assert(instance.output == b'\x1B\x63\x35\x01')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

import six import escpos.printer as printer from escpos.constants import GS def test_cut_without_feed(): """Test cut without feeding paper""" instance = printer.Dummy() instance.cut(feed=False) expected = GS + b'V' + six.int2byte(66) + b'\x00' assert(instance.output == expected)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- """tests for the non-native part of qr() :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import pytest import mock from escpos.printer import Dummy from PIL import Image @mock.patch('escpos.printer.Dummy.image', spec=Dummy) def test_type_of_object_passed_to_image_function(img_function): """ Test the type of object that is passed to the image function during non-native qr-printing. The type should be PIL.Image """ d = Dummy() d.qr("LoremIpsum") args, kwargs = img_function.call_args assert isinstance(args[0], Image.Image) @pytest.fixture def instance(): return Dummy() def test_center(instance): instance.qr("LoremIpsum", center=True)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python import escpos.printer as printer import pytest @pytest.fixture def instance(): return printer.Dummy() def test_soft_barcode_ean8(instance): instance.soft_barcode("ean8", "1234") def test_soft_barcode_ean8_nocenter(instance): instance.soft_barcode("ean8", "1234", center=False)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python # -*- coding: utf-8 -*- """tests for the magic encode module :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import pytest from nose.tools import raises, assert_raises from hypothesis import given, example import hypothesis.strategies as st from escpos.magicencode import MagicEncode, Encoder from escpos.katakana import encode_katakana from escpos.exceptions import CharCodeError, Error class TestEncoder: """ Tests the single encoders. """ def test_can_encode(self): assert not Encoder({'CP437': 1}).can_encode('CP437', u'€') assert Encoder({'CP437': 1}).can_encode('CP437', u'á') assert not Encoder({'foobar': 1}).can_encode('foobar', 'a') def test_find_suitable_encoding(self): assert not Encoder({'CP437': 1}).find_suitable_encoding(u'€') assert Encoder({'CP858': 1}).find_suitable_encoding(u'€') == 'CP858' @raises(ValueError) def test_get_encoding(self): Encoder({}).get_encoding_name('latin1') class TestMagicEncode: """ Tests the magic encode functionality. """ class TestInit: """ Test initialization. """ def test_disabled_requires_encoding(self, driver): """ Test that disabled without encoder raises an error. :param driver: """ with pytest.raises(Error): MagicEncode(driver, disabled=True) class TestWriteWithEncoding: def test_init_from_none(self, driver): encode = MagicEncode(driver, encoding=None) encode.write_with_encoding('CP858', '€ ist teuro.') assert driver.output == b'\x1bt\x13\xd5 ist teuro.' def test_change_from_another(self, driver): encode = MagicEncode(driver, encoding='CP437') encode.write_with_encoding('CP858', '€ ist teuro.') assert driver.output == b'\x1bt\x13\xd5 ist teuro.' def test_no_change(self, driver): encode = MagicEncode(driver, encoding='CP858') encode.write_with_encoding('CP858', '€ ist teuro.') assert driver.output == b'\xd5 ist teuro.' class TestWrite: def test_write(self, driver): encode = MagicEncode(driver) encode.write('€ ist teuro.') assert driver.output == b'\x1bt\x0f\xa4 ist teuro.' def test_write_disabled(self, driver): encode = MagicEncode(driver, encoding='CP437', disabled=True) encode.write('€ ist teuro.') assert driver.output == b'? ist teuro.' def test_write_no_codepage(self, driver): encode = MagicEncode( driver, defaultsymbol="_", encoder=Encoder({'CP437': 1}), encoding='CP437') encode.write(u'€ ist teuro.') assert driver.output == b'_ ist teuro.' class TestForceEncoding: def test(self, driver): encode = MagicEncode(driver) encode.force_encoding('CP437') assert driver.output == b'\x1bt\x00' encode.write('€ ist teuro.') assert driver.output == b'\x1bt\x00? ist teuro.' try: import jaconv except ImportError: jaconv = None @pytest.mark.skipif(not jaconv, reason="jaconv not installed") class TestKatakana: @given(st.text()) @example("カタカナ") @example("あいうえお") @example("ﾊﾝｶｸｶﾀｶﾅ") def test_accept(self, text): encode_katakana(text) def test_result(self): assert encode_katakana('カタカナ') == b'\xb6\xc0\xb6\xc5' assert encode_katakana("あいうえお") == b'\xb1\xb2\xb3\xb4\xb5'

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """very basic test cases that load the classes :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import escpos.printer as printer def test_instantiation(): """test the instantiation of a escpos-printer class and basic printing""" instance = printer.Dummy() instance.text('This is a test\n')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python import escpos.printer as printer from escpos.capabilities import Profile, BARCODE_B from escpos.exceptions import BarcodeTypeError, BarcodeCodeError import pytest @pytest.mark.parametrize("bctype,data,expected", [ ('EAN13', '4006381333931', b'\x1ba\x01\x1dh@\x1dw\x03\x1df\x00\x1dH\x02\x1dk\x024006381333931\x00') ]) def test_barcode(bctype, data, expected): """should generate different barcode types correctly. """ instance = printer.Dummy() instance.barcode(data, bctype) assert instance.output == expected @pytest.mark.parametrize("bctype,supports_b", [ ('invalid', True), ('CODE128', False), ]) def test_lacks_support(bctype, supports_b): """should raise an error if the barcode type is not supported. """ profile = Profile(features={BARCODE_B: supports_b}) instance = printer.Dummy(profile=profile) with pytest.raises(BarcodeTypeError): instance.barcode('test', bctype) assert instance.output == b'' @pytest.mark.parametrize("bctype,data", [ ('EAN13', 'AA'), ('CODE128', '{D2354AA'), ]) def test_code_check(bctype, data): """should raise an error if the barcode code is invalid. """ instance = printer.Dummy() with pytest.raises(BarcodeCodeError): instance.barcode(data, bctype) assert instance.output == b''

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python 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])

python-escpos/python-escpos

535

Python

constants.rst

text/plain

from nose.tools import assert_raises from escpos.printer import Dummy def test_line_spacing_code_gen(): printer = Dummy() printer.line_spacing(10) assert printer.output == b'\x1b3\n' def test_line_spacing_rest(): printer = Dummy() printer.line_spacing() assert printer.output == b'\x1b2' def test_line_spacing_error_handling(): printer = Dummy() with assert_raises(ValueError): printer.line_spacing(99, divisor=44) with assert_raises(ValueError): printer.line_spacing(divisor=80, spacing=86) with assert_raises(ValueError): printer.line_spacing(divisor=360, spacing=256) with assert_raises(ValueError): printer.line_spacing(divisor=180, spacing=256)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """tests for line display :author: `Patrick Kanzler <patrick.kanzler@fablab.fau.de>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2017 `python-escpos <https://github.com/python-escpos>`_ :license: MIT """ import escpos.printer as printer def test_function_linedisplay_select_on(): """test the linedisplay_select function (activate)""" instance = printer.Dummy() instance.linedisplay_select(select_display=True) assert(instance.output == b'\x1B\x3D\x02') def test_function_linedisplay_select_off(): """test the linedisplay_select function (deactivate)""" instance = printer.Dummy() instance.linedisplay_select(select_display=False) assert(instance.output == b'\x1B\x3D\x01') def test_function_linedisplay_clear(): """test the linedisplay_clear function""" instance = printer.Dummy() instance.linedisplay_clear() assert(instance.output == b'\x1B\x40')

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/python """test native QR code printing :author: `Michael Billington <michael.billington@gmail.com>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `Michael Billington <michael.billington@gmail.com>`_ :license: MIT """ from nose.tools import raises import pytest import escpos.printer as printer from escpos.constants import QR_ECLEVEL_H, QR_MODEL_1 def test_defaults(): """Test QR code with defaults""" instance = printer.Dummy() instance.qr("1234", native=True) expected = b'\x1d(k\x04\x001A2\x00\x1d(k\x03\x001C\x03\x1d(k\x03\x001E0\x1d' \ b'(k\x07\x001P01234\x1d(k\x03\x001Q0' assert(instance.output == expected) def test_empty(): """Test QR printing blank code""" instance = printer.Dummy() instance.qr("", native=True) assert(instance.output == b'') def test_ec(): """Test QR error correction setting""" instance = printer.Dummy() instance.qr("1234", native=True, ec=QR_ECLEVEL_H) expected = b'\x1d(k\x04\x001A2\x00\x1d(k\x03\x001C\x03\x1d(k\x03\x001E3\x1d' \ b'(k\x07\x001P01234\x1d(k\x03\x001Q0' assert(instance.output == expected) def test_size(): """Test QR box size""" instance = printer.Dummy() instance.qr("1234", native=True, size=7) expected = b'\x1d(k\x04\x001A2\x00\x1d(k\x03\x001C\x07\x1d(k\x03\x001E0\x1d' \ b'(k\x07\x001P01234\x1d(k\x03\x001Q0' assert(instance.output == expected) def test_model(): """Test QR model""" instance = printer.Dummy() instance.qr("1234", native=True, model=QR_MODEL_1) expected = b'\x1d(k\x04\x001A1\x00\x1d(k\x03\x001C\x03\x1d(k\x03\x001E0\x1d' \ b'(k\x07\x001P01234\x1d(k\x03\x001Q0' assert(instance.output == expected) @raises(ValueError) def test_invalid_ec(): """Test invalid QR error correction""" instance = printer.Dummy() instance.qr("1234", native=True, ec=-1) @raises(ValueError) def test_invalid_size(): """Test invalid QR size""" instance = printer.Dummy() instance.qr("1234", native=True, size=0) @raises(ValueError) def test_invalid_model(): """Test invalid QR model""" instance = printer.Dummy() 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() instance.qr("1", native=False, size=1) print(instance.output) expected = b'\x1bt\x00\n' \ b'\x1dv0\x00\x03\x00\x17\x00\x00\x00\x00\x7f]\xfcA\x19\x04]it]et' \ b']ItA=\x04\x7fU\xfc\x00\x0c\x00y~t4\x7f =\xa84j\xd9\xf0\x05\xd4\x90\x00' \ b'i(\x7f<\xa8A \xd8]\'\xc4]y\xf8]E\x80Ar\x94\x7fR@\x00\x00\x00' \ b'\n\n' assert(instance.output == expected) @raises(ValueError) def test_image_invalid_model(): """Test unsupported QR model as image""" instance = printer.Dummy() instance.qr("1234", native=False, model=QR_MODEL_1) @pytest.fixture def instance(): return printer.Dummy() def test_center_not_implementer(instance): with pytest.raises(NotImplementedError): instance.qr("test", center=True, native=True)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/env python """ Image function tests- Check that image print commands are sent correctly. :author: `Michael Billington <michael.billington@gmail.com>`_ :organization: `python-escpos <https://github.com/python-escpos>`_ :copyright: Copyright (c) 2016 `Michael Billington <michael.billington@gmail.com>`_ :license: MIT """ import pytest from PIL import Image import escpos.printer as printer from escpos.exceptions import ImageWidthError # Raster format print def test_bit_image_black(): """ Test printing solid black bit image (raster) """ instance = printer.Dummy() instance.image('test/resources/canvas_black.png', impl="bitImageRaster") assert(instance.output == b'\x1dv0\x00\x01\x00\x01\x00\x80') # Same thing w/ object created on the fly, rather than a filename instance = printer.Dummy() im = Image.new("RGB", (1, 1), (0, 0, 0)) instance.image(im, impl="bitImageRaster") assert(instance.output == b'\x1dv0\x00\x01\x00\x01\x00\x80') def test_bit_image_white(): """ Test printing solid white bit image (raster) """ instance = printer.Dummy() instance.image('test/resources/canvas_white.png', impl="bitImageRaster") assert(instance.output == b'\x1dv0\x00\x01\x00\x01\x00\x00') def test_bit_image_both(): """ Test printing black/white bit image (raster) """ instance = printer.Dummy() instance.image('test/resources/black_white.png', impl="bitImageRaster") assert(instance.output == b'\x1dv0\x00\x01\x00\x02\x00\xc0\x00') def test_bit_image_transparent(): """ Test printing black/transparent bit image (raster) """ instance = printer.Dummy() instance.image('test/resources/black_transparent.png', impl="bitImageRaster") assert(instance.output == b'\x1dv0\x00\x01\x00\x02\x00\xc0\x00') # Column format print def test_bit_image_colfmt_black(): """ Test printing solid black bit image (column format) """ instance = printer.Dummy() instance.image('test/resources/canvas_black.png', impl="bitImageColumn") assert(instance.output == b'\x1b3\x10\x1b*!\x01\x00\x80\x00\x00\x0a\x1b2') def test_bit_image_colfmt_white(): """ Test printing solid white bit image (column format) """ instance = printer.Dummy() instance.image('test/resources/canvas_white.png', impl="bitImageColumn") assert(instance.output == b'\x1b3\x10\x1b*!\x01\x00\x00\x00\x00\x0a\x1b2') def test_bit_image_colfmt_both(): """ Test printing black/white bit image (column format) """ instance = printer.Dummy() instance.image('test/resources/black_white.png', impl="bitImageColumn") assert(instance.output == b'\x1b3\x10\x1b*!\x02\x00\x80\x00\x00\x80\x00\x00\x0a\x1b2') def test_bit_image_colfmt_transparent(): """ Test printing black/transparent bit image (column format) """ instance = printer.Dummy() instance.image('test/resources/black_transparent.png', impl="bitImageColumn") assert(instance.output == b'\x1b3\x10\x1b*!\x02\x00\x80\x00\x00\x80\x00\x00\x0a\x1b2') # Graphics print def test_graphics_black(): """ Test printing solid black graphics """ instance = printer.Dummy() instance.image('test/resources/canvas_black.png', impl="graphics") assert(instance.output == b'\x1d(L\x0b\x000p0\x01\x011\x01\x00\x01\x00\x80\x1d(L\x02\x0002') def test_graphics_white(): """ Test printing solid white graphics """ instance = printer.Dummy() instance.image('test/resources/canvas_white.png', impl="graphics") assert(instance.output == b'\x1d(L\x0b\x000p0\x01\x011\x01\x00\x01\x00\x00\x1d(L\x02\x0002') def test_graphics_both(): """ Test printing black/white graphics """ instance = printer.Dummy() instance.image('test/resources/black_white.png', impl="graphics") assert(instance.output == b'\x1d(L\x0c\x000p0\x01\x011\x02\x00\x02\x00\xc0\x00\x1d(L\x02\x0002') def test_graphics_transparent(): """ Test printing black/transparent graphics """ instance = printer.Dummy() instance.image('test/resources/black_transparent.png', impl="graphics") assert(instance.output == b'\x1d(L\x0c\x000p0\x01\x011\x02\x00\x02\x00\xc0\x00\x1d(L\x02\x0002') def test_large_graphics(): """ Test whether 'large' graphics that induce a fragmentation are handled correctly. """ instance = printer.Dummy() instance.image('test/resources/black_white.png', impl="bitImageRaster", fragment_height=1) assert(instance.output == b'\x1dv0\x00\x01\x00\x01\x00\xc0\x1dv0\x00\x01\x00\x01\x00\x00') @pytest.fixture def dummy_with_width(): instance = printer.Dummy() instance.profile.profile_data = { 'media': { 'width': { 'pixels': 384 } } } return instance def test_width_too_large(dummy_with_width): """ Test printing an image that is too large in width. """ instance = dummy_with_width with pytest.raises(ImageWidthError): instance.image(Image.new("RGB", (385, 200))) instance.image(Image.new("RGB", (384, 200))) def test_center_image(dummy_with_width): instance = dummy_with_width with pytest.raises(ImageWidthError): instance.image(Image.new("RGB", (385, 200)), center=True) instance.image(Image.new("RGB", (384, 200)), center=True)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

{ // 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 } } ] }

python-escpos/python-escpos

535

Python

constants.rst

text/plain

{ "restructuredtext.confPath": "${workspaceFolder}/doc", "files.watcherExclude": { "**/.git/objects/**": true, "**/.git/subtree-cache/**": true, "**/node_modules/*/**": true, "**/.eggs/**": true, "**/.hypothesis/**": true, "**/.tox/**": true, } }

python-escpos/python-escpos

535

Python

constants.rst

text/plain

@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^<target^>` where ^<target^> is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. xml to make Docutils-native XML files echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.https://sphinx-doc.org/ exit /b 1 ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-escpos.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-escpos.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %BUILDDIR%/xml. goto end ) if "%1" == "pseudoxml" ( %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. goto end ) :end

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# -*- coding: utf-8 -*- # # python-escpos documentation build configuration file, created by # sphinx-quickstart on Sat Dec 26 14:28:42 2015. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os on_rtd = os.getenv('READTHEDOCS') == 'True' if on_rtd: import escpos else: from setuptools_scm import get_version # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('../src')) root = os.path.relpath(os.path.join(os.path.dirname(__file__), '..')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.todo', 'sphinx.ext.graphviz', 'sphinx.ext.inheritance_diagram', 'sphinxcontrib.spelling', ] # supress warnings for external images suppress_warnings = [ 'image.nonlocal_uri', ] # enable todos todo_include_todos = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'python-escpos' copyright = u'2016, Manuel F Martinez and others' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # if on_rtd: # The full version, including alpha/beta/rc tags. release = escpos.__version__ else: # locally setuptools_scm should work release = get_version(root=root) # The short X.Y version. version = '.'.join(release.split('.')[:2]) # The short X.Y version. # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. if on_rtd: html_theme = 'default' else: try: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] except ImportError: print("no sphinx_rtd_theme found, switching to nature") html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. html_favicon = 'pyescpos.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'python-escposdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'python-escpos.tex', u'python-escpos Documentation', u'Manuel F Martinez and others', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'python-escpos', u'python-escpos Documentation', [u'Manuel F Martinez and others'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'python-escpos', u'python-escpos Documentation', u'Manuel F Martinez and others', 'python-escpos', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False # spellchecker spelling_ignore_pypi_package_names = True spelling_ignore_wiki_words = True spelling_ignore_python_builtins = True spelling_ignore_importable_modules = True

python-escpos/python-escpos

535

Python

constants.rst

text/plain

pyusb Pillow>=2.0 qrcode>=4.0 pyserial sphinx-rtd-theme setuptools setuptools-scm docutils>=0.12 sphinxcontrib-spelling>=5 python-barcode>=0.11.0,<1

python-escpos/python-escpos

535

Python

constants.rst

text/plain

.. python-escpos documentation master file, created by sphinx-quickstart on Sat Dec 26 14:28:42 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. .. include:: ../README.rst Content ------- .. toctree:: :maxdepth: 1 :caption: User Documentation user/installation user/methods user/printers user/raspi user/todo user/usage user/barcode .. toctree:: :maxdepth: 1 :caption: Developer Documentation dev/contributing dev/changelog .. toctree:: :maxdepth: 1 :caption: API Documentation api/escpos api/printer api/constants api/exceptions api/capabilities api/config api/image api/cli api/magicencode api/codepages api/katakana Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/bin/sh GENLIST=$(git shortlog -s -n | cut -f2 | sort -f) GENLIST_W_MAIL=$(git shortlog -s -e -n | cut -f2 | sort -f) AUTHORSFILE="$(dirname $0)/../AUTHORS" TEMPAUTHORSFILE="/tmp/python-escpos-authorsfile" if [ "$#" -eq 1 ] then echo "$GENLIST">$TEMPAUTHORSFILE echo "\nAuthorsfile in version control:\n" cat $AUTHORSFILE echo "\nNew authorsfile:\n" cat $TEMPAUTHORSFILE echo "\nUsing diff on files...\n" diff --suppress-common-lines -b --from-file $AUTHORSFILE $TEMPAUTHORSFILE echo "Authors with mail addresses:\n" echo "$GENLIST_W_MAIL" else echo "$GENLIST">$AUTHORSFILE fi

python-escpos/python-escpos

535

Python

constants.rst

text/plain

# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext spelling help: @echo "Please use \`make <target>' where <target> is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" @echo " spelling to run the spellchecker" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-escpos.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-escpos.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/python-escpos" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-escpos" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." spelling: $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling @echo @echo "Spellchecker finished."

python-escpos/python-escpos

535

Python

constants.rst

text/plain

******** Printers ******** :Last Reviewed: 2017-01-25 As of now there are 5 different type of printer implementations. USB --- The USB-class uses pyusb and libusb to communicate with USB-based printers. Note that this driver is not suited for USB-to-Serial-adapters and similiar devices, but only for those implementing native USB. .. autoclass:: escpos.printer.Usb :members: :special-members: :member-order: bysource :noindex: Serial ------ This driver uses pyserial in order to communicate with serial devices. If you are using an USB-based adapter to connect to the serial port, then you should also use this driver. The configuration is often based on DIP-switches that you can set on your printer. For the hardware-configuration please refer to your printer's manual. .. autoclass:: escpos.printer.Serial :members: :special-members: :member-order: bysource :noindex: Network ------- This driver is based on the socket class. .. autoclass:: escpos.printer.Network :members: :special-members: :member-order: bysource :noindex: Troubleshooting ^^^^^^^^^^^^^^^ Problems with a network-attached printer can have numerous causes. Make sure that your device has a proper IP address. Often you can check the IP address by triggering the self-test of the device. As a next step try to send text manually to the device. You could use for example: :: echo "OK\n" | nc IPADDRESS 9100 # the port number is often 9100 As a last resort try to reset the interface of the printer. This should be described in its manual. File ---- This printer "prints" just into a file-handle. Especially on \*nix-systems this comes very handy. .. autoclass:: escpos.printer.File :members: :special-members: :member-order: bysource :noindex: Dummy ----- The Dummy-printer is mainly for testing- and debugging-purposes. It stores all of the "output" as raw ESC/POS in a string and returns that. .. autoclass:: escpos.printer.Dummy :members: :member-order: bysource :noindex:

python-escpos/python-escpos

535

Python

constants.rst

text/plain

******* Methods ******* :Last Reviewed: 2017-01-25 Escpos class ------------ The core part of this libraries API is the Escpos class. You use it by instantiating a :doc:`printer <printers>` which is a child of Escpos. The following methods are available: .. autoclass:: escpos.escpos.Escpos :members: :member-order: bysource :noindex:

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Printing Barcodes ----------------- :Last Reviewed: 2016-07-31 Most ESC/POS-printers implement barcode-printing. The barcode-commandset is implemented in the barcode-method. For a list of compatible barcodes you should check the manual of your printer. As a rule of thumb: even older Epson-models support most 1D-barcodes. To be sure just try some implementations and have a look at the notices below. barcode-method ~~~~~~~~~~~~~~ The barcode-method is rather low-level and orients itself on the implementation of ESC/POS. In the future this class could be supplemented by a high-level class that helps the user generating the payload. .. py:currentmodule:: escpos.escpos .. automethod:: Escpos.barcode :noindex: CODE128 ~~~~~~~ Code128 barcodes need a certain format. For now the user has to make sure that the payload is correct. For alphanumeric CODE128 you have to preface your payload with `{B`. .. code-block:: Python from escpos.printer import Dummy, Serial p = Serial() # print CODE128 012ABCDabcd p.barcode("{B012ABCDabcd", "CODE128", function_type="B") A very good description on CODE128 is also on `Wikipedia <https://en.wikipedia.org/wiki/Code_128>`_.

python-escpos/python-escpos

535

Python

constants.rst

text/plain

************ Installation ************ :Last Reviewed: 2016-07-23 Installation with PIP --------------------- Installation should be rather straight-forward. python-escpos is on PyPi, so you can simply enter: :: pip install python-escpos This should install all necessary dependencies. Apart from that python-escpos should also be available as a Debian package. If you want to always benefit from the newest stable releases you should probably install from PyPi. Setup udev for USB-Printers --------------------------- 1. Get the *Product ID* and *Vendor ID* from the lsusb command ``# lsusb Bus 002 Device 001: ID 1a2b:1a2b Device name`` 2. Create a udev rule to let users belonging to *dialout* group use the printer. You can create the file ``/etc/udev/rules.d/99-escpos.rules`` and add the following: ``SUBSYSTEM=="usb", ATTRS{idVendor}=="1a2b", ATTRS{idProduct}=="1a2b", MODE="0664", GROUP="dialout"`` Replace *idVendor* and *idProduct* hex numbers with the ones that you got from the previous step. Note that you can either, add yourself to "dialout" group, or use another group you already belongs instead "dialout" and set it in the ``GROUP`` parameter in the above rule. 3. Restart udev ``# sudo service udev restart`` In some new systems it is done with ``# sudo udevadm control --reload`` Enabling tab-completion in CLI ------------------------------ python-escpos has a CLI with tab-completion. This is realised with ``argcomplete``. In order for this to work you have to enable tab-completion, which is described in the `manual of argcomplete <https://argcomplete.readthedocs.io>`__. If you only want to enable it for python-escpos, or global activation does not work, try this: :: eval "$(register-python-argcomplete python-escpos)"

python-escpos/python-escpos

535

Python

constants.rst

text/plain

**** TODO **** 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 ~~~~~~~~~~~~~~~~~~~~~ .. todolist::

python-escpos/python-escpos

535

Python

constants.rst

text/plain

************ Raspberry Pi ************ :Last Reviewed: 2017-01-05 This instructions were tested on Raspbian Jessie. .. warning:: You should **never** directly connect an printer with RS232-interface (serial port) directly to a Raspberry PI or similar interface (e.g. those simple USB-sticks without encasing). Those interfaces are based on 5V- or 3,3V-logic (the latter in the case of Raspberry PI). Classical RS232 uses 12V-logic and would **thus destroy your interface**. Connect both systems with an appropriate *level shifter*. Dependencies ------------ First, install the packages available on Raspbian. :: sudo apt-get install python3 python3-setuptools python3-pip libjpeg8-dev Installation ------------ You can install by using pip3. :: sudo pip3 install --upgrade pip sudo pip3 install python-escpos Run --- You need sudo and python3 to run your program. :: sudo python3 your-program.py Now you can attach your printer and and test it with the example code in the project's set of examples. You can find that in the `project-repository <https://github.com/python-escpos/python-escpos>`__. For more details on this check the :doc:`installation-manual <installation>`.

python-escpos/python-escpos

535

Python

constants.rst

text/plain

***** Usage ***** :Last Reviewed: 2017-06-10 Define your printer ------------------- USB printer ^^^^^^^^^^^ Before creating your Python ESC/POS printer instance, consult the system to obtain the printer parameters. This is done with the 'lsusb' command. Run the command and look for the "Vendor ID" and "Product ID" and write down the values. These values are displayed just before the name of the device with the following format: :: xxxx:xxxx Example: :: # lsusb Bus 002 Device 001: ID 04b8:0202 Epson ... Write down the the values in question, then issue the following command so you can get the "Interface" number and "End Point" :: # lsusb -vvv -d xxxx:xxxx | grep iInterface iInterface 0 # lsusb -vvv -d xxxx:xxxx | grep bEndpointAddress | grep OUT bEndpointAddress 0x01 EP 1 OUT The first command will yield the "Interface" number that must be handy to have and the second yields the "Output Endpoint" address. **USB Printer initialization** :: 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, 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** :: p = printer.Usb(0x2730, 0x0fff, 0, 0x81, 0x02) Network printer ^^^^^^^^^^^^^^^ You only need the IP of your printer, either because it is getting its IP by DHCP or you set it manually. **Network Printer initialization** :: p = printer.Network("192.168.1.99") Serial printer ^^^^^^^^^^^^^^ Most of the default values set by the DIP switches for the serial printers, have been set as default on the serial printer class, so the only thing you need to know is which serial port the printer is connected to. **Serial printer initialization** :: p = printer.Serial("/dev/tty0") # on a Windows OS serial devices are typically accessible as COM p = printer.Serial("COM1") Other printers ^^^^^^^^^^^^^^ Some printers under `/dev` can't be used or initialized with any of the methods described above. Usually, those are printers used by printcap, however, if you know the device name, you could try to initialize by passing the device node name. :: 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. Define your instance -------------------- The following example demonstrates how to initialize the Epson TM-TI88IV on a USB interface. :: from escpos import * """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """ p = printer.Usb(0x04b8,0x0202) # Print text p.text("Hello World\n") # Print image p.image("logo.gif") # Print QR Code p.qr("You can readme from your smartphone") # Print barcode p.barcode('1324354657687','EAN13',64,2,'','') # Cut paper p.cut() Configuration File ------------------ You can create a configuration file for python-escpos. This will allow you to use the CLI, and skip some setup when using the library programmatically. The default configuration file is named ``config.yaml`` and uses the YAML format. For windows it is probably at:: %appdata%/python-escpos/config.yaml And for linux:: $HOME/.config/python-escpos/config.yaml If you aren't sure, run:: from escpos import config c = config.Config() c.load() If it can't find the configuration file in the default location, it will tell you where it's looking. You can always pass a path, or a list of paths, to the ``load()`` method. To load the configured printer, run:: from escpos import config c = config.Config() printer = c.printer() The printer section ^^^^^^^^^^^^^^^^^^^ The ``printer`` configuration section defines a default printer to create. The only required parameter is ``type``. The value of this has to be one of the printers defined in :doc:`/user/printers`. The rest of the given parameters will be passed on to the initialization of the printer class. Use these to overwrite the default values as specified in :doc:`/user/printers`. This implies that the parameters have to match the parameter-names of the respective printer class. An example file printer:: printer: type: File devfile: /dev/someprinter And for a network printer:: printer: type: Network host: 127.0.0.1 port: 9000 An USB-printer could be defined by:: printer: type: Usb idVendor: 0x1234 idProduct: 0x5678 in_ep: 0x66 out_ep: 0x01 Printing text right ------------------- Python-escpos is designed to accept unicode. For normal usage you can simply pass your text to the printers ``text()``-function. It will automatically guess the right codepage and then send the encoded data to the printer. If this feature does not work, please try to isolate the error and then create an issue on the GitHub project page. If you want or need to you can manually set the codepage. For this please use the ``charcode()``-function. You can set any key-value that is in ``CHARCODE``. If something is wrong, an ``CharCodeError`` will be raised. After you have manually set the codepage the printer won't change it anymore. You can revert to normal behaviour by setting charcode to ``AUTO``. Advanced Usage: Print from binary blob -------------------------------------- Imagine you have a file with ESC/POS-commands in binary form. This could be useful for testing capabilities of your printer with a known working combination of commands. You can print this data with the following code, using the standard methods of python-escpos. (This is an advantage of the fact that `_raw()` accepts binary strings.) :: from escpos import printer p = printer.Serial() # adapt this to your printer model file = open("binary-blob.bin", "rb") # read in the file containing your commands in binary-mode data = file.read() file.close() p._raw(data) That's all, the printer should then print your data. You can also use this technique to let others reproduce an issue that you have found. (Just "print" your commands to a File-printer on your local filesystem.) However, please keep in mind, that often it is easier and better to just supply the code that you are using. Here you can download an example, that will print a set of common barcodes: * :download:`barcode.bin </download/barcode.bin>` by `@mike42 <https://github.com/mike42>`_ Advanced Usage: change capabilities-profile ------------------------------------------- Packaged together with the escpos-code is a capabilities-file. This file in JSON-format describes the capabilities of different printers. It is developed and hosted in `escpos-printer-db <https://github.com/receipt-print-hq/escpos-printer-db>`_. Certain applications like the usage of `cx_freeze <https://cx-freeze.readthedocs.io>`_ might change the packaging structure. This leads to the capabilities-profile not being found. In this case you can use the environment-variable `ESCPOS_CAPABILITIES_FILE`. The following code is an example. .. code-block:: shell # use packaged capabilities-profile python-escpos cut # use capabilities-profile that you have put in /usr/python-escpos export ESCPOS_CAPABILITIES_FILE=/usr/python-escpos/capabilities.json python-escpos cut # use packaged file again unset ESCPOS_CAPABILITIES_FILE python-escpos cut Hint: preprocess printing ------------------------- Printing images directly to the printer is rather slow. One factor that slows down the process is the transmission over e.g. serial port. Apart from configuring your printer to use the maximum baudrate (in the case of serial-printers), there is not much that you can do. However you could use the :py:class:`escpos.printer.Dummy`-printer to preprocess your image. This is probably best explained by an example: .. code-block:: Python from escpos.printer import Serial, Dummy p = Serial() d = Dummy() # create ESC/POS for the print job, this should go really fast d.text("This is my image:\n") d.image("funny_cat.png") d.cut() # send code to printer p._raw(d.output) This way you could also store the code in a file and print it later. You could then for example print the code from another process than your main-program and thus reduce the waiting time. (Of course this will not make the printer print faster.)

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Config ------ Module :py:mod:`escpos.config` .. automodule:: escpos.config :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Capabilities ------------ Module :py:mod:`escpos.capabilities` .. automodule:: escpos.capabilities :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Esc/Pos ------- Module :py:mod:`escpos.escpos` .. automodule:: escpos.escpos :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Exceptions ---------- Module :py:mod:`escpos.exceptions` .. automodule:: escpos.exceptions :members: :inherited-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

CLI --- Module :py:mod:`escpos.cli` .. automodule:: escpos.cli :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Katakana -------- Module :py:mod:`escpos.katakana` .. automodule:: escpos.katakana :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Printer implementations ----------------------- Module :py:mod:`escpos.printer` .. automodule:: escpos.printer :members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Codepages --------- Module :py:mod:`escpos.codepages` .. automodule:: escpos.codepages :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Image helper ------------ Module :py:mod:`escpos.image` .. automodule:: escpos.image :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Magic Encode ------------ Module :py:mod:`escpos.magicencode` .. automodule:: escpos.magicencode :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

Constants --------- Module :py:mod:`escpos.constants` .. automodule:: escpos.constants :members: :inherited-members: :undoc-members: :show-inheritance: :member-order: bysource

python-escpos/python-escpos

535

Python

constants.rst

text/plain

#!/usr/bin/env bash function cp_site(){ f=$1 echo preparing $f cp -ar ./$f/target/site ./target/site/$f } copyTo=$1 if [ X"$copyTo" = "X" ]; then echo copy target is not specified. exit 1 fi mvn clean site javadoc:aggregate-jar if [ $? -ne 0 ]; then exit 1 fi cp_site asta4d-core cp_site asta4d-web cp_site asta4d-spring cp_site asta4d-sample cp_site asta4d-doc cp_site asta4d-archetype cp_site asta4d-archetype-prototype version=`cat currentVersion` copyTo=$copyTo/$version mkdir $copyTo echo copying files to $copyTo echo copying whole site cp -ar ./target/site $copyTo echo copying java doc cp -ar ./target/apidocs $copyTo echo copying user guide cp -ar ./asta4d-doc/target/docbkx ./asta4d-doc/target/userguide mv ./asta4d-doc/target/userguide/pdf/index.pdf ./asta4d-doc/target/userguide/pdf/userguide.$version.pdf cp -ar ./asta4d-doc/target/userguide $copyTo cp userguide_index.html $copyTo/userguide/index.html sed -i "s/@version/$version/g" $copyTo/userguide/index.html echo copying page_index cp page_index.html $copyTo/index.html sed -i "s/@version/$version/g" $copyTo/index.html

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.sonatype.oss</groupId> <artifactId>oss-parent</artifactId> <version>7</version> </parent> <groupId>com.astamuse</groupId> <artifactId>asta4d</artifactId> <version>1.2.1-SNAPSHOT</version> <packaging>pom</packaging> <name>asta4d framework</name> <description>asta4d framework is a view first web framework</description> <url>http://github.com/astamuse/asta4d</url> <licenses> <license> <name>The Apache Software License, Version 2.0</name> <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> <distribution>repo</distribution> </license> </licenses> <scm> <url>git@github.com:astamuse/asta4d.git</url> <connection>scm:git:git@github.com:astamuse/asta4d.git</connection> <developerConnection>scm:git:git@github.com:astamuse/asta4d.git</developerConnection> </scm> <developers> <developer> <id>e.ryu</id> <name>Rui Liu</name> </developer> <developer> <id>s.otani</id> <name>Shunsuke Otani</name> </developer> <developer> <id>t.ishima</id> <name>Takayuki Ishima</name> </developer> </developers> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <prjDocRoot>./asta4d-doc</prjDocRoot> </properties> <modules> <module>asta4d-core</module> <module>asta4d-web</module> <module>asta4d-spring</module> <module>asta4d-sample</module> <module>asta4d-archetype-prototype</module> <module>asta4d-archetype</module> <module>asta4d-doc</module> </modules> <dependencies> <dependency> <groupId>org.testng</groupId> <artifactId>testng</artifactId> <version>6.1.1</version> <scope>test</scope> </dependency> <!-- logback --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.0.6</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.3</version> <configuration> <source>1.8</source> <target>1.8</target> <compilerArgs> <arg>-parameters</arg> </compilerArgs> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.4</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <locale>en_US</locale> <excludePackageNames>com.astamuse.asta4d.sample;org.jsoup.parser;</excludePackageNames> <additionalparam>-Xdoclint:none</additionalparam> </configuration> <version>2.9</version> <executions> <execution> <id>create-java-doc-site</id> <phase>site</phase> <goals> <goal>jar</goal> </goals> </execution> <execution> <id>create-java-doc-package</id> <phase>package</phase> <goals> <goal>jar</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-source-plugin</artifactId> <version>2.2.1</version> <executions> <execution> <id>attach-sources</id> <phase>verify</phase> <goals> <goal>jar-no-fork</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-gpg-plugin</artifactId> <version>1.4</version> <executions> <execution> <id>sign-artifacts</id> <phase>verify</phase> <goals> <goal>sign</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>versions-maven-plugin</artifactId> <version>2.0</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.8</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.7</version> <dependencies> <dependency> <groupId>org.ow2.asm</groupId> <artifactId>asm</artifactId> <version>5.0.4</version> </dependency> </dependencies> </plugin> </plugins> </build> <reporting> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.7</version> <reportSets> <reportSet> <id>cobertura</id> <reports> <report>cobertura</report> </reports> <configuration> <aggregate>true</aggregate> </configuration> </reportSet> </reportSets> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-report-plugin</artifactId> <version>2.18.1</version> <reportSets> <reportSet> <id>surefire-report</id> <reports> <report>report-only</report> </reports> <configuration> <aggregate>true</aggregate> </configuration> </reportSet> </reportSets> </plugin> </plugins> </reporting> </project>

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

<html> <head> <meta charset="utf-8" /> </head> <body> <h1>Asta4D @version</h1> <hr> <ul> <li><a href="userguide/index.html">User Guide</a> <li><a href="apidocs/index.html">API Doc</a> <li><a href="site/index.html">Project Information</a> <li><a href="../all_versions.html">Other versions</a> </ul> </body> </html>

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

#!/usr/bin/env bash version=1.1-b1 copyTo=../asta4d-github-page/1.1-b1 cp userguide_index.html $copyTo/userguide/index.html cp page_index.html $copyTo/index.html sed "s/@version/$version/g" $copyTo/userguide/index.html sed "s/@version/$version/g" $copyTo/index.html

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

<html> <head> <meta charset="utf-8" /> </head> <body> <h1>Asta4D @version User Guide</h1> <hr> <ul> <li><a href="./html/index.html">HTML</a> <li><a href="./html-singlepage/index.html">Single Page HTML</a> <li><a href="./pdf/userguide.@version.pdf">PDF</a> </ul> </body> </html>

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

#!/usr/bin/env bash set -e # Base directory for this entire project BASEDIR=$(cd $(dirname $0) && pwd) mvn test -DskipTests=true -Pjetty-run

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

## News - 2016-11-17, 1.2-M2 is released. - 2016-04-13, 1.2-M1 with some essential enhancements is released. - 2016-01-22, [asta4d-ide](https://github.com/astamuse/asta4d-ide) is release to accelerate our development with asta4d. - 2015-12-25, 1.1 official release "1.1-Xmas" is released. - 2015-12-17, the scala extension for asta4d [asta4d-scala](https://github.com/astamuse/asta4d-scala) is released. - 2015-10-27, the 1.1-b3 with minor bug fixes is released. - 2015-09-07, the 1.1-b2 with minor bug fixes is released. - 2015-07-23, the 1.1-b1 with better Java 8 support is released. - 2015-02-14, the first official release "1.0-Valentines" is released at the Valentine's day! ## Quick start **NOTE: There are some breaking changes related to form flow and url initialization in the recent release of 1.2-M1. The user guide will be modified in the next release, thus there may be some unmatched contents in the document if you use the newest 1.2-M1 instead of the previous stable version 1.1-Xmas.** [documents](http://astamuse.github.io/asta4d/1.1-Xmas/) [Online Sample](http://asta4dsample-xzer.rhcloud.com/) There is a maven archetype for asta4d. If you want to start with the archetype, you have to [install Maven 3](http://maven.apache.org/download.cgi) at first. After installed Maven 3, create the sample project by the following command: ```batch mvn archetype:generate \ -DarchetypeGroupId=com.astamuse \ -DarchetypeArtifactId=asta4d-archetype \ -DarchetypeVersion=1.1-Xmas \ -DgroupId=<your.groupid> \ -DartifactId=<your-artifactId> ``` or simply follow the wizard by filtered list: ```batch mvn archetype:generate -DarchetypeGroupId=com.astamuse -DarchetypeArtifactId=asta4d-archetype -DarchetypeVersion=1.1-Xmas ``` *The 1.1-Xmas with better Java 8 support is recommended for new projects, if you cannot use Java 8, use 1.0-Valentines instead.* After the archetype is created, enter the folder which has a "pom.xml" file, run the following command: ```batch mvn jetty:run ``` Then you can access the sample project by http://localhost:8080, there are source samples shown, it is a good start from reading the samples. After you confirm the sample project is OK, you can add your own url mapping rules to /src/main/java/.../.../UrlRules.java, and also you can add your own html template files to /src/main/webapp. Reading the [Best Practice](http://astamuse.github.io/asta4d/1.1-Xmas/userguide/index.html#chapter-best-practice) before writing your own code is recommended. ## What is Asta4D Asta4D is a view first web application framework which is friendly to designers and flexible to developers. Asta4D affords high productivity than traditional MVC architecture by "View First" architecture. It also allows front-end engineers and back-end engineers work independently without interference by separating rendering logic from template files. Asta4D is inspired by [lift](http://liftweb.net/) which is a famous scala web application framework and it is developed by astamuse company Ltd. locating at Tokyo Japan. We are concentrating on global innovation support and developing Asta4D for our own services. Currently, Asta4D is driving our new service development. ## Why Asta4D In the past decade, plenty of Java based web application frameworks are generated. Especially the MVC architecture and JSP tag libs (or other traditional template technologies) that has greatly released our productivity. But unfortunately, we are still suffering from the following situations: 1. The designers or front-end engineers are keeping complaining the mixed-in dynamic code, as they disturb their efforts of redesigning the page style or structure. And in the mean time, the back-end developers are also complaining that the front-end guys break the working page frequently, because redesign or the new design is hard to merge due to the huge cost of source refactoring. 1. The developers are complaining about the poor functionalities of template language which they are using and tired from the various magic skills for complex rendering logic. 1. The developers are discontented with the counterproductivity of MVC architecture and desire a more efficient approach. Thus, we created Asta4D. Currently, Asta4D is driving our service site:[astamuse.com](http://astamuse.com) ## What does "Asta4D" mean The name of Asta4D is from our company's name: astamuse. We explain the "4D" as following ways: 1. For designers Asta4D consider the design friendliness as the most important factor of itself. We hope web designers can fulfil their maximum potential of creativity without squandering their time on the back-end technologies which they could never be adept at. 1. For developers We hope Asta4D can help developers to achieve their work more easily. Developers would never be afflicted with complex rendering logic because they can use powerful Java language to do whatever they want since the rendering has been split from template files. View first also releases developers from the cumbersome MVC architecture, now they have more time to have a cup of coffee. 1. 4 dimension We believe that Asta4D can act as a wormhole that connects the front-end and the back-end. We can move quicker by Asta4D just like we are going through the 4 dimensional space. ## How Asta4D helps us Asta4D is our solution to combat those issues. Thanks to lift, from where we learn a lot. We designed Asta4D complying with the following points: 1. Separate template and rendering logic Asta4D affords front-end engineers a friendly environment by separating rendering logic from template files which are pure html files. At the mean time, back-end engineers can use the powerful Java language to implement the rendering logic without being suffering from the "poor and sometimes magic" template languages. There is no dynamic code in template file. An Asta4D template file is always a pure HTML file which can be easily maintained by front-end developers, it is very design friendly and we can reduce the workload for source refactoring by over 90%. ```html <section> <article> <div afd:render="SimpleSnippet">dummy text</div> <afd:snippet render="SimpleSnippet:setProfile"> <p id="name">name:<span>dummy name</span></p> <p id="age">age:<span>0</span></p> </afd:snippet> </article> </section> ``` In the snippet class, we use traditional CSS selector to reference rendering target, amazing and powerful. ```java public class SimpleSnippet { public Renderer render(String name) { if (StringUtils.isEmpty(name)) { name = "Asta4D"; } return Renderer.create("div", name); } public Renderer setProfile() { Renderer render = Renderer.create(); render.add("p#name span", "asta4d"); render.add("p#age span", 20); return render; } } ``` 1. Testable Rendering logic All of the rendering logic of Asta4D is testable and you can simply test them by write simple junit cases, which can replace over than half of selenium tests. ```java // prepare test target Renderer render = Renderer.create(); render.add("#someIdForInt", 12345); // perform test RendererTester tester = RendererTester.forRenderer(render); Assert.assertEquals(tester.get("#someIdForInt"), 12345); ``` Rendering for list data can be performed as well ```java // prepare test target Renderer render = Renderer.create(); render.add("#someIdForInt", Arrays.asList(123, 456, 789)); // perform test RendererTester tester = RendererTester.forRenderer(render); Assert.assertEquals(tester.getAsList("#someIdForInt"), Arrays.asList(123, 456, 789)); ``` [Further samples for test](https://github.com/astamuse/asta4d/blob/develop/asta4d-core/src/test/java/com/astamuse/asta4d/test/unit/RenderTesterTest.java) 1. High security of being immune from cross-site(XSS/CSRF) Asta4D is, by nature, immune from cross-site(XSS/CSRF) problems. You do not need to take care of cross-site any more. All the rendered value would be escaped by default and your clients have no chance to put malicious contents to your server. 1. View first Asta4D also affords higher productivity than traditional MVC architecture by View First mechanism. And it is also easier to change than MVC architecture. A controller is not necessary for request dispatch. All the requests cound be dispatched by a sort of predefined URL matching rules and could be forwarded to template files directly, which is called as view first. ```java rules.add("/app/", "/templates/index.html"); ``` 1. Isolate side effect with request handler Asta4D imports the conception of "side-effect" from functional programming languages and separating the "side-effect" by request handlers, which afford more flexibility on page rendering because the view layer is side-effect free now. Therefore Asta4D allows parallel page rendering in multiple threads as a built-in feature. [See details about side effect](http://astamuse.github.io/asta4d/userguide/#chapter-side-effect) 1. Advanced MVC Asta4D also affords a evolved MVC architecture which is more clarified for the duty of each application layer than the traditional MVC architecture. By traditional MVC architecture, we often have to expand the transaction from the controller layer across to the view layer to combat the lazy load issue, which ugly structure is essentially caused by the tangled controller which holds various unrelated duties. It is also strange that we have to modify our controller's implementation at every time we change the page appearance at view layer. Such situation could not satisfy us since the layers are not uncoupled really. We would say that the traditional controller is indeed a tangled magic container for most logics, a controller will unfortunately be coupled to most layers in the system even our initial purpose of MVC is to uncouple our logics. By contrast, Asta4D allows developers to really uncouple all the tangled logics easily. Basically we could split the traditional controller's duty to following parts: - request handler Which takes the responsibilities of all the operations with side-effect. - result matching in url rule Which dispatches the request to different views according to the result from request handler - snippet class Which has the responsibility to render data to the page and also holds the obligation of preparing all the necessary data for page rendering. By above architecture, we could perfectly uncouple our logics by clarifying the obligation of each layer. 1. Built-in form flow mechanism Asta4D treat all the form processes as flow and afford a well defined architecture for various form processes. Asta4D gives developers the possibility of concentrating on their real business logics rather than technic issues. Basically, developers only need to implement an init method and an update method for a form process. ```java public class SingleInputFormHandler extends OneStepFormHandler<PersonForm> { @Override protected PersonForm createInitForm() throws Exception { ... } @Override protected void updateForm(PersonForm form) { ... } } ``` ## Roadmap - 1.1.x (maintainance) bugfix - 1.2 (developing) no plain yet ## LICENSE Apache License, Version 2.0 Copyright 2012 astamuse company,Ltd. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

<?xml version="1.0" encoding="UTF-8" standalone="no"?> <profiles version="12"> <profile kind="CodeFormatterProfile" name="astamuse" version="12"> <setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.disabling_tag" value="@formatter:off"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.new_lines_at_block_boundaries" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_annotation_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_field" value="0"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.use_on_off_tags" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_ellipsis" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_multiple_fields" value="16"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer" value="16"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="80"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_binary_operator" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_array_initializer" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.continuation_indentation" value="2"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_binary_operator" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_package" value="0"/> <setting id="org.eclipse.jdt.core.compiler.source" value="1.7"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_member_type" value="1"/> <setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_unary_operator" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_type_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.lineSplit" value="140"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration" value="0"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.enabling_tag" value="@formatter:on"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="0"/> <setting id="org.eclipse.jdt.core.compiler.problem.assertIdentifier" value="error"/> <setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_body" value="true"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_method" value="1"/> <setting id="org.eclipse.jdt.core.formatter.wrap_outer_expressions_when_nested" value="true"/> <setting id="org.eclipse.jdt.core.formatter.format_guardian_clause_on_one_line" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_method_body" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_method_declaration" value="0"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_try" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_try" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.compiler.problem.enumIdentifier" value="error"/> <setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_ellipsis" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_block" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.compact_else_if" value="true"/> <setting id="org.eclipse.jdt.core.formatter.wrap_before_or_operator_multicatch" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.format_line_comment_starting_on_first_column" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="true"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_constant" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_union_type_in_multicatch" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_constant" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment" value="false"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_empty_lines" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter" value="insert"/> <setting id="org.eclipse.jdt.core.compiler.compliance" value="1.7"/> <setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_unary_operator" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_binary_expression" value="16"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while" value="do not insert"/> <setting id="org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode" value="enabled"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_try" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_label" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="16"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/> <setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="140"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_between_import_groups" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body" value="0"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.wrap_before_binary_operator" value="false"/> <setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header" value="true"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_block" value="true"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.join_lines_in_comments" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_if" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_before_imports" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="true"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_anonymous_type_declaration" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_source_code" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="16"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer" value="insert"/> <setting id="org.eclipse.jdt.core.compiler.codegen.targetPlatform" value="1.7"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_resources_in_try" value="80"/> <setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="true"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation" value="0"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="false"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="0"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_block" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration" value="end_of_line"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries" value="true"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_after_imports" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header" value="true"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_try_resources" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column" value="false"/> <setting id="org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line" value="false"/> </profile> </profiles>

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

#!/bin/bash fixVer=$1 if [ "fixVer"X = ""X ] then cmd=`BASENAME $0` echo $cmd \<release/dev\> \<new version\> exit 2 else BASEDIR=$(cd $(dirname $0) && pwd) cd $BASEDIR echo $fixVer > currentVersion mvn versions:set -DnewVersion=$fixVer cd asta4d-archetype-prototype mvn versions:set -DnewVersion=$fixVer fi

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

## Release Notes - 1.2-M2 (2016.11.17) There are some breaking changes related to form flow and url initialization. The user guide will be modified in the next release, thus there may be some unmatched contents in the document. ADD - new RowRenderer for convenience of Function<?, Renderer> (removed old RowRenderer) - shutdown hooker mechanism to handle shutdown logic ideally - snippet annotation to simplify use asta4d snippet with spring autowire mechanism FIX - FormFlowTraceData should be Serializable - inject trace data should be Serializable REMOVE - RowRenderer and ParallelRowRenderer (BREAKING) ENHANCE - better parallel converting implementation(without blocking on dispatch, reduce cross thread lock) - make DefaultSessionAwareExpirableDataManager more eazy to extend - better spring mvc integration support - new body only template file mechanism (now support template file without body tag) - faster id generator implementation(use base64 instead of string join) - 1.2-M1 (2016.04.14) There are some breaking changes related to form flow and url initialization. The user guide will be modified in the next release, thus there may be some unmatched contents in the document. ADD - add pathVar method to HandyRule to avoid literal name conflict in scala (var is the reversed word of scala) - add cache support to AnnotatedPropertyUtil which makes injection and form process x times faster than before - add sitecategory/SiteCategoryAwaredPathConvertor to make site category awared mechanism more easy to extend FIX - missing resource files in java source folder for package - initialization should respect the item order in configuration file - cache issue in AbstractTemplateResolver at debug mode(when cache disabled) - static resource files are not responded correctly when cache size limit is set. ENHANCE - more flexible built-in multiple input steps form flow - allow more eazily to extend the built-in handy rule DSL(also renamed UrlRuleMappingHelper to UrlRuleSet). - 1.1-Xmas (2015.12.25) ADD - support of http methods that are out of standard ones ENHANCE - allow customize validation error message more flexible - make RenderTesterTest more easy to use - 1.1-b3 (2015.10.27) FIX - (BREAKING)reverse wrongly changed configuration item name of blockParallelListRendering - initializing unlock failed when exception occurs on snippet initializing due to wrong lock/unlock order. - SiteCategoryAwaredResourceLoader should respect the configuration of cacheEnable.(#9) - template cache should not be static(#10) ENHANCE - refactoring to make customizing template resolving more easily. - refactoring to allow extend existing message helper more easily - refactoring for better understandable method name of BasicFormFlowHandlerTrait to suggest the extendable points better - 1.1-b2 (2015.09.07) FIX - (BREAKING)source refactoring, unified all the parallel list converting related configuration items name - disable paralle stream rendering - add non-conflict suffix to the non-exposed attributes of snippet/embed/groupnode, etc.(#6) - limit parallel thread number per invoking to avoid huge lists drain all the usable threads in pool(#7) - 1.1-b1 (2015.07.23) This release is mainly for supporting Java 8 better with some functionality enhancemants. ADD - better Java 8 lamdba support FIX - NPE occurs when there are non form fields in a form POJO - some incompatibility with Java 8 ENHANCE - better form flow support - now the cascade layer of form is not limited - built-in multiple input step support - implement all the functionalities by interface rather than abstract class to afford more flexibilities to user project - built-in client util javascript as reference implementation - 1.0-Valentines (2015.02.14) The first official release version. ADD - convenience annotation for default scope(request scope) - match url by regex(the original implementation was OK and add tests to confirm) - allow customized url matcher FIX - exception should be thrown when type unmatched value is injected to a non annotated method parameter(it injects null or 0 currently) - 1.0-b4 (2014.12.26) ENHANCE - shutdown all threads by Asta4D at servlet's destroying - 1.0-b3 (2014.11.20) ADD - more debug friendly information for malformed html when rendering form - data value convertor for date/time string (joda-time as well) - form field renderer for html5 date/time input element - test methods for no operation on RenderTester FIX - bug in sample project - NullPointerException occurs when the default forward/redirect is missing - SiteCategoryAwaredTemplateResolver should cache found template file by different search categories - handle unknown http method better(rather than throw exception) ENHANCE - reduce memory usage of form flow trace storing mechanism - source refactoring to allow more flexible form process logic - allow pass logger to debug rendering - handle unknown http method better(rather than throw exception) - 1.0-b2 (2014.10.29) ADD - site category support FIX - many many many fix... ENHANCE - refactoring of i18n mechanism to afford easier extendibility - form flow mechanism become stable - well written sample for form flow - upgraded to the newest jsoup version 1.8.1 - 1.0-b1 (2014.10.06) ADD - form flow support FIX - many many many fix... - 0.14.606 ADD - support a callback rendering interface called Renderable - support static embeding which will embed the target file to the holding file when the holding file is initialized - allow customize json and rest result transformer FIX - template files are locked due to the input stream is not closed - 0.14.4.30 FIX - missing annotation convertor for web convenience annotations - 0.14.4.28 ADD - allow customize ResourceBundle loading and add encoding support for message file - more flexible usage of @ContextData - annotation conversion mechanism(name of @SessionData, @QueryParam can be speficied now) - The policy of how to handle type unmatch situation on context data conversion can be specified now: throw exception(default action), assign default value, record trace information in context. - customized element to array conversion can be supported in context data conversion - more flexible usage of @ContextDataSet - Allow search data by name in context at first for ContextDataSet annotated class data - allow singleton instance of ContextDataSet in single context life cycle - allow create ContextDataSet by specified factory class - afd:comment tag support - allow configuration initializer customizable - allow configure the parameter name of forwarded flash scope data on url - allow rendering Component directly by Render#add method FIX - potential concurrent hashmap access in ParallelRowConvertor - allow any asta4d's tag in head - make sample project runnable without spring - forwarded flash scope id on url should be encrypted to avoid guessing attack - timeout check is necessary even the target data map of flash data exists - make SpringWebPageView workable REMOVE - deprecated transform methods in ListConvertUtil - dependency from activemq (since we dont need it) - redundant source - 0.14.2.10 FIX - deprecated reverse injection(it is not necessary and should be removed in future) - NullPointerException on removed nested snippet declared by "afd:render" - 0.14.1.31 ADD - allow default msg content for msg rendering - allow extra attribution and var declaration on remaped rules - allow initialize asta4d in spring mvc as template solution only FIX - predefined clear nodes are not removed correctly - wrong spelled method name - refactor rendering test mechanism for better test support(with minor bug fix) - 0.12.30 ADD - more sample references to sample projects - add fixVersion.sh to make release simpler FIX - minor bugs on handling SpecialRenderer#Clear - bugs in archetype - format of asta4d-doc(make it prettier) - 0.12.13 ADD - RendererTest can be used for unit test of Renderer now - Treat null rendering value as removing target node - More debug-friendly log messages - Some tests FIX - BinaryDataUtil does not handle file path of "classpath:" correctly - Does not handle default request handler instance correctly - Refactor for context map for scopes, the Session scope will not create new session any more - 0.8.6 ADD - Some debug friendly message - Redirect now can specify code 301 or 302 - Allow initialize asta4d Configuration from external properties file FIX - Refactor request chain process, now we can perfectly handle request chain - A bug that post process of request interceptor will be executed multiple times - BinaryDataUtil does not handle file path correctly - Context does not be initialized before dispatch - 0.7.24 ADD - ico MIME type - A empty content provider which can be used to stop the request handler chain FIX - GenericPathHandler should get access url from Context - A bug when selector not found on rendering - 0.7.22 ADD - A request handler can be set as generic as request interceptor. - Access URL can be rewritten. - URL Rule can be rewritten. - A @ContextDataSet can be used for collecting context variables in a single class, eg. form parameters.(This is a base for form validation mechanism in furture) Remove - Depencies of Spring MVC is no longer necessary. Asta4dServlet can be used for handling http requests and StaticResourceHandler can be used for static resource files.

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.astamuse</groupId> <artifactId>asta4d</artifactId> <version>1.2.1-SNAPSHOT</version> </parent> <groupId>com.astamuse</groupId> <artifactId>asta4d-archetype</artifactId> <packaging>maven-archetype</packaging> <name>com.astamuse.asta4d-archetype</name> <description>an archetype that is automatically created from asta4d-sample.</description> <build> <extensions> <extension> <groupId>org.apache.maven.archetype</groupId> <artifactId>archetype-packaging</artifactId> <version>2.2</version> </extension> </extensions> <pluginManagement> <plugins> <plugin> <artifactId>maven-archetype-plugin</artifactId> <version>2.2</version> </plugin> </plugins> </pluginManagement> </build> <distributionManagement> <repository> <id>sonatype-nexus-staging</id> <name>Nexus Release Repository</name> <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url> </repository> <snapshotRepository> <id>sonatype-nexus-snapshots</id> <name>Sonatype Nexus Snapshots</name> <url>https://oss.sonatype.org/content/repositories/snapshots/</url> </snapshotRepository> </distributionManagement> </project>

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.astamuse</groupId> <artifactId>asta4d</artifactId> <version>1.2.1-SNAPSHOT</version> </parent> <groupId>com.astamuse</groupId> <artifactId>asta4d-spring</artifactId> <packaging>jar</packaging> <name>com.astamuse.asta4d-spring</name> <description>interaction with springframework</description> <repositories> <repository> <id>springsource-repo</id> <name>SpringSource Repository</name> <url>http://repo.springsource.org/release</url> </repository> </repositories> <dependencies> <dependency> <groupId>com.astamuse</groupId> <artifactId>asta4d-web</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>3.1.2.RELEASE</version> <scope>provided</scope> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <version>2.5</version> <scope>provided</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.6</version> <configuration> <instrumentation> <excludes> <exclude>**</exclude> </excludes> </instrumentation> </configuration> </plugin> </plugins> </build> </project>

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2012 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring; import org.springframework.context.ApplicationContext; import com.astamuse.asta4d.web.util.bean.DeclareInstanceAdapter; public class SpringManagedInstanceAdapter implements DeclareInstanceAdapter { private ApplicationContext beanCtx; private Class<?> beanCls = null; private String beanId = null; public SpringManagedInstanceAdapter(ApplicationContext beanCtx, Class<?> beanCls, String beanId) { this.beanCtx = beanCtx; this.beanCls = beanCls; this.beanId = beanId; } @Override public Object asTargetInstance() { if (beanCls != null) { return beanCtx.getBean(beanCls); } else if (beanId != null) { return beanCtx.getBean(beanId); } else { return null; } } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2012 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring; import org.springframework.beans.BeansException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import com.astamuse.asta4d.web.util.bean.DeclareInstanceResolver; public class SpringManagedInstanceResolver implements DeclareInstanceResolver, ApplicationContextAware { private ApplicationContext beanCtx; public SpringManagedInstanceResolver() { } public SpringManagedInstanceResolver(ApplicationContext beanCtx) { this.beanCtx = beanCtx; } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.beanCtx = applicationContext; } @Override public Object resolve(Object declaration) { if (declaration instanceof Class) { Class<?> beanCls = (Class<?>) declaration; String[] names = beanCtx.getBeanNamesForType(beanCls); boolean beanExist = false; for (String name : names) { if (beanCtx.containsBean(name)) { beanExist = true; break; } } if (beanExist) { return new SpringManagedInstanceAdapter(beanCtx, beanCls, null); } else { return null; } } else if (declaration instanceof String) { String beanId = declaration.toString(); if (beanCtx.containsBean(beanId)) { return new SpringManagedInstanceAdapter(beanCtx, null, beanId); } else { return null; } } return null; } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2012 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring; import org.springframework.beans.BeansException; import org.springframework.beans.factory.NoSuchBeanDefinitionException; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import com.astamuse.asta4d.snippet.resolve.DefaultSnippetResolver; public class SpringManagedSnippetResolver extends DefaultSnippetResolver implements ApplicationContextAware { private ApplicationContext applicationContext; @Override public void setApplicationContext(ApplicationContext context) throws BeansException { this.applicationContext = context; } @Override protected Object loadResource(String name) { try { return applicationContext.getBean(name); } catch (NoSuchBeanDefinitionException e) { return super.loadResource(name); } catch (Exception ex) { throw new RuntimeException(ex); } } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

package com.astamuse.asta4d.misc.spring; import java.util.Arrays; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.context.annotation.AnnotationBeanNameGenerator; public class Asta4dBeanNameGenerator extends AnnotationBeanNameGenerator { private String[] snippetSearchPathList; @Override protected String buildDefaultBeanName(BeanDefinition definition) { if (snippetSearchPathList == null) { return super.buildDefaultBeanName(definition); } String clsName = definition.getBeanClassName(); for (String s : snippetSearchPathList) { if (clsName.startsWith(s)) { return clsName.substring(s.length()); } } return super.buildDefaultBeanName(definition); } public void setSnippetSearchPathList(String... snippetSearchPathList) { this.snippetSearchPathList = Arrays.stream(snippetSearchPathList).map(s -> s + ".").toArray(len -> new String[len]); } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2014 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring; import org.springframework.context.ApplicationContext; import org.springframework.context.ConfigurableApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; import com.astamuse.asta4d.web.WebApplicationConfiguration; import com.astamuse.asta4d.web.servlet.Asta4dServlet; public class SpringInitializableServlet extends Asta4dServlet { /** * */ private static final long serialVersionUID = 1L; private ApplicationContext springContext = null; @Override protected WebApplicationConfiguration createConfiguration() { springContext = createSpringContext(retrieveSpringConfigLocation()); return springContext.getBean(WebApplicationConfiguration.class); } protected ApplicationContext createSpringContext(String location) { return new ClassPathXmlApplicationContext(location); } protected String retrieveSpringConfigLocation() { String configLocation = getServletConfig().getInitParameter("contextConfigLocation"); if (configLocation.startsWith("classpath:")) { configLocation = configLocation.substring("classpath:".length()); } if (!configLocation.startsWith("/")) { configLocation = "/" + configLocation; } return configLocation; } protected ApplicationContext getSpringContext() { return springContext; } @Override public void destroy() { ((ConfigurableApplicationContext) springContext).close(); springContext = null; super.destroy(); } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

package com.astamuse.asta4d.misc.spring.annotation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import org.springframework.context.annotation.Scope; import org.springframework.stereotype.Component; @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Component @Scope("prototype") public @interface Snippet { String value() default ""; }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2012 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring.mvc; import java.util.Locale; import org.springframework.web.servlet.View; import org.springframework.web.servlet.ViewResolver; import org.springframework.web.servlet.view.RedirectView; import com.astamuse.asta4d.Configuration; import com.astamuse.asta4d.template.Template; import com.astamuse.asta4d.template.TemplateNotFoundException; import com.astamuse.asta4d.template.TemplateResolver; public class SpringWebPageViewResolver implements ViewResolver { private boolean exceptionOnTemplateNotFound = true; private String prefix = ""; private String suffix = ""; @Override public View resolveViewName(String viewName, Locale locale) throws Exception { try { // TODO we should follow the spring mvc default implementation of UrlBasedViewResolver String redirectPrefix = "redirect:"; if (viewName.startsWith(redirectPrefix)) { String redirect = viewName.substring(redirectPrefix.length()); return new RedirectView(redirect); } String path = prefix + viewName + suffix; Configuration conf = Configuration.getConfiguration(); TemplateResolver templateResolver = conf.getTemplateResolver(); Template template = templateResolver.findTemplate(path); return new SpringWebPageView(template); } catch (TemplateNotFoundException e) { if (exceptionOnTemplateNotFound) { throw e; } else { return null; } } } public void setExceptionOnTemplateNotFound(boolean exceptionOnTemplateNotFound) { this.exceptionOnTemplateNotFound = exceptionOnTemplateNotFound; } public void setPrefix(String prefix) { this.prefix = prefix; } public void setSuffix(String suffix) { this.suffix = suffix; } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2012 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring.mvc; import java.util.Map; import java.util.Map.Entry; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.web.servlet.View; import com.astamuse.asta4d.Context; import com.astamuse.asta4d.Page; import com.astamuse.asta4d.template.Template; import com.astamuse.asta4d.template.TemplateException; import com.astamuse.asta4d.web.WebApplicationContext; import com.astamuse.asta4d.web.dispatch.mapping.UrlMappingRule; import com.astamuse.asta4d.web.dispatch.response.provider.Asta4DPageProvider; public class SpringWebPageView implements View { private static final UrlMappingRule DummyPageRule = new UrlMappingRule().asUnmodifiable(); private Template template; public SpringWebPageView(Template template) throws TemplateException { super(); this.template = template; } @Override public String getContentType() { return ""; } @Override public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception { WebApplicationContext context = Context.getCurrentThreadContext(); for (Entry<String, ?> entry : model.entrySet()) { context.setData(entry.getKey(), entry.getValue()); } // since the page will be rendered when the page instance is created, so we have to create the page here rather than at resolver new Asta4DPageProvider(new Page(template)).produce(DummyPageRule, response); } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain

/* * Copyright 2012 astamuse company,Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package com.astamuse.asta4d.misc.spring.mvc; import javax.servlet.ServletConfig; import javax.servlet.ServletContext; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.beans.BeansException; import org.springframework.beans.factory.InitializingBean; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.web.context.ServletConfigAware; import org.springframework.web.context.ServletContextAware; import org.springframework.web.servlet.handler.HandlerInterceptorAdapter; import com.astamuse.asta4d.Context; import com.astamuse.asta4d.web.WebApplicationConfiguration; import com.astamuse.asta4d.web.WebApplicationContext; import com.astamuse.asta4d.web.WebApplicatoinConfigurationInitializer; /** * * This class is used to initialize necessary Asta4D's configuration and context when Asta4D is used as only the template solution for * Spring MVC. * * This class should be declared as singeleton in spring container. * * @author e-ryu * */ public class Asta4dContextInitializeHandlerInterceptor extends HandlerInterceptorAdapter implements ServletContextAware, ApplicationContextAware, InitializingBean, ServletConfigAware { private ServletConfig servletConfig; private ServletContext servletContext; private ApplicationContext beanContext; @Override public void setServletContext(ServletContext servletContext) { this.servletContext = servletContext; } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.beanContext = applicationContext; } @Override public void setServletConfig(ServletConfig servletConfig) { this.servletConfig = servletConfig; } @Override public void afterPropertiesSet() throws Exception { WebApplicationConfiguration asta4dConf = beanContext.getBean(WebApplicationConfiguration.class); createConfigurationInitializer().initConfigurationFromFile(servletConfig, asta4dConf); WebApplicationConfiguration.setConfiguration(asta4dConf); } protected WebApplicatoinConfigurationInitializer createConfigurationInitializer() { return new WebApplicatoinConfigurationInitializer(); } @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { WebApplicationContext asta4dContext = WebApplicationContext.getCurrentThreadContext(); if (asta4dContext == null) { asta4dContext = new WebApplicationContext(); Context.setCurrentThreadContext(asta4dContext); } asta4dContext.init(); asta4dContext.setRequest(request); asta4dContext.setResponse(response); asta4dContext.setServletContext(servletContext); return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { Context asta4dContext = Context.getCurrentThreadContext(); if (asta4dContext != null) { asta4dContext.clear(); } super.afterCompletion(request, response, handler, ex); } }

astamuse/asta4d

162

Java

org.eclipse.core.resources.prefs

text/plain