diff --git a/.gitignore b/.gitignore index 67c09e1..dd3680b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,164 @@ *.un~ *.pyc + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/examples/image_file.py b/examples/image_file.py index 66488f6..024d592 100755 --- a/examples/image_file.py +++ b/examples/image_file.py @@ -7,7 +7,7 @@ import sys from pathlib import Path import argparse -from sixel import converter +from sixel import converter, is_term_sixel_capable def main(): @@ -25,4 +25,7 @@ def main(): if __name__ == "__main__": - main() + if is_term_sixel_capable(): + main() + else: + raise EnvironmentError("Your current terminal emulator does not support SIXEL!") diff --git a/sixel/__init__.py b/sixel/__init__.py index 9dd47b2..9dac302 100644 --- a/sixel/__init__.py +++ b/sixel/__init__.py @@ -8,6 +8,8 @@ import optparse import select import logging +import termios +import tty from io import StringIO from .cellsize import get_size @@ -22,6 +24,21 @@ def _filenize(f): return StringIO(f.read()) return f +def is_term_sixel_capable(): + """based on `printf "\\033[c"`; returns if the current terminal emulator is capable of SIXEL""" + # import sys, termios, tty + if os.getenv("TERM", '').strip().startswith("yaft"): + return True + + print("\033[c", end="", flush=True) + fd = sys.stdin.fileno() + orig = termios.tcgetattr(fd) + + try: + tty.setcbreak(fd) # or tty.setraw(fd) if you prefer raw mode's behavior. + return '4' in sys.stdin.read(10) + finally: + termios.tcsetattr(fd, termios.TCSAFLUSH, orig) def main(): parser = optparse.OptionParser()